Browse Source

Adding warning session to docs

Signed-off-by: Gustavo Carvalho <gustavo.carvalho@container-solutions.com>
Docs 4 years ago
parent
commit
8d0e131ef9
2 changed files with 50 additions and 1 deletions
  1. 5 1
      docs/provider-hashicorp-vault.md
  2. 45 0
      docs/spec.md

+ 5 - 1
docs/provider-hashicorp-vault.md

@@ -165,6 +165,10 @@ You can extract multiple secrets from Hashicorp vault by using `dataFrom.Find`
 
 Currently, `dataFrom.Find` allows users to fetch secret names that match a given regexp pattern, or fetch secrets whose `custom_metadata` tags match a predefined set.
 
+
+!!! warning
+    The way hashicorp Vault currently allows LIST operations is through the existence of a secret metadata. If you delete the secret, you will also need to delete the secret's metadata or this will currently make Find operations fail.
+
 Given the following secret - assume its path is `/dev/config`:
 ```json
 {
@@ -204,7 +208,7 @@ spec:
 will generate a secret with: 
 ```json
 {
-  "dev_config":"{\"foo\": {\"nested\": {\"bar\": \"mysecret\",\"baz\": \"bang\"}}}"
+  "dev_config":"{\"foo\":{\"nested\":{\"bar\":\"mysecret\",\"baz\":\"bang\"}}}"
 }
 ```
 

+ 45 - 0
docs/spec.md

@@ -996,6 +996,27 @@ ExternalSecretStatus
 <td></td>
 </tr></tbody>
 </table>
+<h3 id="external-secrets.io/v1alpha1.ExternalSecretConversionStrategy">ExternalSecretConversionStrategy
+(<code>string</code> alias)</p></h3>
+<p>
+(<em>Appears on:</em>
+<a href="#external-secrets.io/v1alpha1.ExternalSecretDataRemoteRef">ExternalSecretDataRemoteRef</a>)
+</p>
+<p>
+</p>
+<table>
+<thead>
+<tr>
+<th>Value</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody><tr><td><p>&#34;Default&#34;</p></td>
+<td></td>
+</tr><tr><td><p>&#34;Unicode&#34;</p></td>
+<td></td>
+</tr></tbody>
+</table>
 <h3 id="external-secrets.io/v1alpha1.ExternalSecretCreationPolicy">ExternalSecretCreationPolicy
 (<code>string</code> alias)</p></h3>
 <p>
@@ -1117,6 +1138,20 @@ string
 <p>Used to select a specific property of the Provider value (if a map), if supported</p>
 </td>
 </tr>
+<tr>
+<td>
+<code>conversionStrategy</code></br>
+<em>
+<a href="#external-secrets.io/v1alpha1.ExternalSecretConversionStrategy">
+ExternalSecretConversionStrategy
+</a>
+</em>
+</td>
+<td>
+<em>(Optional)</em>
+<p>Used to define a conversion Strategy</p>
+</td>
+</tr>
 </tbody>
 </table>
 <h3 id="external-secrets.io/v1alpha1.ExternalSecretSpec">ExternalSecretSpec
@@ -1793,6 +1828,16 @@ string
 <td>
 </td>
 </tr>
+<tr>
+<td>
+<code>clusterProjectID</code></br>
+<em>
+string
+</em>
+</td>
+<td>
+</td>
+</tr>
 </tbody>
 </table>
 <h3 id="external-secrets.io/v1alpha1.GenericStore">GenericStore