Skip to content

Commit f7edcb0

Browse files
authored
[DOCS] Fixes build errors (#47536)
1 parent f95753a commit f7edcb0

23 files changed

+40
-133
lines changed

docs/reference/index.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ include::data-rollup-transform.asciidoc[]
5050

5151
include::high-availability.asciidoc[]
5252

53-
include::security/index.asciidoc[]
53+
include::{xes-repo-dir}/security/index.asciidoc[]
5454

5555
include::{xes-repo-dir}/watcher/index.asciidoc[]
5656

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
@@ -18,7 +18,7 @@ The following is a list of the events that can be generated:
1818
realm type.
1919
| `access_denied` | | | Logged when an authenticated user attempts to execute
2020
an action they do not have the necessary
21-
<<security-reference, privilege>> to perform.
21+
<<security-privileges,privilege>> to perform.
2222
| `access_granted` | | | Logged when an authenticated user attempts to execute
2323
an action they have the necessary privilege to perform.
2424
When the `system_access_granted` event is included, all system
@@ -28,7 +28,7 @@ The following is a list of the events that can be generated:
2828
another user that they have the necessary privileges to do.
2929
| `run_as_denied` | | | Logged when an authenticated user attempts to <<run-as-privilege, run as>>
3030
another user action they do not have the necessary
31-
<<security-reference, privilege>> to do so.
31+
<<security-privileges,privilege>> to do so.
3232
| `tampered_request` | | | Logged when the {security-features} detect that the request has
3333
been tampered with. Typically relates to `search/scroll`
3434
requests when the scroll ID is believed to have been

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

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,8 @@ include::native-realm.asciidoc[]
1212
include::pki-realm.asciidoc[]
1313
include::saml-realm.asciidoc[]
1414
include::kerberos-realm.asciidoc[]
15-
16-
include::{xes-repo-dir}/security/authentication/custom-realm.asciidoc[]
17-
18-
include::{xes-repo-dir}/security/authentication/anonymous-access.asciidoc[]
19-
20-
include::{xes-repo-dir}/security/authentication/user-cache.asciidoc[]
21-
22-
include::{xes-repo-dir}/security/authentication/saml-guide.asciidoc[]
23-
24-
include::{xes-repo-dir}/security/authentication/oidc-guide.asciidoc[]
15+
include::custom-realm.asciidoc[]
16+
include::anonymous-access.asciidoc[]
17+
include::user-cache.asciidoc[]
18+
include::saml-guide.asciidoc[]
19+
include::oidc-guide.asciidoc[]

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,22 +3,22 @@ include::overview.asciidoc[]
33

44
include::built-in-roles.asciidoc[]
55

6-
include::{xes-repo-dir}/security/authorization/managing-roles.asciidoc[]
6+
include::managing-roles.asciidoc[]
77

88
include::privileges.asciidoc[]
99

1010
include::document-level-security.asciidoc[]
1111

1212
include::field-level-security.asciidoc[]
1313

14-
include::{xes-repo-dir}/security/authorization/alias-privileges.asciidoc[]
14+
include::alias-privileges.asciidoc[]
1515

16-
include::{xes-repo-dir}/security/authorization/mapping-roles.asciidoc[]
16+
include::mapping-roles.asciidoc[]
1717

18-
include::{xes-repo-dir}/security/authorization/field-and-document-access-control.asciidoc[]
18+
include::field-and-document-access-control.asciidoc[]
1919

20-
include::{xes-repo-dir}/security/authorization/run-as-privilege.asciidoc[]
20+
include::run-as-privilege.asciidoc[]
2121

2222
include::configuring-authorization-delegation.asciidoc[]
2323

24-
include::{xes-repo-dir}/security/authorization/custom-authorization.asciidoc[]
24+
include::custom-authorization.asciidoc[]

x-pack/docs/en/security/ccs-clients-integrations/monitoring.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[[secure-monitoring]]
22
=== Monitoring and security
33

4-
The <<xpack-monitoring,{stack} {monitor-features}>> consist of two components:
4+
The {stack} {monitor-features} consist of two components:
55
an agent that you install on on each {es} and Logstash node, and a Monitoring UI
66
in {kib}. The monitoring agent collects and indexes metrics from the nodes
77
and you visualize the data through the Monitoring dashboards in {kib}. The agent

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -139,11 +139,11 @@ Events are logged to a dedicated `<clustername>_audit.json` file in
139139
To walk through the configuration of {security-features} in {es}, {kib}, {ls}, and {metricbeat}, see
140140
{stack-ov}/security-getting-started.html[Getting started with security].
141141

142-
include::{es-repo-dir}/security/securing-communications/securing-elasticsearch.asciidoc[]
142+
include::securing-communications/securing-elasticsearch.asciidoc[]
143143

144-
include::{es-repo-dir}/security/securing-communications/configuring-tls-docker.asciidoc[]
144+
include::securing-communications/configuring-tls-docker.asciidoc[]
145145

146-
include::{es-repo-dir}/security/securing-communications/enabling-cipher-suites.asciidoc[]
146+
include::securing-communications/enabling-cipher-suites.asciidoc[]
147147

148148
include::authentication/configuring-active-directory-realm.asciidoc[]
149149
include::authentication/configuring-file-realm.asciidoc[]
@@ -154,6 +154,6 @@ include::authentication/configuring-saml-realm.asciidoc[]
154154

155155
include::authentication/configuring-kerberos-realm.asciidoc[]
156156

157-
include::{es-repo-dir}/security/reference/files.asciidoc[]
157+
include::reference/files.asciidoc[]
158158
include::fips-140-compliance.asciidoc[]
159159

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,8 @@ IMPORTANT: To complete this tutorial, you must install the default {es} and
1919
authentication {security-features}. When you install these products, they apply
2020
basic licenses with no expiration dates. All of the subsequent steps in this
2121
tutorial assume that you are using a basic license. For more information, see
22-
{subscriptions} and <<license-management>>.
22+
{subscriptions} and
23+
{stack-ov}/license-management.html[License-management].
2324

2425
--
2526

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

Lines changed: 11 additions & 82 deletions
Original file line numberDiff line numberDiff line change
@@ -1,93 +1,22 @@
1-
[role="xpack"]
2-
[[elasticsearch-security]]
3-
= Securing the {stack}
1+
[[secure-cluster]]
2+
= Secure a cluster
43

54
[partintro]
65
--
76
The {stack-security-features} enable you to easily secure a cluster. You can
87
password-protect your data as well as implement more advanced security
98
measures such as encrypting communications, role-based access control,
10-
IP filtering, and auditing. This guide describes how to configure the security
11-
features you need, and interact with your secured cluster.
12-
13-
Security protects Elasticsearch clusters by:
14-
15-
* <<preventing-unauthorized-access, Preventing unauthorized access>>
16-
with password protection, role-based access control, and IP filtering.
17-
* <<preserving-data-integrity, Preserving the integrity of your data>>
18-
with message authentication and SSL/TLS encryption.
19-
* <<maintaining-audit-trail, Maintaining an audit trail>>
20-
so you know who's doing what to your cluster and the data it stores.
21-
22-
[float]
23-
[[preventing-unauthorized-access]]
24-
=== Preventing unauthorized access
25-
26-
To prevent unauthorized access to your Elasticsearch cluster, you must have a
27-
way to _authenticate_ users. This simply means that you need a way to validate
28-
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`. 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.
35-
36-
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. 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
40-
<<authorization,role-based access control>> mechanism (a.k.a RBAC) enables
41-
you to specify that the user `kandorra` can only perform read operations on the
42-
`events` index and can't do anything at all with other indices.
43-
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.
47-
48-
[float]
49-
[[preserving-data-integrity]]
50-
=== Preserving data integrity
51-
52-
A critical part of security is keeping confidential data confidential.
53-
Elasticsearch has built-in protections against accidental data loss and
54-
corruption. However, there's nothing to stop deliberate tampering or data
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 {ref}/ciphers.html[encryption strength].
58-
59-
[float]
60-
[[maintaining-audit-trail]]
61-
=== Maintaining an audit trail
62-
63-
Keeping a system secure takes vigilance. By using {stack-security-features} to
64-
maintain an audit trail, you can easily see who is accessing your cluster and
65-
what they're doing. By analyzing access patterns and failed attempts to access
66-
your cluster, you can gain insights into attempted attacks and data breaches.
67-
Keeping an auditable log of the activity in your cluster can also help diagnose
68-
operational issues.
69-
70-
[float]
71-
=== Where to Go Next
72-
73-
* <<security-getting-started, Getting Started>>
74-
steps through how to install and start using Security for basic authentication.
75-
76-
* <<how-security-works, How Security Works>>
77-
provides more information about how Security supports user authentication,
78-
authorization, and encryption.
79-
80-
* <<ccs-clients-integrations>>
81-
shows you how to interact with an Elasticsearch cluster protected by the
82-
{stack-security-features}.
83-
84-
[float]
85-
=== Have Comments, Questions, or Feedback?
86-
87-
Head over to our {security-forum}[Security Discussion Forum]
88-
to share your experience, questions, and suggestions.
9+
IP filtering, and auditing.
10+
11+
* <<elasticsearch-security>>
12+
* <<configuring-security>>
13+
8914
--
9015

16+
include::overview.asciidoc[]
17+
18+
include::configuring-es.asciidoc[]
19+
9120
include::how-security-works.asciidoc[]
9221

9322
include::authentication/index.asciidoc[]
File renamed without changes.

0 commit comments

Comments
 (0)