mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-04-25 07:37:19 -04:00
3c23a9e9cd
Changes: * Removes several `[testenv="gold+"]` attributes from the docs. `gold+` is not a valid [subscription level](https://www.elastic.co/subscriptions) or testenv value. * Moves two `[testenv="basic"]` attributes to the file header. This makes the `testenv` placement consistent and fixes the yml file generated from `docs/reference/snapshot-restore/register-repository.asciidoc`. Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>
52 lines
1.4 KiB
Text
52 lines
1.4 KiB
Text
[[syskeygen]]
|
|
== elasticsearch-syskeygen
|
|
|
|
The `elasticsearch-syskeygen` command creates a system key file in the
|
|
elasticsearch config directory.
|
|
|
|
[discrete]
|
|
=== Synopsis
|
|
|
|
[source,shell]
|
|
--------------------------------------------------
|
|
bin/elasticsearch-syskeygen
|
|
[-E <KeyValuePair>] [-h, --help]
|
|
([-s, --silent] | [-v, --verbose])
|
|
--------------------------------------------------
|
|
|
|
[discrete]
|
|
=== Description
|
|
|
|
The command generates a `system_key` file, which you can use to symmetrically
|
|
encrypt sensitive data. For example, you can use this key to prevent {watcher}
|
|
from returning and storing information that contains clear text credentials. See
|
|
<<encrypting-data>>.
|
|
|
|
IMPORTANT: The system key is a symmetric key, so the same key must be used on
|
|
every node in the cluster.
|
|
|
|
[discrete]
|
|
[[syskeygen-parameters]]
|
|
=== Parameters
|
|
|
|
`-E <KeyValuePair>`:: Configures a setting. For example, if you have a custom
|
|
installation of {es}, you can use this parameter to specify the `ES_PATH_CONF`
|
|
environment variable.
|
|
|
|
`-h, --help`:: Returns all of the command parameters.
|
|
|
|
`-s, --silent`:: Shows minimal output.
|
|
|
|
`-v, --verbose`:: Shows verbose output.
|
|
|
|
|
|
[discrete]
|
|
=== Examples
|
|
|
|
The following command generates a `system_key` file in the
|
|
default `$ES_HOME/config` directory:
|
|
|
|
[source, sh]
|
|
--------------------------------------------------
|
|
bin/elasticsearch-syskeygen
|
|
--------------------------------------------------
|