clarify that init recovery options are only available for auto unseal (#17862)

* clarify that init recovery options are only available for auto unseal

* add some language consistency

Co-authored-by: Anton Averchenkov <84287187+averche@users.noreply.github.com>

Co-authored-by: Anton Averchenkov <84287187+averche@users.noreply.github.com>
This commit is contained in:
Chris Capurso
2022-11-10 15:43:11 -05:00
committed by GitHub
parent 840abfbe10
commit 3a7ce59d01
2 changed files with 9 additions and 9 deletions

View File

@@ -109,13 +109,13 @@ flags](/docs/commands) included on all commands.
### HSM and KMS Options
- `-recovery-pgp-keys` `(string: "...")` - Behaves like `-pgp-keys`, but for the
recovery key shares. This is only used with Auto Unseal seals (HSM, KMS and Transit seals).
recovery key shares. This is only available with [Auto Unseal](/docs/concepts/seal#auto-unseal) seals (HSM, KMS and Transit seals).
- `-recovery-shares` `(int: 5)` - Number of key shares to split the recovery key
into. This is only used with Auto Unseal seals (HSM, KMS and Transit seals).
into. This is only available with [Auto Unseal](/docs/concepts/seal#auto-unseal) seals (HSM, KMS and Transit seals).
- `-recovery-threshold` `(int: 3)` - Number of key shares required to
reconstruct the recovery key. This is only used with Auto Unseal seals (HSM, KMS and Transit seals).
reconstruct the recovery key. This is only available with [Auto Unseal](/docs/concepts/seal#auto-unseal) seals (HSM, KMS and Transit seals).
- `-stored-shares` `(int: 0)` - Number of unseal keys to store on an HSM. This
must be equal to `-key-shares`.