33== Getting started with security
44
55In this tutorial, you learn how to secure a cluster by configuring users and
6- roles for use in {es}, {kib}, {ls}, and {metricbeat}.
6+ roles in {es}, {kib}, {ls}, and {metricbeat}.
77
88[float]
99[[gs-security-prereqs]]
1010=== Before you begin
1111
12- Install and start {es}, {kib}, {ls}, and {metricbeat} as described in
12+ . Install and configure {es}, {kib}, {ls}, and {metricbeat} as described in
1313<<get-started-elastic-stack>>.
1414
15- Launch the {kib} web interface by pointing your browser to port 5601. For
15+ . Stop {ls}. The method for starting and stopping {ls} varies depending on whether
16+ you are running it from the command line or running it as a service. For example,
17+ if you are running {ls} from the command line, you can stop it by entering
18+ `Ctrl-C`. See {logstash-ref}/shutdown.html[Shutting down {ls}].
19+
20+ . Stop {metricbeat}. For example, enter `Ctrl-C` on the command line where it is
21+ running.
22+
23+ . Launch the {kib} web interface by pointing your browser to port 5601. For
1624example, http://127.0.0.1:5601[http://127.0.0.1:5601].
1725
1826[float]
@@ -47,12 +55,14 @@ the trial, or purchase a subscription.
4755
4856When you use the trial license, {security} is disabled by default. To enable it:
4957
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.
58+ . Stop {kib}. The method for starting and stopping {kib} varies depending on
59+ how you installed it. For example, if you installed {kib} from an archive
60+ distribution (`.tar.gz` or `.zip`), stop it by entering `Ctrl-C` on the command
61+ line. See {kibana-ref}/start-stop.html[Starting and stopping {kib}].
5362
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.
63+ . Stop {es}. For example, if you installed {es} from an archive distribution,
64+ enter `Ctrl-C` on the command line. See
65+ {ref}/stopping-elasticsearch.html[Stopping {es}].
5666
5767. Add the `xpack.security.enabled` setting to the
5868`ES_PATH_CONF/elasticsearch.yml` file.
@@ -100,6 +110,8 @@ the following command from the {es} directory:
100110----------------------------------------------------------------------
101111./bin/elasticsearch
102112----------------------------------------------------------------------
113+
114+ See {ref}/starting-elasticsearch.html[Starting {es}].
103115--
104116
105117. Set the built-in users' passwords. Run the following command from the {es}
@@ -128,7 +140,7 @@ and {metricbeat-ref}/monitoring.html[Monitoring {metricbeat}].
128140When {security} is enabled, users must log in to {kib} with a valid user ID and
129141password.
130142
131- {kib} also performs some tasks under the covers, which require use of the
143+ {kib} also performs some tasks under the covers that require use of the
132144built-in `kibana` user.
133145
134146. If you don't mind having passwords visible in your configuration file,
@@ -179,6 +191,8 @@ directory:
179191----------------------------------------------------------------------
180192./bin/kibana
181193----------------------------------------------------------------------
194+
195+ See {kibana-ref}/start-stop.html[Starting and stopping {kib}].
182196--
183197
184198[float]
@@ -303,8 +317,8 @@ If you want to learn more about authorization and roles, see <<authorization>>.
303317=== Add users in {ls}
304318
305319In order for {ls} to send data successfully to {es}, you must configure its
306- authentication credentials. You must configure credentials separately for each
307- of the {es} plugins in your {ls} configuration file. For example, update the
320+ authentication credentials. You must configure credentials for each of the {es}
321+ plugins in your {ls} configuration file. For example, update the
308322`demo-metrics-pipeline.conf` file in your {ls} directory:
309323
310324[source,ruby]
@@ -359,7 +373,15 @@ in an environment variable called `LOGSTASH_KEYSTORE_PASS`. For more information
359373see {logstash-ref}/keystore.html#keystore-password[Keystore password].
360374
361375When prompted, specify the `metricbeat_internal` user and its password for the
362- `ES_USER` and `ES_PWD` values. You can now use these keys in your configuration
376+ `ES_USER` and `ES_PWD` values.
377+
378+ NOTE: The {ls} keystore differs from the {kib} keystore. Whereas the {kib}
379+ keystore enables you to store `kibana.yml` settings by name, the {ls} keystore
380+ enables you to create arbitrary names that you can reference in the {ls}
381+ configuration. To learn more, see
382+ {logstash-ref}/keystore.html[Secrets keystore for secure settings].
383+
384+ You can now use these `ES_USER` and `ES_PWD` keys in your configuration
363385file. For example, update the output section of the `demo-metrics-pipeline.conf`
364386file as follows:
365387
@@ -378,22 +400,17 @@ output {
378400}
379401----
380402
381- Note that the {ls} keystore differs from the {kib} keystore. Whereas the {kib}
382- keystore enables you to store `kibana.yml` settings by name, the {ls} keystore
383- enables you to create arbitrary names that you can reference in the {ls}
384- configuration. To learn more, see
385- {logstash-ref}/keystore.html[Secrets keystore for secure settings].
386-
387- Start {ls} by using the appropriate method for your environment. For example, if
388- you installed {ls} with a `.tar.gz` package, run the following command from the
389- {ls} directory:
403+ Start {ls} by using the appropriate method for your environment. For example, to
404+ run {ls} from a command line, go to the {ls} directory and enter the following
405+ command:
390406
391407["source","sh",subs="attributes,callouts"]
392408----------------------------------------------------------------------
393409./bin/logstash -f demo-metrics-pipeline.conf
394410----------------------------------------------------------------------
395411
396- For more methods to start {ls}, see <<gs-start-logstash>>.
412+ To start {ls} as a service, see
413+ {logstash-ref}/running-logstash.html[Running {ls} as a service on Debian or RPM].
397414
398415[float]
399416[[gs-metricbeat-security]]
@@ -415,16 +432,18 @@ example, on macOS, run the following command from the {metricbeat} directory:
415432./metricbeat -e
416433----------------------------------------------------------------------
417434
418- For more methods, see <<gs-start-metricbeat,start {metricbeat}>>.
435+ For more methods, see {metricbeat-ref}/metricbeat-starting.html[Starting {metricbeat}].
436+
437+ Wait a few minutes for new data to be sent from {metricbeat} to {ls} and {es}.
419438
420439[float]
421440[[gs-view-security]]
422441=== View system metrics in {kib}
423442
424- Log in to {kib} with the user ID that has `metricbeat_reader` role (for example,
425- `jdoe`).
443+ Log in to {kib} with the user ID that has `metricbeat_reader` and `kibana_user`
444+ roles (for example, `jdoe`).
426445
427- You should be able to see the system metrics (for example, on
446+ These roles enable the user to see the system metrics in {kib} (for example, on
428447the *Discover* page or in the
429448http://localhost:5601/app/kibana#/dashboard/Metricbeat-system-overview[{metricbeat} system overview dashboard]).
430449
0 commit comments