Skip to content

Commit f4d00d7

Browse files
committed
[DOCS] Replaces X-Pack security terminology (#187)
1 parent 73d3142 commit f4d00d7

File tree

9 files changed

+79
-77
lines changed

9 files changed

+79
-77
lines changed

docs/en/install-upgrade/upgrading-stack.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -202,7 +202,7 @@ You can also call the Elasticsearch migration APIs directly:
202202
nodes, and indices and returns a list of issues that need to be
203203
fixed before you can upgrade to {version}.
204204
+
205-
`/_xpack/migration/upgrade`:: Upgrades the Watcher and Security indices to a
205+
`/_xpack/migration/upgrade`:: Upgrades the indices for the {watcher} and {security-features} to a
206206
single-type format compatible with Elasticsearch 6.x.
207207

208208
. Once you've resolved all of the migration issues, perform

docs/en/stack/security/authentication/built-in-users.asciidoc

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
[[built-in-users]]
33
=== Built-in users
44

5-
{security} provides built-in user credentials to help you get up and running.
6-
These users have a fixed set of privileges and cannot be authenticated until their
7-
passwords have been set. The `elastic` user can be used to
8-
<<set-built-in-user-passwords,set all of the built-in user passwords>>.
5+
The {stack-security-features} provide built-in user credentials to help you get
6+
up and running. These users have a fixed set of privileges and cannot be
7+
authenticated until their passwords have been set. The `elastic` user can be
8+
used to <<set-built-in-user-passwords,set all of the built-in user passwords>>.
99

1010
`elastic`:: A built-in _superuser_. See <<built-in-roles>>.
1111
`kibana`:: The user Kibana uses to connect and communicate with Elasticsearch.
@@ -20,12 +20,11 @@ storing monitoring information in {es}. It has the `remote_monitoring_agent` and
2020
[float]
2121
[[built-in-user-explanation]]
2222
==== How the built-in users work
23-
These built-in users are stored within a special `.security` index managed by
24-
{security}.
25-
This means that, if the password is changed, or a user is disabled, then that
26-
change is automatically reflected on each node in the cluster. It also means
27-
that if your `.security` index is deleted, or restored from a snapshot, then
28-
any changes you have applied will be lost.
23+
These built-in users are stored in a special `.security` index, which is managed
24+
by {es}. If a built-in user is disabled or its password
25+
changes, the change is automatically reflected on each node in the cluster. If
26+
your `.security` index is deleted or restored from a snapshot, however, any
27+
changes you have applied are lost.
2928

3029
Although they share the same API, the built-in users are separate and distinct
3130
from users managed by the <<native-realm, native realm>>. Disabling the native

docs/en/stack/security/authentication/internal-users.asciidoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,9 @@
22
[[internal-users]]
33
=== Internal users
44

5-
{security} has three _internal_ users (`_system`, `_xpack`, and `_xpack_security`)
6-
that are responsible for the operations that take place inside an {es} cluster.
5+
The {stack-security-features} use three _internal_ users (`_system`, `_xpack`,
6+
and `_xpack_security`), which are responsible for the operations that take place
7+
inside an {es} cluster.
78

89
These users are only used by requests that originate from within the cluster.
910
For this reason, they cannot be used to authenticate against the API and there

docs/en/stack/security/authentication/overview.asciidoc

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,10 @@ You can use the native support for managing and authenticating users, or
1515
integrate with external user management systems such as LDAP and Active
1616
Directory.
1717

18-
{security} provides built-in realms such as `native`,`ldap`, `active_directory`,
19-
`pki`, `file`, and `saml`. If none of the built-in realms meet your needs, you
20-
can also build your own custom realm and plug it into the {stack}.
18+
The {stack-security-features} provide built-in realms such as `native`,`ldap`,
19+
`active_directory`, `pki`, `file`, and `saml`. If none of the built-in realms
20+
meet your needs, you can also build your own custom realm and plug it into the
21+
{stack}.
2122

2223
When {security-features} are enabled, depending on the realms you've configured,
2324
you must attach your user credentials to the requests sent to {es}. For example,

docs/en/stack/security/authorization/built-in-roles.asciidoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22
[[built-in-roles]]
33
=== Built-in roles
44

5-
{security} applies a default role to all users, including
5+
The {stack-security-features} apply a default role to all users, including
66
<<anonymous-access, anonymous users>>. The default role enables users to access
77
the authenticate endpoint, change their own passwords, and get information about
88
themselves.
99

10-
{security} also provides a set of built-in roles you can explicitly assign
11-
to users. These roles have a fixed set of privileges and cannot be updated.
10+
There is also a set of built-in roles you can explicitly assign to users. These
11+
roles have a fixed set of privileges and cannot be updated.
1212

1313
[[built-in-roles-apm-system]] `apm_system` ::
1414
Grants access necessary for the APM system user to send system-level data

docs/en/stack/security/authorization/overview.asciidoc

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,8 @@
22
[[authorization]]
33
== User authorization
44

5-
{security} introduces the concept of _authorization_ to the {stack}.
6-
Authorization is the process of determining whether the user behind an incoming
7-
request is allowed to execute the request.
5+
The {stack-security-features} add _authorization_, which is the process of determining whether the user behind an incoming request is allowed to execute
6+
the request.
87

98
This process takes place after the user is successfully identified and
109
<<setting-up-authentication,authenticated>>.
@@ -13,9 +12,9 @@ This process takes place after the user is successfully identified and
1312
[float]
1413
=== Role-based access control
1514

16-
{security} provides a role-based access control (RBAC) mechanism, which enables
17-
you to authorize users by assigning privileges to roles and assigning roles to
18-
users or groups.
15+
The {security-features} provide a role-based access control (RBAC) mechanism,
16+
which enables you to authorize users by assigning privileges to roles and
17+
assigning roles to users or groups.
1918

2019
image::security/authorization/images/authorization.png[This image illustrates role-based access control]
2120

@@ -65,13 +64,12 @@ to authenticate users. For more information, see <<mapping-roles>>.
6564
[float]
6665
=== Attribute-based access control
6766

68-
{security} also provides an attribute-based access control (ABAC) mechanism,
69-
which enables you to use attributes to restrict access to documents in search
70-
queries and aggregations. For example, you can assign attributes to users and
71-
documents, then implement an access policy in a role definition. Users with that
72-
role can read a specific document only if they have all the required attributes.
67+
The {security-features} also provide an attribute-based access control (ABAC)
68+
mechanism, which enables you to use attributes to restrict access to documents
69+
in search queries and aggregations. For example, you can assign attributes to
70+
users and documents, then implement an access policy in a role definition. Users
71+
with that role can read a specific document only if they have all the required
72+
attributes.
7373

7474
For more information, see
7575
https://www.elastic.co/blog/attribute-based-access-control-with-xpack[Document-level attribute-based access control with X-Pack 6.1].
76-
77-
//TO-DO: Add task related to configuring ABAC.

docs/en/stack/security/how-security-works.asciidoc

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@ Kibana instances, Beats agents an clients, all communicating with the it.
88
It should not come as a surprise that securing such clusters has many facets and
99
layers.
1010

11-
{security} provides the means to secure the Elastic cluster on several levels:
11+
The {stack-security-features} provide the means to secure the Elastic cluster
12+
on several levels:
1213

1314
* <<setting-up-authentication,User authentication>>
1415
* <<authorization,User authorization and access control>>
@@ -18,20 +19,20 @@ layers.
1819
[float]
1920
=== Node/client authentication and channel encryption
2021

21-
{security} supports configuring SSL/TLS for securing the communication channels
22-
to, from and within the cluster. This support accounts for:
22+
The {security-features} support configuring SSL/TLS for securing the
23+
communication channels to, from and within the cluster. This support accounts for:
2324

2425
* Encryption of data transmitted over the wires
2526
* Certificate based node authentication - preventing unauthorized nodes/clients
2627
from establishing a connection with the cluster.
2728

2829
For more information, see <<encrypting-communications, Encrypting Communications>>.
2930

30-
{security} also enables you to <<ip-filtering, configure IP Filters>> which can
31-
be seen as a light mechanism for node/client authentication. With IP Filtering
32-
you can restrict the nodes and clients that can connect to the cluster based
33-
on their IP addresses. The IP filters configuration provides whitelisting
34-
and blacklisting of IPs, subnets and DNS domains.
31+
The {security-features} also enable you to <<ip-filtering, configure IP Filters>>
32+
which can be seen as a light mechanism for node/client authentication. With IP
33+
filtering, you can restrict the nodes and clients that can connect to the
34+
cluster based on their IP addresses. The IP filters configuration provides
35+
whitelisting and blacklisting of IPs, subnets and DNS domains.
3536

3637

3738
[float]
@@ -41,9 +42,9 @@ mechanism set in place. Audit trails log various activities/events that occur in
4142
the system, enabling you to analyze and back track past events when things go
4243
wrong (e.g. security breach).
4344

44-
{security} provides such audit trail functionality for all nodes in the cluster.
45-
You can configure the audit level which accounts for the type of events that are
46-
logged. These events include failed authentication attempts, user access denied,
47-
node connection denied, and more.
45+
The {security-features} provide such audit trail functionality for all nodes in
46+
the cluster. You can configure the audit level which accounts for the type of
47+
events that are logged. These events include failed authentication attempts,
48+
user access denied, node connection denied, and more.
4849

4950
For more information on auditing see <<auditing>>.

docs/en/stack/security/index.asciidoc

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

55
[partintro]
66
--
7-
{security} enables you to easily secure a cluster. With {security},
8-
you can password-protect your data as well as implement more advanced security
7+
The {stack-security-features} enable you to easily secure a cluster. You can
8+
password-protect your data as well as implement more advanced security
99
measures such as encrypting communications, role-based access control,
1010
IP filtering, and auditing. This guide describes how to configure the security
1111
features you need, and interact with your secured cluster.
@@ -21,53 +21,53 @@ Security protects Elasticsearch clusters by:
2121

2222
[float]
2323
[[preventing-unauthorized-access]]
24-
=== Preventing Unauthorized Access
24+
=== Preventing unauthorized access
2525

2626
To prevent unauthorized access to your Elasticsearch cluster, you must have a
2727
way to _authenticate_ users. This simply means that you need a way to validate
2828
that a user is who they claim to be. For example, you have to make sure only
29-
the person named _Kelsey Andorra_ can sign in as the user `kandorra`. {security}
30-
provides a standalone authentication mechanism that enables you to
31-
quickly password-protect your cluster. If you're already using <<ldap-realm, LDAP>>,
32-
<<active-directory-realm, Active Directory>>, or <<pki-realm, PKI>> to manage
33-
users in your organization, {security} is able to integrate with those
34-
systems to perform user authentication.
29+
the person named _Kelsey Andorra_ can sign in as the user `kandorra`. The
30+
{es-security-features} provide a standalone authentication mechanism that enables
31+
you to quickly password-protect your cluster. If you're already using
32+
<<ldap-realm, LDAP>>, <<active-directory-realm, Active Directory>>, or
33+
<<pki-realm, PKI>> to manage users in your organization, the {security-features}
34+
are able to integrate with those systems to perform user authentication.
3535

3636
In many cases, simply authenticating users isn't enough. You also need a way to
37-
control what data users have access to and what tasks they can perform. {security}
38-
enables you to _authorize_ users by assigning access _privileges_ to _roles_,
39-
and assigning those roles to users. For example, this
37+
control what data users have access to and what tasks they can perform. The
38+
{es-security-features} enable you to _authorize_ users by assigning access
39+
_privileges_ to _roles_ and assigning those roles to users. For example, this
4040
<<authorization,role-based access control>> mechanism (a.k.a RBAC) enables
4141
you to specify that the user `kandorra` can only perform read operations on the
4242
`events` index and can't do anything at all with other indices.
4343

44-
{security} also supports <<ip-filtering, IP-based authorization>>. You can
45-
whitelist and blacklist specific IP addresses or subnets to control network-level
46-
access to a server.
44+
The {security-features} also support <<ip-filtering, IP-based authorization>>.
45+
You can whitelist and blacklist specific IP addresses or subnets to control
46+
network-level access to a server.
4747

4848
[float]
4949
[[preserving-data-integrity]]
50-
=== Preserving Data Integrity
50+
=== Preserving data integrity
5151

5252
A critical part of security is keeping confidential data confidential.
5353
Elasticsearch has built-in protections against accidental data loss and
5454
corruption. However, there's nothing to stop deliberate tampering or data
55-
interception. {security} preserves the integrity of your data by
56-
<<ssl-tls, encrypting communications>> to and from nodes.
57-
For even greater protection, you can increase the <<ciphers, encryption strength>> and
55+
interception. The {stack-security-features} preserve the integrity of your
56+
data by <<ssl-tls, encrypting communications>> to and from nodes. For even
57+
greater protection, you can increase the <<ciphers, encryption strength>> and
5858
<<separating-node-client-traffic, separate client traffic from node-to-node communications>>.
5959

6060

6161
[float]
6262
[[maintaining-audit-trail]]
63-
=== Maintaining an Audit Trail
63+
=== Maintaining an audit trail
6464

65-
Keeping a system secure takes vigilance. By using {security} to maintain
66-
an audit trail, you can easily see who is accessing your cluster and what they're
67-
doing. By analyzing access patterns and failed attempts to access your cluster,
68-
you can gain insights into attempted attacks and data breaches. Keeping an
69-
auditable log of the activity in your cluster can also help diagnose operational
70-
issues.
65+
Keeping a system secure takes vigilance. By using {stack-security-features} to
66+
maintain an audit trail, you can easily see who is accessing your cluster and
67+
what they're doing. By analyzing access patterns and failed attempts to access
68+
your cluster, you can gain insights into attempted attacks and data breaches.
69+
Keeping an auditable log of the activity in your cluster can also help diagnose
70+
operational issues.
7171

7272
[float]
7373
=== Where to Go Next
@@ -80,8 +80,8 @@ issues.
8080
authorization, and encryption.
8181

8282
* <<ccs-tribe-clients-integrations>>
83-
shows you how to interact with an Elasticsearch cluster protected by
84-
{security}.
83+
shows you how to interact with an Elasticsearch cluster protected by the
84+
{stack-security-features}.
8585

8686
[float]
8787
=== Have Comments, Questions, or Feedback?

docs/en/stack/security/limitations.asciidoc

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ Elasticsearch's plugin infrastructure is extremely flexible in terms of what can
99
be extended. While it opens up Elasticsearch to a wide variety of (often custom)
1010
additional functionality, when it comes to security, this high extensibility level
1111
comes at a cost. We have no control over the third-party plugins' code (open
12-
source or not) and therefore we cannot guarantee their compliance with {security}.
13-
For this reason, third-party plugins are not officially supported on clusters
14-
with {security-features} enabled.
12+
source or not) and therefore we cannot guarantee their compliance with
13+
{stack-security-features}. For this reason, third-party plugins are not
14+
officially supported on clusters with {security-features} enabled.
1515

1616
[float]
1717
=== Changes in index wildcard behavior
@@ -34,8 +34,10 @@ authorized to know anything about those indices.
3434
=== Filtered index aliases
3535

3636
Aliases containing filters are not a secure way to restrict access to individual
37-
documents, due to the limitations described in <<alias-limitations, Index and Field Names Can Be Leaked When Using Aliases>>.
38-
{security} provides a secure way to restrict access to documents through the
37+
documents, due to the limitations described in
38+
<<alias-limitations, Index and field names can be leaked when using aliases>>.
39+
The {stack-security-features} provide a secure way to restrict access to
40+
documents through the
3941
<<field-and-document-access-control, document-level security>> feature.
4042

4143
[float]

0 commit comments

Comments
 (0)