Skip to content

Commit 66d1bec

Browse files
committed
[DOCS] Adds examples for start and stop commands
1 parent 2cf1faa commit 66d1bec

File tree

1 file changed

+58
-9
lines changed

1 file changed

+58
-9
lines changed

docs/en/stack/security/get-started-security.asciidoc

Lines changed: 58 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -45,10 +45,19 @@ the trial, or purchase a subscription.
4545
[[gs-security-enabled]]
4646
=== Enable security in {es}
4747

48-
When you use the trial license, {security} is disabled by default. You must
49-
stop {kib}, stop {es}, then add the `xpack.security.enabled` setting to the
50-
`ES_PATH_CONF/elasticsearch.yml` file.
48+
When you use the trial license, {security} is disabled by default. To enable it:
49+
50+
. Stop {kib}. The method for starting and stopping products varies depending on
51+
how you installed them. For example, if you installed {kib} with a `.tar.gz` package,
52+
you can stop it by entering `Ctrl-C` on the command line where it is running.
53+
54+
. Stop {es}. For example, if you installed {es} with a `.tar.gz` package, stop
55+
it by entering `Ctrl-C` on the command line where it is running.
5156

57+
. Add the `xpack.security.enabled` setting to the
58+
`ES_PATH_CONF/elasticsearch.yml` file.
59+
+
60+
--
5261
TIP: The `ES_PATH_CONF` environment variable contains the path for the {es}
5362
configuration files. If you installed {es} using archive distributions (`zip` or
5463
`tar.gz`), it defaults to `ES_HOME/config`. If you used package distributions
@@ -62,6 +71,8 @@ For example, add the following setting:
6271
xpack.security.enabled: true
6372
----
6473

74+
--
75+
6576
NOTE: This tutorial involves a single node cluster, but if you had multiple
6677
nodes, you would enable {security} on every node in the cluster and configure
6778
Transport Layer Security (TLS) for internode-communication, which is beyond the
@@ -79,13 +90,27 @@ include a user name and password are rejected.
7990
There are built-in users that you can use for specific administrative purposes:
8091
`elastic`, `kibana`, `logstash_system`, and `beats_system`.
8192

82-
Before you can use them, you must set their passwords. Restart {es}, then run
93+
Before you can use them, you must set their passwords:
94+
95+
. Restart {es}. For example, if you installed {es} with a `.tar.gz` package, run
8396
the following command from the {es} directory:
97+
+
98+
--
99+
["source","sh",subs="attributes,callouts"]
100+
----------------------------------------------------------------------
101+
./bin/elasticsearch
102+
----------------------------------------------------------------------
103+
--
84104

105+
. Set the built-in users' passwords. Run the following command from the {es}
106+
directory:
107+
+
108+
--
85109
["source","sh",subs="attributes,callouts"]
86110
----------------------------------------------------------------------
87-
bin/elasticsearch-setup-passwords interactive
111+
./bin/elasticsearch-setup-passwords interactive
88112
----------------------------------------------------------------------
113+
--
89114

90115
You need these built-in users in subsequent steps, so choose passwords that you
91116
can remember!
@@ -123,7 +148,14 @@ elasticsearch.password: "your_password"
123148
Specify the password that you set with the `elasticsearch-setup-passwords`
124149
command.
125150

126-
Save your changes to the file and restart {kib}.
151+
Save your changes to the file and restart {kib}. For example, if you installed
152+
{kib} with a `.tar.gz` package, run the following command from the {kib}
153+
directory:
154+
155+
["source","sh",subs="attributes,callouts"]
156+
----------------------------------------------------------------------
157+
./bin/kibana
158+
----------------------------------------------------------------------
127159

128160
[float]
129161
[[gs-realms]]
@@ -284,7 +316,16 @@ output {
284316
<1> Specify the `metricbeat_internal` user that you created earlier in this tutorial.
285317
<2> Specify the password that you chose for this user ID.
286318

287-
<<gs-start-logstash,Start {ls}>>.
319+
Start {ls} by using the appropriate method for your environment. For example, if
320+
you installed {ls} with a `.tar.gz` package, run the following command from the
321+
{ls} directory:
322+
323+
["source","sh",subs="attributes,callouts"]
324+
----------------------------------------------------------------------
325+
./bin/logstash -f demo-metrics-pipeline.conf
326+
----------------------------------------------------------------------
327+
328+
For more methods to start {ls}, see <<gs-start-logstash>>.
288329

289330
[float]
290331
[[gs-metricbeat-security]]
@@ -298,7 +339,15 @@ In <<get-started-elastic-stack>>, however, you configured {metricbeat} to send
298339
the data to {ls} for additional parsing, so no extra settings are required in
299340
{metricbeat}.
300341

301-
<<gs-start-metricbeat,Start {metricbeat}>>.
342+
Start {metricbeat} by using the appropriate method for your environment. For
343+
example, on macOS, run the following command from the {metricbeat} directory:
344+
345+
["source","sh",subs="attributes,callouts"]
346+
----------------------------------------------------------------------
347+
./metricbeat -e
348+
----------------------------------------------------------------------
349+
350+
For more methods, see <<gs-start-metricbeat,start {metricbeat}>>.
302351

303352
[float]
304353
[[gs-view-security]]
@@ -312,7 +361,7 @@ the *Discover* page or in the http://localhost:5601/app/kibana#/dashboard/Metric
312361

313362
[float]
314363
[[gs-security-nextsteps]]
315-
==== What's next?
364+
=== What's next?
316365

317366
Congratulations! You've successfully set up authentication and authorization by
318367
using the native realm. You learned how to create user IDs and roles that

0 commit comments

Comments
 (0)