Browse Source

update docs

renanaAkeyless 4 years ago
parent
commit
34ea6f21be

+ 6 - 4
docs/provider-akeyelss.md

@@ -5,7 +5,8 @@ External Secrets Operator integrates with [Akeyless API](https://docs.akeyless.i
 ### Authentication
 
 The API requires an access-id, access-type and access-Type-param.
-the supported auth-methods are their params:
+
+The supported auth-methods and their params are:
 
 | accessType  | accessTypeParam                                                                                                                                                                                                                      |
 | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
@@ -13,7 +14,7 @@ the supported auth-methods are their params:
 | `k8s`         | The k8s configuration name |
 | `aws_iam` |   -                                                         |
 | `gcp` |      The gcp audience                                                      |
-| `azure_ad` |  azure object id                                                           |
+| `azure_ad` |  azure object id  (optional)                                                          |
 
 form more information about [Akeyless Authentication Methods](https://docs.akeyless.io/docs/access-and-authentication-methods)
 
@@ -50,17 +51,18 @@ To get a secret from Akeyless and secret it on the Kubernetes cluster, a `Kind=E
 
 #### Using DataFrom
 
-DataFrom can be used to get a variable as a JSON string and attempt to parse it.
+DataFrom can be used to get a secret as a JSON string and attempt to parse it.
 
 ```yaml
 {% include 'akeyless-external-secret-json.yaml' %}
 ```
 
 ### Getting the Kubernetes secret
-The operator will fetch the project variable and inject it as a `Kind=Secret`.
+The operator will fetch the secret and inject it as a `Kind=Secret`.
 ```
 kubectl get secret akeyless-secret-to-create -o jsonpath='{.data.secretKey}' | base64 -d
 ```
+
 ```
 kubectl get secret akeyless-secret-to-create-json -o jsonpath='{.data}'
 ```

+ 2 - 2
docs/snippets/akeyless-external-secret-json.yaml

@@ -13,6 +13,6 @@ spec:
     name: akeyless-secret-to-create-json # Name for the secret to be created on the cluster
     creationPolicy: Owner
 
-  # each secret name in the KV will be used as the secret key in the SECRET k8s target object
+  # for json formatted secrets: each key in the json will be used as the secret key in the SECRET k8s target object
   dataFrom:
-  - key: "my-app" # Key of the variable on Akeyless
+  - key: secret-name # Full path of the secret on Akeyless

+ 1 - 1
docs/snippets/akeyless-external-secret.yaml

@@ -16,4 +16,4 @@ spec:
   data:
     - secretKey: secretKey # Key given to the secret to be created on the cluster
       remoteRef:
-        key: my-app # Key of the variable on Akeyless
+        key: secret-name # Full path of the secret on Akeyless

+ 1 - 0
hack/api-docs/mkdocs.yml

@@ -45,6 +45,7 @@ nav:
       - Secrets Manager: provider-google-secrets-manager.md
     - IBM:
       - Secrets Manager: provider-ibm-secrets-manager.md
+    - Akeyless: provider-akeyless.md
     - HashiCorp Vault: provider-hashicorp-vault.md
     - Yandex:
         - Lockbox: provider-yandex-lockbox.md