forked from elastic/kibana
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[DOCS] Add kibana-verification-tool and CLI main page (elastic#120836)
* [DOCS] Add kibana-verification-tool and CLI main page * Change wording from generating to retrieving
- Loading branch information
Showing
3 changed files
with
54 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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[] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 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 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 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 | ||
---- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters