Browse Source

chore(docs): AWSSM quick example changes

Lucas Severo Alves 4 years ago
parent
commit
33c4f36d5e

+ 2 - 16
docs/provider-aws-secrets-manager.md

@@ -52,23 +52,9 @@ Consider the following JSON object that is stored in the SecretsManager key `my-
 ```
 
 This is an example on how you would look up nested keys in the above json object:
-``` yaml
-apiVersion: external-secrets.io/v1alpha1
-kind: ExternalSecret
-metadata:
-  name: example
-spec:
-  # [omitted for brevity]
-  data:
-  - secretKey: firstname
-    remoteRef:
-      key: my-json-secret
-      property: name.first # Tom
-  - secretKey: first_friend
-    remoteRef:
-      key: my-json-secret
-      property: friends.1.first # Roger
 
+``` yaml
+{% include 'aws-sm-external-secret.yaml' %}
 ```
 
 --8<-- "snippets/provider-aws-access.md"

+ 21 - 0
docs/snippets/aws-sm-external-secret.yaml

@@ -0,0 +1,21 @@
+apiVersion: external-secrets.io/v1alpha1
+kind: ExternalSecret
+metadata:
+  name: example
+spec:
+  refreshInterval: 1m
+  secretStoreRef:
+    name: secretstore-sample
+    kind: SecretStore
+  target:
+    name: secret-to-be-created
+    creationPolicy: Owner
+  data:
+  - secretKey: firstname
+    remoteRef:
+      key: my-json-secret
+      property: name.first # Tom
+  - secretKey: first_friend
+    remoteRef:
+      key: my-json-secret
+      property: friends.1.first # Roger

+ 3 - 1
docs/snippets/aws-sm-store.yaml

@@ -8,7 +8,9 @@ spec:
     aws:
       service: SecretsManager
       # define a specific role to limit access
-      # to certain secrets
+      # to certain secrets.
+      # role is a optional field that 
+      # can be omitted for test purposes
       role: iam-role
       region: eu-central-1
       auth: