Skip to content

Commit bf48c08

Browse files
Copilotlegrego
andcommitted
Add documentation for kibana-setup CLI
Co-authored-by: legrego <[email protected]>
1 parent 85e014c commit bf48c08

File tree

3 files changed

+65
-0
lines changed

3 files changed

+65
-0
lines changed

docs/reference/commands.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ mapped_pages:
88
{{kib}} provides the following tools for configuring security and performing other tasks from the command line:
99

1010
* [`kibana-encryption-keys`](/reference/commands/kibana-encryption-keys.md)
11+
* [`kibana-setup`](/reference/commands/kibana-setup.md)
1112
* [`kibana-verification-code`](/reference/commands/kibana-verification-code.md)
1213

1314

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
---
2+
mapped_pages:
3+
- https://www.elastic.co/guide/en/kibana/current/kibana-setup.html
4+
---
5+
6+
# kibana-setup [kibana-setup]
7+
8+
The `kibana-setup` tool walks you through all required steps to securely connect {{kib}} with {{es}}.
9+
10+
11+
## Synopsis [_synopsis]
12+
13+
```shell
14+
bin/kibana-setup
15+
[-t, --enrollment-token <token>] [-s, --silent]
16+
[-V, --version] [-h, --help]
17+
```
18+
19+
20+
## Description [_description]
21+
22+
Use this command to configure a secure connection between {{kib}} and {{es}}. The tool guides you through the process of enrolling {{kib}} with a secured {{es}} cluster using an enrollment token. This is particularly useful for initial setup and configuration of {{kib}} in secured environments.
23+
24+
::::{important}
25+
You must have an enrollment token generated from your {{es}} cluster before running this command.
26+
::::
27+
28+
29+
30+
## Parameters [kibana-setup-parameters]
31+
32+
`-t, --enrollment-token <token>`
33+
: Elasticsearch enrollment token to use for configuring the connection.
34+
35+
`-s, --silent`
36+
: Prevent all logging output during the setup process.
37+
38+
`-h, --help`
39+
: Returns all of the command parameters.
40+
41+
`-V, --version`
42+
: Displays the {{kib}} version number.
43+
44+
45+
## Examples [_examples_2]
46+
47+
The following command runs the interactive setup process:
48+
49+
```shell
50+
bin/kibana-setup
51+
```
52+
53+
The following command configures {{kib}} with a specific enrollment token:
54+
55+
```shell
56+
bin/kibana-setup --enrollment-token <your-enrollment-token>
57+
```
58+
59+
The following command runs setup silently with an enrollment token:
60+
61+
```shell
62+
bin/kibana-setup --enrollment-token <your-enrollment-token> --silent
63+
```

docs/reference/toc.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,7 @@ toc:
6666
- file: commands.md
6767
children:
6868
- file: commands/kibana-encryption-keys.md
69+
- file: commands/kibana-setup.md
6970
- file: commands/kibana-verification-code.md
7071
- file: osquery-exported-fields.md
7172
- file: osquery-manager-prebuilt-packs.md

0 commit comments

Comments
 (0)