Skip to content

Commit

Permalink
Add activation section to the sync overview page (hashicorp#26627)
Browse files Browse the repository at this point in the history
* Add activation section to sync overview

* Better formatting

* Match hcp-docs format
  • Loading branch information
robmonte authored Apr 25, 2024
1 parent b86081c commit 2064778
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions website/content/docs/sync/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,31 @@ process. If the secret value is updated in Vault, the secret is updated in the d
from Vault, it is deleted on the external system as well. This process is asynchronous and event-based. Vault propagates
modifications into the proper destinations automatically in a handful of seconds.

## Activating the feature

The secrets sync feature requires manual activation through a one-time trigger. If a sync-related endpoint is called prior to
activation, an error response will be received indicating that the feature has not been activated yet. Be sure to understand the
potential [client count impacts](#client-counts) of using secrets sync before proceeding.

Activating the feature can be done through one of several methods:

1. Activation directly through the UI.

1. Acitvation through the CLI:

```shell-session
vault write -f sys/activation-flags/secrets-sync/activate
```

1. Activation through a POST or PUT request:

```shell-session
$ curl \
--request PUT \
--header "X-Vault-Token: ..." \
http://127.0.0.1:8200/v1/sys/activation-flags/secrets-sync/activate
```

## Destinations

Secrets can be synced into various external systems, called destinations. The supported destinations are:
Expand Down

0 comments on commit 2064778

Please sign in to comment.