mirror of
https://github.com/elastic/kibana.git
synced 2025-04-25 02:09:32 -04:00
6ebfb8aa3e
## Summary Relates to: #113217 - Add extra documentation to highlight behaviour of the kibana keystore (for #113217) - Fix/Tidy-up commands (`create`, `list`) where the extra unused arguments were preventing the `options` from being passed to the functions. Also remove unnecessary `async` keyword from the `remove` command. - Added new `show` command ``` Usage: bin/kibana-keystore show [options] <key> Displays the value of a single setting in the keystore. Pass the -o (or --output) parameter to write the setting to a file. Options: -s, --silent prevent all logging -o, --output <file> output value to a file -h, --help output usage information ``` ### Checklist Delete any items that are not applicable to this PR. - [x] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios ### For maintainers - [x] This was checked for breaking API changes and was [labeled appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process) --------- Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co>
94 lines
3.1 KiB
Text
94 lines
3.1 KiB
Text
[[secure-settings]]
|
|
=== Secure settings
|
|
|
|
Some settings are sensitive, and relying on filesystem permissions to protect
|
|
their values is not sufficient. For this use case, Kibana provides a
|
|
keystore, and the `kibana-keystore` tool to manage the settings in the keystore.
|
|
|
|
[NOTE]
|
|
====
|
|
* Run all commands as the user who runs {kib}.
|
|
* Only the settings with the `(Secure)` qualifier should be stored in the keystore.
|
|
Unsupported, extraneous or invalid JSON-string settings cause {kib} to fail to start up.
|
|
====
|
|
|
|
[float]
|
|
[[creating-keystore]]
|
|
=== Create the keystore
|
|
|
|
To create the `kibana.keystore`, use the `create` command:
|
|
|
|
[source,sh]
|
|
----------------------------------------------------------------
|
|
bin/kibana-keystore create
|
|
----------------------------------------------------------------
|
|
|
|
The file `kibana.keystore` will be created in the `config` directory defined by the
|
|
environment variable `KBN_PATH_CONF`.
|
|
|
|
[float]
|
|
[[list-settings]]
|
|
=== List settings in the keystore
|
|
|
|
A list of the settings in the keystore is available with the `list` command:
|
|
|
|
[source,sh]
|
|
----------------------------------------------------------------
|
|
bin/kibana-keystore list
|
|
----------------------------------------------------------------
|
|
|
|
[float]
|
|
[[add-string-to-keystore]]
|
|
=== Add string settings
|
|
|
|
NOTE: Your input will be JSON-parsed to allow for object/array input configurations.
|
|
To enforce string values, use "double quotes" around your input.
|
|
|
|
Sensitive string settings, like authentication credentials for Elasticsearch
|
|
can be added using the `add` command:
|
|
|
|
[source,sh]
|
|
----------------------------------------------------------------
|
|
bin/kibana-keystore add the.setting.name.to.set
|
|
----------------------------------------------------------------
|
|
|
|
Once added to the keystore, these setting will be automatically applied
|
|
to this instance of Kibana when started. For example if you do
|
|
|
|
[source,sh]
|
|
----------------------------------------------------------------
|
|
bin/kibana-keystore add elasticsearch.username
|
|
----------------------------------------------------------------
|
|
|
|
you will be prompted to provide the value for elasticsearch.username.
|
|
(Your input will show as asterisks.)
|
|
|
|
The tool will prompt for the value of the setting. To pass the value
|
|
through stdin, use the `--stdin` flag:
|
|
|
|
[source,sh]
|
|
----------------------------------------------------------------
|
|
cat /file/containing/setting/value | bin/kibana-keystore add the.setting.name.to.set --stdin
|
|
----------------------------------------------------------------
|
|
|
|
[float]
|
|
[[remove-settings]]
|
|
=== Remove settings
|
|
|
|
To remove a setting from the keystore, use the `remove` command:
|
|
|
|
[source,sh]
|
|
----------------------------------------------------------------
|
|
bin/kibana-keystore remove the.setting.name.to.remove
|
|
----------------------------------------------------------------
|
|
|
|
[float]
|
|
[[read-settings]]
|
|
=== Read settings
|
|
|
|
To display the configured setting values, use the `show` command:
|
|
|
|
[source, sh]
|
|
----------------------------------------------------------------
|
|
bin/kibana-keystore show setting.key
|
|
----------------------------------------------------------------
|