From 824a290039751f41068dfff3ed9c7a3b63623005 Mon Sep 17 00:00:00 2001 From: robmonte <17119716+robmonte@users.noreply.github.com> Date: Wed, 10 Jul 2024 15:28:48 -0500 Subject: [PATCH 1/3] Add custom tags section to sync overview, specifically call out normalizing names and tags --- website/content/docs/sync/index.mdx | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/website/content/docs/sync/index.mdx b/website/content/docs/sync/index.mdx index 38fb411c422e..9eea67ab7ba6 100644 --- a/website/content/docs/sync/index.mdx +++ b/website/content/docs/sync/index.mdx @@ -88,8 +88,8 @@ association object returned by the endpoint and, upon failure, includes an error ## Name template By default, the name of synced secrets follows this format: `vault//`. The casing and delimiters -may change according to the valid character set of each destination type. This pattern was chosen to prevent accidental -name collisions and to clearly identify where the secret is coming from. +may change as they are normalized according to the valid character set of each destination type. This pattern was chosen to +prevent accidental name collisions and to clearly identify where the secret is coming from. Every destination allows you to customize this name pattern by configuring a `secret_name_template` field to best suit individual use cases. The templates use a subset of the go-template syntax for extra flexibility. @@ -142,6 +142,12 @@ Name templates can be updated. The new template is only effective for new secret not affect the secrets synced with the previous template. It is possible to update an association to force a recreate operation. The secret synced with the old template will be deleted and a new secret using the new template version will be synced. +## Custom tags + +Destinations can also have custom tags so that every secret association to it that gets synced will share that same set of tags. +Additionally, a default tag value of `hashicorp:vault` is used to denote any secret that is synced via Vault Enterprise. Similar +to secret names, tag keys and values are normalized according to the valid character set of each destination type. + ## Granularity Vault KV-v2 secrets are multi-value and their data is represented in JSON. Multi-value secrets are useful to bundle closely From 29e53ada555775d69c42df495d47ee7adbeed710 Mon Sep 17 00:00:00 2001 From: Robert <17119716+robmonte@users.noreply.github.com> Date: Thu, 11 Jul 2024 14:26:42 -0500 Subject: [PATCH 2/3] Update website/content/docs/sync/index.mdx Co-authored-by: Theron Voran --- website/content/docs/sync/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/content/docs/sync/index.mdx b/website/content/docs/sync/index.mdx index 9eea67ab7ba6..a16d5ebea3d3 100644 --- a/website/content/docs/sync/index.mdx +++ b/website/content/docs/sync/index.mdx @@ -144,7 +144,7 @@ The secret synced with the old template will be deleted and a new secret using t ## Custom tags -Destinations can also have custom tags so that every secret association to it that gets synced will share that same set of tags. +A destination can also have custom tags so that every secret association to it that is synced will share that same set of tags. Additionally, a default tag value of `hashicorp:vault` is used to denote any secret that is synced via Vault Enterprise. Similar to secret names, tag keys and values are normalized according to the valid character set of each destination type. From 79acaf2ac72d759aba38364170a873d32c6901be Mon Sep 17 00:00:00 2001 From: robmonte <17119716+robmonte@users.noreply.github.com> Date: Thu, 11 Jul 2024 14:28:04 -0500 Subject: [PATCH 3/3] Fix typo --- website/content/docs/sync/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/content/docs/sync/index.mdx b/website/content/docs/sync/index.mdx index a16d5ebea3d3..dd53d8631528 100644 --- a/website/content/docs/sync/index.mdx +++ b/website/content/docs/sync/index.mdx @@ -144,7 +144,7 @@ The secret synced with the old template will be deleted and a new secret using t ## Custom tags -A destination can also have custom tags so that every secret association to it that is synced will share that same set of tags. +A destination can also have custom tags so that every secret associated to it that is synced will share that same set of tags. Additionally, a default tag value of `hashicorp:vault` is used to denote any secret that is synced via Vault Enterprise. Similar to secret names, tag keys and values are normalized according to the valid character set of each destination type.