Update keystore documentation to remove placeholder section (#6566)

* Update keystore documentation to remove placeholder section

Signed-off-by: Craig Perkins <cwperx@amazon.com>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

---------

Signed-off-by: Craig Perkins <cwperx@amazon.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
This commit is contained in:
Craig Perkins 2024-03-04 17:15:43 -05:00 committed by GitHub
parent 9156e32cfb
commit 174078f90e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 2 additions and 6 deletions

View File

@ -107,10 +107,6 @@ After this command, you will be prompted to enter the secret key securely.
No response exists for this command. To confirm that the setting was deleted, use `opensearch-keystore list`.
## Referring to keystore entries
## KeyStore entries as OpenSearch settings
After a setting has been added to a keystore, you can refer back to that setting in your OpenSearch configuration. To refer back to the setting, add the keystore setting name as a placeholder in the `opensearch.yml` configuration file, as shown in the following example:
```bash
plugins.security.ssl.http.pemkey_password_secure: ${plugins.security.ssl.http.pemkey_password_secure}
```
After a setting has been added to a keystore, it is implicitly added to the OpenSearch configuration as if it were another entry in `opensearch.yml`. To modify a keystore entry use `./bin/opensearch-keystore upgrade <setting>`. To remove an entry, use `./bin/opensearch-keystore remove <setting>`.