Skip to content

Commit 6a228e4

Browse files
authored
[6.3][DOCS] Adds security content in Elasticsearch Reference (#48169)
1 parent e03f90a commit 6a228e4

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+216
-335
lines changed

docs/reference/index.asciidoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,9 +59,9 @@ include::monitoring/index.asciidoc[]
5959

6060
include::rollup/index.asciidoc[]
6161

62-
include::{xes-repo-dir}/watcher/index.asciidoc[]
62+
include::{xes-repo-dir}/security/index.asciidoc[]
6363

64-
include::security/index.asciidoc[]
64+
include::{xes-repo-dir}/watcher/index.asciidoc[]
6565

6666
include::rest-api/index.asciidoc[]
6767

docs/reference/monitoring/production.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@ POST /_xpack/security/user/remote_monitor
5252
}
5353
---------------------------------------------------------------
5454
// CONSOLE
55+
//TEST[skip:license-requirements]
5556
--
5657

5758
. Configure each {es} node in the cluster you are
@@ -140,6 +141,7 @@ POST /_xpack/security/user/stack-monitor
140141
}
141142
--------------------------------------------------
142143
// CONSOLE
144+
//TEST[skip:license-requirements]
143145

144146
//image:images/monitoring.jpg["Monitoring",link="images/monitoring.jpg"]
145147
--

docs/reference/security/index.asciidoc

Lines changed: 0 additions & 18 deletions
This file was deleted.

x-pack/docs/en/security/auditing/event-types.asciidoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ The following is a list of the events that can be generated:
1616
realm type.
1717
| `access_denied` | | | Logged when an authenticated user attempts to execute
1818
an action they do not have the necessary
19-
<<security-reference, privilege>> to perform.
19+
<<security-privileges,privilege>> to perform.
2020
| `access_granted` | | | Logged when an authenticated user attempts to execute
2121
an action they have the necessary privilege to perform.
2222
When the `system_access_granted` event is included, all system
@@ -26,7 +26,7 @@ The following is a list of the events that can be generated:
2626
another user that they have the necessary privileges to do.
2727
| `run_as_denied` | | | Logged when an authenticated user attempts to <<run-as-privilege, run as>>
2828
another user action they do not have the necessary
29-
<<security-reference, privilege>> to do so.
29+
<<security-privileges,privilege>> to do so.
3030
| `tampered_request` | | | Logged when {security} detects that the request has
3131
been tampered with. Typically relates to `search/scroll`
3232
requests when the scroll ID is believed to have been
Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,5 @@
1-
:edit_url: https://github.com/elastic/elasticsearch/edit/{branch}/x-pack/docs/en/security/auditing/overview.asciidoc
21
include::overview.asciidoc[]
3-
4-
:edit_url: https://github.com/elastic/elasticsearch/edit/{branch}/x-pack/docs/en/security/auditing/event-types.asciidoc
52
include::event-types.asciidoc[]
6-
7-
:edit_url: https://github.com/elastic/elasticsearch/edit/{branch}/x-pack/docs/en/security/auditing/output-logfile.asciidoc
83
include::output-logfile.asciidoc[]
9-
10-
:edit_url: https://github.com/elastic/elasticsearch/edit/{branch}/x-pack/docs/en/security/auditing/output-index.asciidoc
114
include::output-index.asciidoc[]
12-
13-
:edit_url: https://github.com/elastic/elasticsearch/edit/{branch}/x-pack/docs/en/security/auditing/forwarding-logs.asciidoc
145
include::forwarding-logs.asciidoc[]

x-pack/docs/en/security/authentication/file-realm.asciidoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@ IMPORTANT: When you configure realms in `elasticsearch.yml`, only the
1919
realms you specify are used for authentication. To use the
2020
`file` realm as a fallback, you must include it in the realm chain.
2121

22-
To define users, {security} provides the {ref}/users-command.html[users]
22+
To define users, {security} provides the <<users-command,users>>
2323
command-line tool. This tool enables you to add and remove users, assign user
2424
roles, and manage user passwords.
2525

2626
For more information, see
27-
{ref}/configuring-file-realm.html[Configuring a file realm].
27+
<<configuring-file-realm>>.

x-pack/docs/en/security/authentication/index.asciidoc

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,7 @@ include::ldap-realm.asciidoc[]
99
include::native-realm.asciidoc[]
1010
include::pki-realm.asciidoc[]
1111
include::saml-realm.asciidoc[]
12-
13-
include::{xes-repo-dir}/security/authentication/custom-realm.asciidoc[]
14-
15-
include::{xes-repo-dir}/security/authentication/anonymous-access.asciidoc[]
16-
17-
include::{xes-repo-dir}/security/authentication/user-cache.asciidoc[]
18-
19-
include::{xes-repo-dir}/security/authentication/saml-guide.asciidoc[]
12+
include::custom-realm.asciidoc[]
13+
include::anonymous-access.asciidoc[]
14+
include::user-cache.asciidoc[]
15+
include::saml-guide.asciidoc[]
Lines changed: 6 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,12 @@
11

22
include::overview.asciidoc[]
3-
43
include::built-in-roles.asciidoc[]
5-
6-
include::{xes-repo-dir}/security/authorization/managing-roles.asciidoc[]
7-
4+
include::managing-roles.asciidoc[]
85
include::privileges.asciidoc[]
9-
106
include::document-level-security.asciidoc[]
11-
127
include::field-level-security.asciidoc[]
13-
14-
include::{xes-repo-dir}/security/authorization/alias-privileges.asciidoc[]
15-
16-
include::{xes-repo-dir}/security/authorization/mapping-roles.asciidoc[]
17-
18-
include::{xes-repo-dir}/security/authorization/field-and-document-access-control.asciidoc[]
19-
20-
include::{xes-repo-dir}/security/authorization/run-as-privilege.asciidoc[]
21-
22-
include::{xes-repo-dir}/security/authorization/custom-roles-provider.asciidoc[]
8+
include::alias-privileges.asciidoc[]
9+
include::mapping-roles.asciidoc[]
10+
include::field-and-document-access-control.asciidoc[]
11+
include::run-as-privilege.asciidoc[]
12+
include::custom-roles-provider.asciidoc[]

x-pack/docs/en/security/authorization/mapping-roles.asciidoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
If you authenticate users with the `native` or `file` realms, you can manage
66
role assignment by using the <<managing-native-users, User Management APIs>> or
7-
the {ref}/users-command.html[users] command-line tool respectively.
7+
the <<users-command,users>> command-line tool respectively.
88

99
For other types of realms, you must create _role-mappings_ that define which
1010
roles should be assigned to each user based on their username, groups, or
@@ -18,7 +18,7 @@ the API, and other roles that are mapped through files.
1818

1919
When you use role-mappings, you assign existing roles to users.
2020
The available roles should either be added using the
21-
{ref}/security-api.html#security-role-apis[role management APIs] or defined in the
21+
<<security-role-apis,role management APIs>> or defined in the
2222
<<roles-management-file, roles file>>. Either role-mapping method can use
2323
either role management method. For example, when you use the role mapping API,
2424
you are able to map users to both API-managed roles and file-managed roles
@@ -28,7 +28,7 @@ you are able to map users to both API-managed roles and file-managed roles
2828
==== Using the role mapping API
2929

3030
You can define role-mappings through the
31-
{ref}/security-api-put-role-mapping.html[add role mapping API].
31+
<<security-api-put-role-mapping,add role mapping API>>.
3232

3333
[[mapping-roles-file]]
3434
==== Using role mapping files
@@ -41,9 +41,9 @@ By default, role mappings are stored in `ES_PATH_CONF/role_mapping.yml`,
4141
where `ES_PATH_CONF` is `ES_HOME/config` (zip/tar installations) or
4242
`/etc/elasticsearch` (package installations). To specify a different location,
4343
you configure the `files.role_mapping` setting in the
44-
{ref}/security-settings.html#ref-ad-settings[Active Directory],
45-
{ref}/security-settings.html#ref-ldap-settings[LDAP], and
46-
{ref}/security-settings.html#ref-pki-settings[PKI] realm settings in
44+
<<ref-ad-settings,Active Directory>>,
45+
<<ref-ldap-settings,LDAP>>, and
46+
<<ref-pki-settings,PKI>> realm settings in
4747
`elasticsearch.yml`.
4848

4949
Within the role mapping file, the security roles are keys and groups and users

x-pack/docs/en/security/configuring-es.asciidoc

Lines changed: 12 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,13 @@
22
[[configuring-security]]
33
== Configuring security in {es}
44
++++
5-
<titleabbrev>Configuring Security</titleabbrev>
5+
<titleabbrev>Configuring security</titleabbrev>
66
++++
77

88
{security} enables you to easily secure a cluster. With {security}, you can
99
password-protect your data as well as implement more advanced security measures
1010
such as encrypting communications, role-based access control, IP filtering, and
11-
auditing. For more information, see
12-
{xpack-ref}/xpack-security.html[Securing the Elastic Stack].
11+
auditing.
1312

1413
To use {security} in {es}:
1514

@@ -20,12 +19,12 @@ If you want to try all of the {xpack} features, you can start a 30-day trial. At
2019
the end of the trial period, you can purchase a subscription to keep using the
2120
full functionality of the {xpack} components. For more information, see
2221
https://www.elastic.co/subscriptions and
23-
{xpack-ref}/license-management.html[License Management].
22+
{stack-ov}/license-management.html[License management].
2423
--
2524

2625
. Verify that the `xpack.security.enabled` setting is `true` on each node in
2726
your cluster. If you are using a trial license, the default value is `false`.
28-
For more information, see {ref}/security-settings.html[Security Settings in {es}].
27+
For more information, see <<security-settings>>.
2928

3029
. Configure Transport Layer Security (TLS/SSL) for internode-communication.
3130
+
@@ -34,20 +33,20 @@ NOTE: This requirement applies to clusters with more than one node and to
3433
clusters with a single node that listens on an external interface. Single-node
3534
clusters that use a loopback interface do not have this requirement. For more
3635
information, see
37-
{xpack-ref}/encrypting-communications.html[Encrypting Communications].
36+
<<encrypting-communications>>.
3837

3938
--
4039
.. <<node-certificates,Generate node certificates for each of your {es} nodes>>.
4140

42-
.. <<tls-transport, Enable TLS on each {es} node>>.
41+
.. <<tls-transport,Enable TLS on each {es} node>>.
4342

4443
. If it is not already running, start {es}.
4544

4645
. Set the passwords for all built-in users.
4746
+
4847
--
4948
{security} provides
50-
{stack-ov}/built-in-users.html[built-in users] to
49+
<<built-in-users,built-in users>> to
5150
help you get up and running. The +elasticsearch-setup-passwords+ command is the
5251
simplest method to set the built-in users' passwords for the first time.
5352

@@ -121,7 +120,7 @@ curl -XPOST -u elastic 'localhost:9200/_xpack/security/user/johndoe' -H "Content
121120
xpack.security.audit.enabled: true
122121
----------------------------
123122
+
124-
For more information, see {xpack-ref}/auditing.html[Auditing Security Events]
123+
For more information, see <<auditing>>
125124
and <<auditing-settings>>.
126125

127126
.. Restart {es}.
@@ -131,28 +130,15 @@ By default, events are logged to a dedicated `elasticsearch-access.log` file in
131130
easier analysis and control what events are logged.
132131
--
133132

134-
:edit_url: https://github.com/elastic/elasticsearch/edit/{branch}/docs/reference/security/securing-communications/securing-elasticsearch.asciidoc
135-
include::{es-repo-dir}/security/securing-communications/securing-elasticsearch.asciidoc[]
136-
137-
:edit_url: https://github.com/elastic/elasticsearch/edit/{branch}/docs/reference/security/securing-communications/configuring-tls-docker.asciidoc
138-
include::{es-repo-dir}/security/securing-communications/configuring-tls-docker.asciidoc[]
139-
140-
:edit_url: https://github.com/elastic/elasticsearch/edit/{branch}/docs/reference/security/securing-communications/enabling-cipher-suites.asciidoc
141-
include::{es-repo-dir}/security/securing-communications/enabling-cipher-suites.asciidoc[]
142-
143-
:edit_url: https://github.com/elastic/elasticsearch/edit/{branch}/docs/reference/security/securing-communications/separating-node-client-traffic.asciidoc
144-
include::{es-repo-dir}/security/securing-communications/separating-node-client-traffic.asciidoc[]
145-
146-
:edit_url:
133+
include::securing-communications/securing-elasticsearch.asciidoc[]
134+
include::securing-communications/configuring-tls-docker.asciidoc[]
135+
include::securing-communications/enabling-cipher-suites.asciidoc[]
136+
include::securing-communications/separating-node-client-traffic.asciidoc[]
147137
include::authentication/configuring-active-directory-realm.asciidoc[]
148138
include::authentication/configuring-file-realm.asciidoc[]
149139
include::authentication/configuring-ldap-realm.asciidoc[]
150140
include::authentication/configuring-native-realm.asciidoc[]
151141
include::authentication/configuring-pki-realm.asciidoc[]
152142
include::authentication/configuring-saml-realm.asciidoc[]
153-
154-
:edit_url: https://github.com/elastic/elasticsearch/edit/{branch}/docs/reference/settings/security-settings.asciidoc
155143
include::{es-repo-dir}/settings/security-settings.asciidoc[]
156-
157-
:edit_url: https://github.com/elastic/elasticsearch/edit/{branch}/docs/reference/settings/audit-settings.asciidoc
158144
include::{es-repo-dir}/settings/audit-settings.asciidoc[]

x-pack/docs/en/security/get-started-builtin-users.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ the following command from the {es} directory:
1212
./bin/elasticsearch
1313
----------------------------------------------------------------------
1414
15-
See {ref}/starting-elasticsearch.html[Starting {es}].
15+
See <<starting-elasticsearch>>.
1616
--
1717
1818
. Set the built-in users' passwords. Run the following command from the {es}

x-pack/docs/en/security/get-started-enable-security.asciidoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ line. See {kibana-ref}/start-stop.html[Starting and stopping {kib}].
77

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

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

2222
For example, add the following setting:
2323

x-pack/docs/en/security/get-started-security.asciidoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ example, http://127.0.0.1:5601[http://127.0.0.1:5601].
2727
[[get-started-license]]
2828
=== Install a trial license
2929

30-
include::{docdir}/get-started-trial.asciidoc[]
30+
include::get-started-trial.asciidoc[]
3131

3232
[role="xpack"]
3333
[[get-started-enable-security]]
@@ -328,15 +328,15 @@ using the native realm. You learned how to create user IDs and roles that
328328
prevent unauthorized access to the {stack}.
329329

330330
Next, you'll want to try other features that are unlocked by your trial license,
331-
such as {ml}. See <<ml-getting-started,Getting started with {ml}>>.
331+
such as {ml}. See {stack-ov}/ml-getting-started.html[Getting started with {ml}].
332332

333333
Later, when you're ready to increase the number of nodes in your cluster or set
334334
up an production environment, you'll want to encrypt communications across the
335335
{stack}. To learn how, read <<encrypting-communications>>.
336336

337337
For more detailed information about securing the {stack}, see:
338338

339-
* {ref}/configuring-security.html[Configuring security in {es}]. Encrypt
339+
* <<configuring-security,Configuring security in {es}>>. Encrypt
340340
inter-node communications, set passwords for the built-in users, and manage your
341341
users and roles.
342342

x-pack/docs/en/security/get-started-trial.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,5 +17,5 @@ major version, you cannot start a new trial. For example, if you have already
1717
activated a trial for v6.0, you cannot start a new trial until v7.0.
1818

1919
At the end of the trial period, the platinum features operate in a
20-
<<license-expiration,degraded mode>>. You can revert to a basic license, extend
20+
{stack-ov}/license-expiration.html[degraded mode]. You can revert to a basic license, extend
2121
the trial, or purchase a subscription.

0 commit comments

Comments
 (0)