[docs] Add kibana-encryption-keys (#84577)

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
This commit is contained in:
Jonathan Budzenski 2020-12-18 14:02:21 -06:00
parent 70157ec607
commit 49c5aeb1dd
2 changed files with 45 additions and 0 deletions

View file

@ -0,0 +1,44 @@
[[kibana-encryption-keys]]
=== Set up encryptions keys to protect sensitive information
The `kibana-encryption-keys` command helps you set up encryption keys that {kib} uses
to protect sensitive information.
[discrete]
=== Synopsis
[source,shell]
--------------------------------------------------
bin/kibana-encryption-keys generate
[-i, --interactive] [-q, --quiet]
[-f, --force] [-h, --help]
--------------------------------------------------
[discrete]
=== Description
{kib} uses encryption keys in several areas, ranging from encrypting data
in {kib} associated indices to storing session information. By defining these
encryption keys in your configuration, you'll ensure consistent operations
across restarts.
[discrete]
[[encryption-key-parameters]]
=== Parameters
`generate`:: Randomly generates passwords to the console.
`-i, --interactive`:: Prompts you for which encryption keys to set and optionally
where to save a sample configuration file.
`-q, --quiet`:: Outputs the encryption keys without helper information.
`-f, --force`:: Shows help information.
[discrete]
=== Examples
[source,shell]
--------------------------------------------------
bin/kibana-encryption-keys generate
--------------------------------------------------

View file

@ -45,5 +45,6 @@ cause Kibana's authorization to behave unexpectedly.
include::authorization/index.asciidoc[]
include::authorization/kibana-privileges.asciidoc[]
include::api-keys/index.asciidoc[]
include::encryption-keys/index.asciidoc[]
include::role-mappings/index.asciidoc[]
include::rbac_tutorial.asciidoc[]