Browse Source

Merge pull request #736 from external-secrets/fix/docs-template-v2

Fixing documentation render for template v2
paul-the-alien[bot] 4 years ago
parent
commit
cc6f50c2d8
2 changed files with 33 additions and 34 deletions
  1. 0 3
      docs/guides-templating.md
  2. 33 31
      docs/spec.md

+ 0 - 3
docs/guides-templating.md

@@ -70,9 +70,6 @@ NtFUGA95RGN9s+pl6XY0YARPHf5O76ErC1OZtDTR5RdyQfcM+94gYZsexsXl0aQO
 ```
 
 You can achieve that by using the `filterPEM` function to extract a specific type of PEM block from that secret. If multiple blocks of that type (here: `CERTIFICATE`) exist then all of them are returned in the order they are specified.
-```yaml
-{% include 'pem-filter-template-v2-external-secret.yaml' %}
-```
 
 ## Helper functions
 

+ 33 - 31
docs/spec.md

@@ -1997,6 +1997,28 @@ string
 <tbody>
 <tr>
 <td>
+<code>tenancy</code></br>
+<em>
+string
+</em>
+</td>
+<td>
+<p>Tenancy is the tenancy OCID where user is located.</p>
+</td>
+</tr>
+<tr>
+<td>
+<code>user</code></br>
+<em>
+string
+</em>
+</td>
+<td>
+<p>User is an access OCID specific to the account.</p>
+</td>
+</tr>
+<tr>
+<td>
 <code>secretRef</code></br>
 <em>
 <a href="#external-secrets.io/v1alpha1.OracleSecretRef">
@@ -2030,59 +2052,39 @@ backend.</p>
 <tbody>
 <tr>
 <td>
-<code>auth</code></br>
-<em>
-<a href="#external-secrets.io/v1alpha1.OracleAuth">
-OracleAuth
-</a>
-</em>
-</td>
-<td>
-<p>Auth configures how secret-manager authenticates with the Oracle Vault.</p>
-</td>
-</tr>
-<tr>
-<td>
-<code>user</code></br>
-<em>
-string
-</em>
-</td>
-<td>
-<p>User is an access OCID specific to the account.</p>
-</td>
-</tr>
-<tr>
-<td>
-<code>tenancy</code></br>
+<code>region</code></br>
 <em>
 string
 </em>
 </td>
 <td>
-<p>Tenancy is the tenancy OCID where secret is located.</p>
+<p>Region is the region where vault is located.</p>
 </td>
 </tr>
 <tr>
 <td>
-<code>region</code></br>
+<code>vault</code></br>
 <em>
 string
 </em>
 </td>
 <td>
-<p>Region is the region where secret is located.</p>
+<p>Vault is the vault&rsquo;s OCID of the specific vault where secret is located.</p>
 </td>
 </tr>
 <tr>
 <td>
-<code>vault</code></br>
+<code>auth</code></br>
 <em>
-string
+<a href="#external-secrets.io/v1alpha1.OracleAuth">
+OracleAuth
+</a>
 </em>
 </td>
 <td>
-<p>Vault is the vault&rsquo;s OCID of the specific vault where secret is located.</p>
+<em>(Optional)</em>
+<p>Auth configures how secret-manager authenticates with the Oracle Vault.
+If empty, use the instance principal, otherwise the user credentials specified in Auth.</p>
 </td>
 </tr>
 </tbody>