Skip to content

Commit c1e259d

Browse files
committed
[DOCS] Fixes title capitalization in security content
1 parent 0f70812 commit c1e259d

30 files changed

+101
-72
lines changed

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

Lines changed: 26 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1+
[role="xpack"]
12
[[auditing]]
2-
== Auditing Security Events
3+
== Auditing security events
34

45
You can enable auditing to keep track of security-related events such as
56
authentication failures and refused connections. Logging these events enables you
@@ -40,7 +41,7 @@ events are pushed to the index by setting
4041

4142
[float]
4243
[[audit-event-types]]
43-
=== Audit Event Types
44+
=== Audit event types
4445

4546
Each request may generate multiple audit events.
4647
The following is a list of the events that can be generated:
@@ -81,11 +82,11 @@ The following is a list of the events that can be generated:
8182

8283
[float]
8384
[[audit-event-attributes]]
84-
=== Audit Event Attributes
85+
=== Audit event attributes
8586

8687
The following table shows the common attributes that can be associated with every event.
8788

88-
.Common Attributes
89+
.Common attributes
8990
[cols="2,7",options="header"]
9091
|======
9192
| Attribute | Description
@@ -103,7 +104,7 @@ The following table shows the common attributes that can be associated with ever
103104
The following tables show the attributes that can be associated with each type of event.
104105
The log level determines which attributes are included in a log entry.
105106

106-
.REST anonymous_access_denied Attributes
107+
.REST anonymous_access_denied attributes
107108
[cols="2,7",options="header"]
108109
|======
109110
| Attribute | Description
@@ -112,7 +113,7 @@ The log level determines which attributes are included in a log entry.
112113
| `request_body` | The body of the request, if enabled.
113114
|======
114115

115-
.REST authentication_success Attributes
116+
.REST authentication_success attributes
116117
[cols="2,7",options="header"]
117118
|======
118119
| Attribute | Description
@@ -123,7 +124,7 @@ The log level determines which attributes are included in a log entry.
123124
| `request_body` | The body of the request, if enabled.
124125
|======
125126

126-
.REST authentication_failed Attributes
127+
.REST authentication_failed attributes
127128
[cols="2,7",options="header"]
128129
|======
129130
| Attribute | Description
@@ -133,7 +134,7 @@ The log level determines which attributes are included in a log entry.
133134
| `request_body` | The body of the request, if enabled.
134135
|======
135136

136-
.REST realm_authentication_failed Attributes
137+
.REST realm_authentication_failed attributes
137138
[cols="2,7",options="header"]
138139
|======
139140
| Attribute | Description
@@ -146,7 +147,7 @@ The log level determines which attributes are included in a log entry.
146147
consulted realm.
147148
|======
148149

149-
.Transport anonymous_access_denied Attributes
150+
.Transport anonymous_access_denied attributes
150151
[cols="2,7",options="header"]
151152
|======
152153
| Attribute | Description
@@ -161,7 +162,7 @@ The log level determines which attributes are included in a log entry.
161162
pertains to (when applicable).
162163
|======
163164

164-
.Transport authentication_success Attributes
165+
.Transport authentication_success attributes
165166
[cols="2,7",options="header"]
166167
|======
167168
| Attribute | Description
@@ -176,7 +177,7 @@ The log level determines which attributes are included in a log entry.
176177
| `request` | The type of request that was executed.
177178
|======
178179

179-
.Transport authentication_failed Attributes
180+
.Transport authentication_failed attributes
180181
[cols="2,7",options="header"]
181182
|======
182183
| Attribute | Description
@@ -192,7 +193,7 @@ The log level determines which attributes are included in a log entry.
192193
pertains to (when applicable).
193194
|======
194195

195-
.Transport realm_authentication_failed Attributes
196+
.Transport realm_authentication_failed attributes
196197
[cols="2,7",options="header"]
197198
|======
198199
| Attribute | Description
@@ -211,7 +212,7 @@ The log level determines which attributes are included in a log entry.
211212
consulted realm.
212213
|======
213214

214-
.Transport access_granted Attributes
215+
.Transport access_granted attributes
215216
[cols="2,7",options="header"]
216217
|======
217218
| Attribute | Description
@@ -228,7 +229,7 @@ The log level determines which attributes are included in a log entry.
228229
pertains to (when applicable).
229230
|======
230231

231-
.Transport access_denied Attributes
232+
.Transport access_denied attributes
232233
[cols="2,7",options="header"]
233234
|======
234235
| Attribute | Description
@@ -245,7 +246,7 @@ The log level determines which attributes are included in a log entry.
245246
relates to (when applicable).
246247
|======
247248

248-
.Transport tampered_request Attributes
249+
.Transport tampered_request attributes
249250
[cols="2,7",options="header"]
250251
|======
251252
| Attribute | Description
@@ -261,7 +262,7 @@ The log level determines which attributes are included in a log entry.
261262
pertains to (when applicable).
262263
|======
263264

264-
.IP Filter connection_granted Attributes
265+
.IP filter connection_granted attributes
265266
[cols="2,7",options="header"]
266267
|======
267268
| Attribute | Description
@@ -271,7 +272,7 @@ The log level determines which attributes are included in a log entry.
271272
the request.
272273
|======
273274

274-
.IP Filter connection_denied Attributes
275+
.IP filter connection_denied attributes
275276
[cols="2,7",options="header"]
276277
|======
277278
| Attribute | Description
@@ -283,14 +284,14 @@ The log level determines which attributes are included in a log entry.
283284

284285
[float]
285286
[[audit-log-output]]
286-
=== Logfile Audit Output
287+
=== Logfile audit output
287288

288289
The `logfile` audit output is the default output for auditing. It writes data to
289290
the `<clustername>_access.log` file in the logs directory.
290291

291292
[float]
292293
[[audit-log-entry-format]]
293-
=== Log Entry Format
294+
=== Log entry format
294295

295296
The format of a log entry is:
296297

@@ -318,7 +319,7 @@ The format of a log entry is:
318319

319320
[float]
320321
[[audit-log-settings]]
321-
=== Logfile Output Settings
322+
=== Logfile output settings
322323

323324
The events and some other information about what gets logged can be
324325
controlled using settings in the `elasticsearch.yml` file. See
@@ -336,7 +337,7 @@ file located in `CONFIG_DIR`. By default, audit information is appended to the
336337

337338
[float]
338339
[[audit-log-ignore-policy]]
339-
=== Logfile Audit Events Ignore Policies
340+
=== Logfile audit events ignore policies
340341

341342
The comprehensive audit trail is necessary to ensure accountability. It offers tremendous
342343
value during incident response and can even be required for demonstrating compliance.
@@ -414,7 +415,7 @@ xpack.security.audit.logfile.events.ignore_filters:
414415

415416
[float]
416417
[[audit-index]]
417-
=== Index Audit Output
418+
=== Index audit output
418419

419420
In addition to logging to a file, you can store audit logs in Elasticsearch
420421
rolling indices. These indices can be either on the same cluster, or on a
@@ -429,13 +430,13 @@ xpack.security.audit.outputs: [ index, logfile ]
429430
----------------------------
430431

431432
For more configuration options, see
432-
{ref}/auditing-settings.html#index-audit-settings[Audit Log Indexing Configuration Settings].
433+
{ref}/auditing-settings.html#index-audit-settings[Audit log indexing configuration settings].
433434

434435
IMPORTANT: No filtering is performed when auditing, so sensitive data may be
435436
audited in plain text when including the request body in audit events.
436437

437438
[float]
438-
==== Audit Index Settings
439+
==== Audit index settings
439440

440441
You can also configure settings for the indices that the events are stored in.
441442
These settings are configured in the `xpack.security.audit.index.settings` namespace
@@ -451,7 +452,7 @@ xpack.security.audit.index.settings:
451452
----------------------------
452453

453454
[float]
454-
==== Forwarding Audit Logs to a Remote Cluster
455+
==== Forwarding audit logs to a remote cluster
455456

456457
To index audit events to a remote Elasticsearch cluster, you configure
457458
the following `xpack.security.audit.index.client` settings:

x-pack/docs/en/security/authentication/active-directory-realm.asciidoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
[role="xpack"]
12
[[active-directory-realm]]
23
=== Active Directory user authentication
34

x-pack/docs/en/security/authentication/anonymous-access.asciidoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1+
[role="xpack"]
12
[[anonymous-access]]
2-
=== Enabling Anonymous Access
3+
=== Enabling anonymous access
34

45
Incoming requests are considered to be _anonymous_ if no authentication token
56
can be extracted from the incoming request. By default, anonymous requests are rejected and an authentication error is returned (status code `401`).

x-pack/docs/en/security/authentication/built-in-users.asciidoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
[role="xpack"]
12
[[built-in-users]]
23
=== Built-in users
34

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

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
1+
[role="xpack"]
12
[[custom-realms]]
2-
=== Integrating with Other Authentication Systems
3+
=== Integrating with other authentication systems
34

45
If you are using an authentication system that is not supported out-of-the-box
56
by {security}, you can create a custom realm to interact with it to authenticate
67
users. You implement a custom realm as an SPI loaded security extension
78
as part of an ordinary elasticsearch plugin.
89

910
[[implementing-custom-realm]]
10-
==== Implementing a Custom Realm
11+
==== Implementing a custom realm
1112

1213
Sample code that illustrates the structure and implementation of a custom realm
1314
is provided in the https://github.com/elastic/shield-custom-realm-example[custom-realm-example]
@@ -70,7 +71,7 @@ part of the `SecurityExtension` interface, it's available as part of the elastic
7071
. Bundle all in a single zip file.
7172

7273
[[using-custom-realm]]
73-
==== Using a Custom Realm to Authenticate Users
74+
==== Using a custom realm to authenticate users
7475

7576
To use a custom realm:
7677

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
[role="xpack"]
12
[[file-realm]]
23
=== File-based user authentication
34

x-pack/docs/en/security/authentication/internal-users.asciidoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
[role="xpack"]
12
[[internal-users]]
23
=== Internal users
34

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
[role="xpack"]
12
[[ldap-realm]]
23
=== LDAP user authentication
34

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
[role="xpack"]
12
[[native-realm]]
23
=== Native user authentication
34

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
[role="xpack"]
12
[[setting-up-authentication]]
23
== User authentication
34

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
[role="xpack"]
12
[[pki-realm]]
23
=== PKI user authentication
34

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
[role="xpack"]
12
[[realms]]
23
=== Realms
34

x-pack/docs/en/security/authentication/saml-guide.asciidoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
1+
[role="xpack"]
12
[[saml-guide]]
23

3-
== Configuring SAML single-sign-on on the Elastic Stack
4+
== Configuring SAML single-sign-on on the {stack}
45

56
The Elastic Stack supports SAML single-sign-on (SSO) into {kib}, using {es} as
67
a backend service. In SAML terminology, the Elastic Stack is operating as a

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
[role="xpack"]
12
[[saml-realm]]
23
=== SAML authentication
34
{security} supports user authentication using SAML Single Sign On.

x-pack/docs/en/security/authentication/user-cache.asciidoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1+
[role="xpack"]
12
[[controlling-user-cache]]
2-
=== Controlling the User Cache
3+
=== Controlling the user cache
34

45
User credentials are cached in memory on each node to avoid connecting to a
56
remote authentication service or hitting the disk for every incoming request.
@@ -34,7 +35,7 @@ setting the `cache_hash_algo` setting to any of the following:
3435
|=======================
3536

3637
[[cache-eviction-api]]
37-
==== Evicting Users from the Cache
38+
==== Evicting users from the cache
3839

3940
{security} exposes a
4041
{ref}/security-api-clear-cache.html[Clear Cache API] you can use

x-pack/docs/en/security/authorization/alias-privileges.asciidoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1+
[role="xpack"]
12
[[securing-aliases]]
2-
=== Granting Privileges for Indices & Aliases
3+
=== Granting privileges for indices and aliases
34

45
Elasticsearch allows to execute operations against {ref}/indices-aliases.html[index aliases],
56
which are effectively virtual indices. An alias points to one or more indices,

x-pack/docs/en/security/authorization/custom-roles-provider.asciidoc

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
1+
[role="xpack"]
12
[[custom-roles-provider]]
2-
=== Custom Roles Provider Extension
3+
=== Custom roles provider extension
34

45
If you need to retrieve user roles from a system not supported out-of-the-box
56
by {security}, you can create a custom roles provider to retrieve and resolve
67
roles. You implement a custom roles provider as an SPI loaded security extension
78
as part of an ordinary elasticsearch plugin.
89

910
[[implementing-custom-roles-provider]]
10-
==== Implementing a Custom Roles Provider
11+
==== Implementing a custom roles provider
1112

1213
To create a custom roles provider:
1314

@@ -62,7 +63,7 @@ part of the `SecurityExtension` interface, it's available as part of the elastic
6263
. Bundle all in a single zip file.
6364

6465
[[using-custom-roles-provider]]
65-
==== Using a Custom Roles Provider to Resolve Roles
66+
==== Using a custom roles provider to resolve roles
6667

6768
To use a custom roles provider:
6869

0 commit comments

Comments
 (0)