Skip to content

Commit

Permalink
Update Vercel granularity note
Browse files Browse the repository at this point in the history
  • Loading branch information
robmonte committed Oct 3, 2024
1 parent a204bf8 commit 36a336a
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 0 deletions.
3 changes: 3 additions & 0 deletions website/content/docs/sync/github.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -226,9 +226,12 @@ depending on whether you have configured
- `secret-key` granularity splits KVv2 secrets from Vault into key-value pairs
and stores the pairs as distinct entries in GitHub secrets. For example,
`secrets.key1="val1"` and `secrets.key2="val2"`.

- `secret-path` granularity stores secrets as a single JSON string that contains
all of the associated key-value pairs. For example, `{"key1":"val1", "key2":"val2"}`.

For GitHub, the granularity defaults to `secret-key`.

</Note>

If using the secret-path granularity, it is strongly advised to mask individual values for each sub-key to prevent the
Expand Down
16 changes: 16 additions & 0 deletions website/content/docs/sync/vercelproject.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,22 @@ In the example above, the value for secret "my-secret" will be synced to Vercel

</Note>

<Note>

Vercel Project environment variables only support single-value secrets, and Vault syncs secrets differently
depending on whether you have configured `secret-key` or `secret-path` [granularity](/vault/docs/sync#granularity):

- `secret-key` granularity splits KVv2 secrets from Vault into key-value pairs
and stores the pairs as distinct entries in Vercel. For example,
`secrets.key1="val1"` and `secrets.key2="val2"`.

- `secret-path` granularity stores secrets as a single JSON string that contains
all of the associated key-value pairs. For example, `{"key1":"val1", "key2":"val2"}`.

For Vercel Project, the granularity defaults to `secret-key`.

</Note>

## API

Please see the [secrets sync API](/vault/api-docs/system/secrets-sync) for more details.

0 comments on commit 36a336a

Please sign in to comment.