update documentation

Signed-off-by: Matthew DeVenny <matt@boxboat.com>
boxboat · May 14, 2024 · 89abd91 · 89abd91
1 parent e88c576
commit 89abd91
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -102,6 +102,7 @@ secretSpec:
   annotations:
     alpha: charlie
 data:
+  # aws secrets can also be accessed by arn
   aws-alpha: << (aws "dockcmd-test" "alpha") >>
   aws-bravo: << (aws "dockcmd-test" "bravo") >>
   aws-charile: << (aws "dockcmd-test" "charlie") >>

diff --git a/docs/content/usage/core-concepts.md b/docs/content/usage/core-concepts.md
@@ -83,6 +83,8 @@ The `syncInterval` field instructs the operator to poll for changes to that part
 ### AWS Secrets Manager
 Dockhand `Secret` supports retrieval of an AWS Secrets Manager `json` secret using `<< (aws <secret-name> <json-key>) >>`. The `<secret-name>` supports optional `?version=<version-id>` query string.
 
+Note `<secret-name>` can also be the ARN of the secret.
+
 Suppose you have an AWS Secrets Manager Secret named `dockhand-test`, which has `json` data `{ "alpha": "s3cr3t", "bravo": "another-s3cr3t" }`. The following Dockhand `Secret` would generate create an `Opaque` `Secret` in the `aws` namespace.
 ```yaml
 ---