elasticsearch-keystore command manages secure settings
in the Elasticsearch keystore.
bin/elasticsearch-keystore ([add <setting>] [--stdin] | [add-file <setting> <path>] | [create] | [list] | [remove <setting>] | [upgrade]) [-h, --help] ([-s, --silent] | [-v, --verbose])
This command should be run as the user that will run Elasticsearch.
Currently, all secure settings are node-specific settings that must have the same value on every node. Therefore you must run this command on every node.
Modifications to the keystore do not take effect until you restart Elasticsearch.
Only some settings are designed to be read from the keystore. However, there is no validation to block unsupported settings from the keystore and they can cause Elasticsearch to fail to start. To see whether a setting is supported in the keystore, see the setting reference.
- Adds settings to the keystore. By default, you are prompted for the value of the setting.
add-file <setting> <path>
- Adds a file to the keystore.
- Creates the keystore.
- Returns all of the command parameters.
- Lists the settings in the keystore.
- Removes a setting from the keystore.
- Shows minimal output.
When used with the
addparameter, you can pass the setting value through standard input (stdin). See Add settings to the keystore.
- Upgrades the internal format of the keystore.
- Shows verbose output.
To create the
elasticsearch.keystore, use the
elasticsearch.keystore file is created alongside the
To list the settings in the keystore, use the
Sensitive string settings, like authentication credentials for Cloud plugins,
can be added with the
bin/elasticsearch-keystore add the.setting.name.to.set
You are prompted to enter the value of the setting. To pass the value
through standard input (stdin), use the
cat /file/containing/setting/value | bin/elasticsearch-keystore add --stdin the.setting.name.to.set
You can add sensitive files, like authentication key files for Cloud plugins,
add-file command. Be sure to include your file path as an argument
after the setting name.
bin/elasticsearch-keystore add-file the.setting.name.to.set /path/example-file.json
To remove a setting from the keystore, use the
bin/elasticsearch-keystore remove the.setting.name.to.remove
Occasionally, the internal format of the keystore changes. When Elasticsearch is
installed from a package manager, an upgrade of the on-disk keystore to the new
format is done during package upgrade. In other cases, Elasticsearch performs the upgrade
during node startup. This requires that Elasticsearch has write permissions to the
directory that contains the keystore. Alternatively, you can manually perform
such an upgrade by using the