Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
a1e4f2a
[DOCS] Creates security getting started tutorial
lcawl Jun 21, 2018
43052c2
[DOCS] Adds built-in users to security tutorial
lcawl Jun 22, 2018
7a8c970
[DOCS] Adds user and role steps to security tutorial
lcawl Jun 25, 2018
9a093fa
[DOCS] Adds metricbeat and logstash config
lcawl Jun 25, 2018
57b669f
[DOCS] Small edits and image fixes
lcawl Jun 25, 2018
9e15954
[DOCS] Fixed config file paths
lcawl Jun 27, 2018
8646df2
[DOCS] Improved role assignment info
lcawl Jun 27, 2018
707f6e7
[DOCS] Fixed licensing info
lcawl Jun 28, 2018
3f37d87
[DOCS] Clarify built-in users
lcawl Jun 28, 2018
f8afc67
[DOCS] Clarified TLS note
lcawl Jun 29, 2018
8cfcfe3
[DOCS] Adds examples for start and stop commands
lcawl Jun 29, 2018
99dee45
[DOCS] Adds quotes to metricbeat config
lcawl Jul 3, 2018
cb8cd59
[DOCS] Adds kibana keystore commands
lcawl Jul 3, 2018
ccacb3c
[DOCS] Adds logstash keystore info
lcawl Jul 3, 2018
2d9445e
[DOCS] Addressed final review comments
lcawl Jul 4, 2018
9c60bac
[DOCS] Changes metricbeat_internal to logstash_internal
lcawl Jul 4, 2018
802aa77
[DOCS] Rebase from master
lcawl Jul 6, 2018
3f1114a
[DOCS] Remove duplicate image
lcawl Jul 6, 2018
9e29ac3
[DOCS] Split off reusable content
lcawl Jul 6, 2018
fd326a6
[DOCS] Clarified keystore vs config file options
lcawl Jul 9, 2018
0dc87b1
[DOCS] Re-use Kibana configuration info
lcawl Jul 23, 2018
446e090
[DOCS] Adds xpack.security.enabled recommendation
lcawl Jul 24, 2018
dd7d54b
[DOCS] Split security tutorial into multiple pages
lcawl Jul 24, 2018
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
4 changes: 3 additions & 1 deletion docs/en/stack/getting-started/get-started-stack.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,7 @@ and maps.
To get started, we recommend that you install {kib} on the same server as {es},
but it is not required. If you install the products on different servers, you'll
need to change the URL (IP:PORT) of the {es} server in the {kib} configuration
file, `config/kibana.yml`, before starting {kib}.
file, `kibana.yml`, before starting {kib}.

To download and install {kib}, open a terminal window and use the commands that
work with your system:
Expand Down Expand Up @@ -483,6 +483,7 @@ The `setup` command loads the {kib} dashboards. If the dashboards are already
set up, omit this command. The `-e` flag is optional and sends output to
standard error instead of syslog.

[[gs-start-metricbeat]]
. Start {metricbeat}:
+
*deb and rpm:*
Expand Down Expand Up @@ -675,6 +676,7 @@ through {ls}, where you have full access to {ls} capabilities for collecting,
enriching, and transforming data.

[float]
[[gs-start-logstash]]
==== Start {ls}

Use the command that works with your system. If you installed {ls} as a deb or
Expand Down
26 changes: 26 additions & 0 deletions docs/en/stack/security/get-started-builtin-users.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
There are built-in users that you can use for specific administrative purposes:
`elastic`, `kibana`, `logstash_system`, and `beats_system`.

Before you can use them, you must set their passwords:

. Restart {es}. For example, if you installed {es} with a `.tar.gz` package, run
the following command from the {es} directory:
+
--
["source","sh",subs="attributes,callouts"]
----------------------------------------------------------------------
./bin/elasticsearch
----------------------------------------------------------------------

See {ref}/starting-elasticsearch.html[Starting {es}].
--

. Set the built-in users' passwords. Run the following command from the {es}
directory:
+
--
["source","sh",subs="attributes,callouts"]
----------------------------------------------------------------------
./bin/elasticsearch-setup-passwords interactive
----------------------------------------------------------------------
--
39 changes: 39 additions & 0 deletions docs/en/stack/security/get-started-enable-security.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
When you use the trial license, {security} is disabled by default. To enable it:

. Stop {kib}. The method for starting and stopping {kib} varies depending on
how you installed it. For example, if you installed {kib} from an archive
distribution (`.tar.gz` or `.zip`), stop it by entering `Ctrl-C` on the command
line. See {kibana-ref}/start-stop.html[Starting and stopping {kib}].

. Stop {es}. For example, if you installed {es} from an archive distribution,
enter `Ctrl-C` on the command line. See
{ref}/stopping-elasticsearch.html[Stopping {es}].

. Add the `xpack.security.enabled` setting to the
`ES_PATH_CONF/elasticsearch.yml` file.
+
--
TIP: The `ES_PATH_CONF` environment variable contains the path for the {es}
configuration files. If you installed {es} using archive distributions (`zip` or
`tar.gz`), it defaults to `ES_HOME/config`. If you used package distributions
(Debian or RPM), it defaults to `/etc/elasticsearch`. For more information, see
{ref}/settings.html[Configuring {es}].

For example, add the following setting:

[source,yaml]
----
xpack.security.enabled: true
----

TIP: If you have a basic or trial license, the default value for this setting is
`false`. If you have a gold or higher license, the default value is `true`.
Therefore, it is a good idea to explicitly add this setting to avoid confusion
about whether {security} is enabled.

--

When you enable {security}, basic authentication is enabled by default. To
communicate with the cluster, you must specify a username and password.
Unless you <<anonymous-access,enable anonymous access>>, all requests that don't
include a user name and password are rejected.
60 changes: 60 additions & 0 deletions docs/en/stack/security/get-started-kibana-users.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
When {security} is enabled, users must log in to {kib} with a valid user ID and
password.

{kib} also performs some tasks under the covers that require use of the
built-in `kibana` user.

. Configure {kib} to use the built-in `kibana` user and the password that you
created:

** If you don't mind having passwords visible in your configuration file,
uncomment and update the following settings in the `kibana.yml` file in your
{kib} directory:
+
--
TIP: If you installed {kib} using archive distributions (`zip` or
`tar.gz`), the `kibana.yml` configuration file is in `KIBANA_HOME/config`. If
you used package distributions (Debian or RPM), it's in `/etc/kibana`. For more
information, see {kibana-ref}/settings.html[Configuring {kib}].

For example, add the following settings:

[source,yaml]
----
elasticsearch.username: "kibana"
elasticsearch.password: "your_password"
----

Specify the password that you set with the `elasticsearch-setup-passwords`
command then save your changes to the file.
--

** If you prefer not to put your user ID and password in the `kibana.yml` file,
store them in a keystore instead. Run the following commands to create the {kib}
keystore and add the secure settings:
+
--
["source","sh",subs="attributes,callouts"]
----------------------------------------------------------------------
./bin/kibana-keystore create
./bin/kibana-keystore add elasticsearch.username
./bin/kibana-keystore add elasticsearch.password
----------------------------------------------------------------------

When prompted, specify the `kibana` built-in user and its password for these
setting values. The settings are automatically applied when you start {kib}.
To learn more, see {kibana-ref}/secure-settings.html[Secure settings].
--

. Restart {kib}. For example, if you installed
{kib} with a `.tar.gz` package, run the following command from the {kib}
directory:
+
--
["source","sh",subs="attributes,callouts"]
----------------------------------------------------------------------
./bin/kibana
----------------------------------------------------------------------

See {kibana-ref}/start-stop.html[Starting and stopping {kib}].
--
Loading