From 24fc1dad969a5b02fb96748bbb1832c5479a8f37 Mon Sep 17 00:00:00 2001 From: James Rodewig Date: Thu, 11 Apr 2019 08:48:42 -0400 Subject: [PATCH] [DOCS] Improve docs for 'elasticsearch-keystore add-file' command (#41084) --- docs/plugins/repository-gcs.asciidoc | 2 +- docs/reference/setup/secure-settings.asciidoc | 12 ++++++++++++ 2 files changed, 13 insertions(+), 1 deletion(-) diff --git a/docs/plugins/repository-gcs.asciidoc b/docs/plugins/repository-gcs.asciidoc index 9b215b5cdf612..52a4cc9d5f3cf 100644 --- a/docs/plugins/repository-gcs.asciidoc +++ b/docs/plugins/repository-gcs.asciidoc @@ -152,7 +152,7 @@ Some settings are sensitive and must be stored in the [source,sh] ---- -bin/elasticsearch-keystore add-file gcs.client.default.credentials_file +bin/elasticsearch-keystore add-file gcs.client.default.credentials_file /path/service-account.json ---- The following are the available client settings. Those that must be stored in the keystore diff --git a/docs/reference/setup/secure-settings.asciidoc b/docs/reference/setup/secure-settings.asciidoc index 6abf5dea14d0e..4e3799db75bde 100644 --- a/docs/reference/setup/secure-settings.asciidoc +++ b/docs/reference/setup/secure-settings.asciidoc @@ -64,6 +64,18 @@ through stdin, use the `--stdin` flag: cat /file/containing/setting/value | bin/elasticsearch-keystore add --stdin the.setting.name.to.set ---------------------------------------------------------------- +[float] +[[add-file-to-keystore]] +=== Adding file settings +You can add sensitive files, like authentication key files for cloud plugins, +using the `add-file` command. Be sure to include your file path as an argument +after the setting name. + +[source,sh] +---------------------------------------------------------------- +bin/elasticsearch-keystore add-file the.setting.name.to.set /path/example-file.json +---------------------------------------------------------------- + [float] [[remove-settings]] === Removing settings