[DOCS] Add kibana-verification-tool and CLI main page (#120836) (#120970)

* [DOCS] Add kibana-verification-tool and CLI main page

* Change wording from generating to retrieving

Co-authored-by: Adam Locke <adam.locke@elastic.co>
This commit is contained in:
Kibana Machine 2021-12-09 12:12:47 -05:00 committed by GitHub
parent 1ec14ab03e
commit 8da7e923bd
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 54 additions and 0 deletions

View file

@ -0,0 +1,8 @@
[[cli-commands]]
== Command line tools
{kib} provides the following tools for configuring security and performing other tasks from the command line:
* <<kibana-verification-code,`kibana-verification-code`>>
include::kibana-verification-code.asciidoc[]

View file

@ -0,0 +1,44 @@
[[kibana-verification-code]]
=== kibana-verification-code
The `kibana-verification-code` tool retrieves a verification code for enrolling
a {kib} instance with a secured {es} cluster.
[discrete]
==== Synopsis
[source,shell]
----
bin/kibana-verification-code
[-V, --version] [-h, --help]
----
[discrete]
==== Description
Use this command to retrieve a verification code for {kib}. You enter this code
in {kib} when manually configuring a secure connection with an {es} cluster.
This tool is useful if you dont have access to the {kib} terminal output, such
as on a hosted environment. You can connect to a machine where {kib} is
running (such as using SSH) and retrieve a verification code that you enter in
{kib}.
IMPORTANT: You must run this tool on the same machine where {kib} is running.
[discrete]
[[kibana-verification-code-parameters]]
==== Parameters
`-h, --help`:: Returns all of the command parameters.
`-V, --version`:: Displays the {kib} version number.
[discrete]
==== Examples
The following command retrieves a verification code for {kib}.
[source,shell]
----
bin/kibana-verification-code
----

View file

@ -70,3 +70,5 @@ include::monitoring/configuring-monitoring.asciidoc[leveloffset=+1]
include::monitoring/monitoring-metricbeat.asciidoc[leveloffset=+2]
include::monitoring/viewing-metrics.asciidoc[leveloffset=+2]
include::monitoring/monitoring-kibana.asciidoc[leveloffset=+2]
include::commands/cli-commands.asciidoc[]