Эх сурвалжийг харах

docs: added prepare secret section

Signed-off-by: Bill Hamilton <bill.hamilton@delinea.com>
Bill Hamilton 2 жил өмнө
parent
commit
b25bb327c1

+ 2 - 2
apis/externalsecrets/v1beta1/secretsstore_secretserver_types.go

@@ -30,11 +30,11 @@ type SecretServerProviderRef struct {
 // See https://github.com/DelineaXPM/tss-sdk-go/blob/main/server/server.go.
 type SecretServerProvider struct {
 
-	// UserName is the secret server account userName.
+	// Username is the secret server account username.
 	// +required
 	Username *SecretServerProviderRef `json:"username"`
 
-	// PassWord is the secret server account passWord.
+	// Password is the secret server account password.
 	// +required
 	Password *SecretServerProviderRef `json:"password"`
 

+ 2 - 2
config/crds/bases/external-secrets.io_secretstores.yaml

@@ -3435,7 +3435,7 @@ spec:
                       https://docs.delinea.com/online-help/secret-server/start.htm
                     properties:
                       password:
-                        description: PassWord is the secret server account passWord.
+                        description: Password is the secret server account password.
                         properties:
                           secretRef:
                             description: SecretRef references a key in a secret that
@@ -3467,7 +3467,7 @@ spec:
                           URL to your secret server installation
                         type: string
                       username:
-                        description: UserName is the secret server account userName.
+                        description: Username is the secret server account username.
                         properties:
                           secretRef:
                             description: SecretRef references a key in a secret that

+ 2 - 2
docs/api/spec.md

@@ -5368,7 +5368,7 @@ SecretServerProviderRef
 </em>
 </td>
 <td>
-<p>UserName is the secret server account userName.</p>
+<p>Username is the secret server account username.</p>
 </td>
 </tr>
 <tr>
@@ -5381,7 +5381,7 @@ SecretServerProviderRef
 </em>
 </td>
 <td>
-<p>PassWord is the secret server account passWord.</p>
+<p>Password is the secret server account password.</p>
 </td>
 </tr>
 <tr>

+ 10 - 3
docs/provider/secretserver.md

@@ -43,7 +43,8 @@ If multiple secrets are found, *`only the first found secret will be returned`*.
 
 Please note: `Retrieving a specific version of a secret is not yet supported.`
 
-Note that because all Secret Server secrets are JSON objects, you must specify `remoteRef.property`.
+Note that because all Secret Server secrets are JSON objects, you must specify the `remoteRef.property`
+in your ExternalSecret configuration.<br />
 You can access nested values or arrays using [gjson syntax](https://github.com/tidwall/gjson/blob/master/SYNTAX.md).
 
 ```yaml
@@ -60,8 +61,14 @@ spec:
       - secretKey: SecretServerValue #<SECRET_VALUE_RETURNED_HERE>
         remoteRef:
           key: "52622" #<SECRET_ID>
-          property: "Items.0.ItemValue" #<GJSON_PROPERTY> * an empty property will return the entire secret
+          property: "array.0.value" #<GJSON_PROPERTY> * an empty property will return the entire secret
 ```
+
+### Preparing your secret
+You can either retrieve your entire secret or you can use a JSON formatted string
+stored in your secret located at Items[0].ItemValue to retrieve a specific value.<br />
+See example JSON secret below.
+
 ### Examples
 Using the json formatted secret below:
 
@@ -116,7 +123,7 @@ returns: The entire secret in JSON format as displayed below
       "Slug": "data",
       "FieldDescription": "json text field",
       "Filename": "",
-      "ItemValue": "{ \"user\": \"marktwain@hannibal.com\", \"occupation\": \"author\",\"books\":[ \"tomSawyer\",\"huckleberryFinn\"] }",
+      "ItemValue": "{ \"user\": \"marktwain@hannibal.com\", \"occupation\": \"author\",\"books\":[ \"tomSawyer\",\"huckleberryFinn\",\"Pudd'nhead Wilson\"] }",
       "IsFile": false,
       "IsNotes": false,
       "IsPassword": false