Skip to content

Commit 0311fff

Browse files
authoredAug 8, 2024··
docs: update (#218)
Signed-off-by: Bence Csati <bcsati@cisco.com>
1 parent 61998f4 commit 0311fff

File tree

3 files changed

+7
-7
lines changed

3 files changed

+7
-7
lines changed
 

‎docs/API.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -298,7 +298,7 @@ It requires three things:
298298

299299
- Path to _source store_ config file via `--source` flag
300300
- Path to _target store_ config file via `--target` flag
301-
- Path to _sync plan_ config file via `--plan` flag
301+
- Path to _sync plan_ config file via `--syncjob` flag
302302

303303
Note that only YAML configuration files are supported.
304304
You can also provide optional params for CRON schedule to periodically sync secrets via `--schedule` flag.

‎examples/single-source-advanced/README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -135,10 +135,10 @@ Secret synchronization is performed using the CLI by executing the sync plan bet
135135
To synchronize database secrets from our local to Vault secret store, run:
136136

137137
```bash
138-
secret-sync \
138+
secret-sync sync \
139139
--source "/tmp/example/local-store.yml" \
140140
--target "/tmp/example/vault-store.yml" \
141-
--sync "/tmp/example/db-secrets-sync.yml"
141+
--syncjob "/tmp/example/db-secrets-sync.yml"
142142
```
143143

144144
If successful, your output should contain something like:
@@ -163,10 +163,10 @@ docker exec -it secret-sync-vault-1 vault kv get -mount="secret" "db-host"
163163
To synchronize application access secret from Vault to our local secret store, run:
164164

165165
```bash
166-
secret-sync \
166+
secret-sync sync \
167167
--target "/tmp/example/local-store.yml" \
168168
--source "/tmp/example/vault-store.yml" \
169-
--sync "/tmp/example/app-access-config-sync.yml"
169+
--syncjob "/tmp/example/app-access-config-sync.yml"
170170
```
171171

172172
If successful, besides logs:

‎examples/vault-to-vault-sync/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -108,10 +108,10 @@ Secret synchronization is performed using the CLI by executing the sync plan bet
108108
To synchronize the database secrets from the first Vault to the second one, run:
109109

110110
```bash
111-
secret-sync \
111+
secret-sync sync \
112112
--source "/tmp/example/vault-store.yml" \
113113
--target "/tmp/example/vault-store-2.yml" \
114-
--sync "/tmp/example/db-secrets-sync-from-vault-to-vault.yml"
114+
--syncjob "/tmp/example/db-secrets-sync-from-vault-to-vault.yml"
115115
```
116116

117117
If successful, your output should contain something like:

0 commit comments

Comments
 (0)
Please sign in to comment.