Skip to content

Commit

Permalink
[DOCS] Add kibana-verification-tool and CLI main page
Browse files Browse the repository at this point in the history
  • Loading branch information
Adam Locke committed Dec 8, 2021
1 parent b1b4919 commit 663d20a
Show file tree
Hide file tree
Showing 3 changed files with 54 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/user/commands/cli-commands.asciidoc
Original file line number Diff line number Diff line change
@@ -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[]
44 changes: 44 additions & 0 deletions docs/user/commands/kibana-verification-code.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
[[kibana-verification-code]]
=== kibana-verification-code

The `kibana-verification-code` tool generates 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 generate 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 don’t 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 generate a verification code that you enter in
{kib}.

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 generates a verification code for {kib}.

[source,shell]
----
bin/kibana-verification-code
----
2 changes: 2 additions & 0 deletions docs/user/setup.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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[]

0 comments on commit 663d20a

Please sign in to comment.