Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
lockewritesdocs marked this conversation as resolved.
Show resolved Hide resolved
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
lockewritesdocs marked this conversation as resolved.
Show resolved Hide resolved
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
lockewritesdocs marked this conversation as resolved.
Show resolved Hide resolved
{kib}.

You must run this tool on the same machine where {kib} is running.
lockewritesdocs marked this conversation as resolved.
Show resolved Hide resolved

[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[]