Skip to content

Commit 57885f3

Browse files
[Backport][9.0][DOCS] Restructure user settings reference pages (#125194)
* add signposts to docs-content (#124866) * [DOCS] Restructure user settings reference pages (#125000) * add elasticsearch settings page * add logo to ech applicable settings * removing ECH settings page * removing duplicate information from ECH * move settings to correcponding page * update configuration page * fix link * Add applies_to frontmatter to auditing settings * remove duplicate how-to pages * fix broken links * replce cloud icon text * adjust settings pages * add applies_to tag --------- Co-authored-by: lcawl <[email protected]> --------- Co-authored-by: lcawl <[email protected]>
1 parent e2a2564 commit 57885f3

Some content is hidden

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

42 files changed

+460
-713
lines changed

docs/reference/elasticsearch-plugins/index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,12 @@ mapped_pages:
66

77
# Elasticsearch plugins [intro]
88

9+
:::{note}
10+
This section provides detailed **reference information** for Elasticsearch plugins.
11+
12+
Refer to [Add plugins and extensions](docs-content://deploy-manage/deploy/elastic-cloud/add-plugins-extensions.md) in the **Deploy and manage** section for overview, getting started and conceptual information.
13+
:::
14+
915
Plugins are a way to enhance the core Elasticsearch functionality in a custom manner. They range from adding custom mapping types, custom analyzers, native scripts, custom discovery and more.
1016

1117
Plugins contain JAR files, but may also contain scripts and config files, and must be installed on every node in the cluster. After installation, each node must be restarted before the plugin becomes visible.

docs/reference/elasticsearch/configuration-reference/auding-settings.md

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22
navigation_title: "Auditing settings"
33
mapped_pages:
44
- https://www.elastic.co/guide/en/elasticsearch/reference/current/auditing-settings.html
5+
applies_to:
6+
deployment:
7+
ess:
8+
self:
59
---
610

711
# Auditing security settings [auditing-settings]
@@ -20,7 +24,7 @@ If configured, auditing settings must be set on every node in the cluster. Stati
2024

2125
$$$xpack-security-audit-enabled$$$
2226

23-
`xpack.security.audit.enabled`
27+
`xpack.security.audit.enabled` ![logo cloud](https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg "Supported on Elastic Cloud Hosted")
2428
: ([Static](docs-content://deploy-manage/deploy/self-managed/configure-elasticsearch.md#static-cluster-setting)) Set to `true` to enable auditing on the node. The default value is `false`. This puts the auditing events in a dedicated file named `<clustername>_audit.json` on each node.
2529

2630
If enabled, this setting must be configured in `elasticsearch.yml` on all nodes in the cluster.
@@ -33,17 +37,17 @@ The events and some other information about what gets logged can be controlled b
3337

3438
$$$xpack-sa-lf-events-include$$$
3539

36-
`xpack.security.audit.logfile.events.include`
40+
`xpack.security.audit.logfile.events.include` ![logo cloud](https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg "Supported on Elastic Cloud Hosted")
3741
: ([Dynamic](docs-content://deploy-manage/deploy/self-managed/configure-elasticsearch.md#dynamic-cluster-setting)) Specifies the [kind of events](/reference/elasticsearch/elasticsearch-audit-events.md) to print in the auditing output. In addition, `_all` can be used to exhaustively audit all the events, but this is usually discouraged since it will get very verbose. The default list value contains: `access_denied, access_granted, anonymous_access_denied, authentication_failed, connection_denied, tampered_request, run_as_denied, run_as_granted, security_config_change`.
3842

3943
$$$xpack-sa-lf-events-exclude$$$
4044

41-
`xpack.security.audit.logfile.events.exclude`
45+
`xpack.security.audit.logfile.events.exclude` ![logo cloud](https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg "Supported on Elastic Cloud Hosted")
4246
: ([Dynamic](docs-content://deploy-manage/deploy/self-managed/configure-elasticsearch.md#dynamic-cluster-setting)) Excludes the specified [kind of events](/reference/elasticsearch/elasticsearch-audit-events.md) from the include list. This is useful in the case where the `events.include` setting contains the special value `_all`. The default is the empty list.
4347

4448
$$$xpack-sa-lf-events-emit-request$$$
4549

46-
`xpack.security.audit.logfile.events.emit_request_body`
50+
`xpack.security.audit.logfile.events.emit_request_body` ![logo cloud](https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg "Supported on Elastic Cloud Hosted")
4751
: ([Dynamic](docs-content://deploy-manage/deploy/self-managed/configure-elasticsearch.md#dynamic-cluster-setting)) Specifies whether to include the full request body from REST requests as an attribute of certain kinds of audit events. This setting can be used to [audit search queries](docs-content://deploy-manage/monitor/logging-configuration/auditing-search-queries.md).
4852

4953
The default value is `false`, so request bodies are not printed.
@@ -58,22 +62,22 @@ $$$xpack-sa-lf-events-emit-request$$$
5862

5963
$$$xpack-sa-lf-emit-node-name$$$
6064

61-
`xpack.security.audit.logfile.emit_node_name`
65+
`xpack.security.audit.logfile.emit_node_name` ![logo cloud](https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg "Supported on Elastic Cloud Hosted")
6266
: ([Dynamic](docs-content://deploy-manage/deploy/self-managed/configure-elasticsearch.md#dynamic-cluster-setting)) Specifies whether to include the [node name](docs-content://deploy-manage/deploy/self-managed/important-settings-configuration.md#node-name) as a field in each audit event. The default value is `false`.
6367

6468
$$$xpack-sa-lf-emit-node-host-address$$$
6569

66-
`xpack.security.audit.logfile.emit_node_host_address`
70+
`xpack.security.audit.logfile.emit_node_host_address` ![logo cloud](https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg "Supported on Elastic Cloud Hosted")
6771
: ([Dynamic](docs-content://deploy-manage/deploy/self-managed/configure-elasticsearch.md#dynamic-cluster-setting)) Specifies whether to include the node’s IP address as a field in each audit event. The default value is `false`.
6872

6973
$$$xpack-sa-lf-emit-node-host-name$$$
7074

71-
`xpack.security.audit.logfile.emit_node_host_name`
75+
`xpack.security.audit.logfile.emit_node_host_name` ![logo cloud](https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg "Supported on Elastic Cloud Hosted")
7276
: ([Dynamic](docs-content://deploy-manage/deploy/self-managed/configure-elasticsearch.md#dynamic-cluster-setting)) Specifies whether to include the node’s host name as a field in each audit event. The default value is `false`.
7377

7478
$$$xpack-sa-lf-emit-node-id$$$
7579

76-
`xpack.security.audit.logfile.emit_node_id`
80+
`xpack.security.audit.logfile.emit_node_id` ![logo cloud](https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg "Supported on Elastic Cloud Hosted")
7781
: ([Dynamic](docs-content://deploy-manage/deploy/self-managed/configure-elasticsearch.md#dynamic-cluster-setting)) Specifies whether to include the node id as a field in each audit event. Unlike [node name](docs-content://deploy-manage/deploy/self-managed/important-settings-configuration.md#node-name), whose value might change if the administrator changes the setting in the config file, the node id will persist across cluster restarts and the administrator cannot change it. The default value is `true`.
7882

7983

@@ -83,27 +87,27 @@ The following settings affect the [ignore policies](docs-content://deploy-manage
8387

8488
$$$xpack-sa-lf-events-ignore-users$$$
8589

86-
`xpack.security.audit.logfile.events.ignore_filters.<policy_name>.users`
90+
`xpack.security.audit.logfile.events.ignore_filters.<policy_name>.users` ![logo cloud](https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg "Supported on Elastic Cloud Hosted")
8791
: ([Dynamic](docs-content://deploy-manage/deploy/self-managed/configure-elasticsearch.md#dynamic-cluster-setting)) A list of user names or wildcards. The specified policy will not print audit events for users matching these values.
8892

8993
$$$xpack-sa-lf-events-ignore-realms$$$
9094

91-
`xpack.security.audit.logfile.events.ignore_filters.<policy_name>.realms`
95+
`xpack.security.audit.logfile.events.ignore_filters.<policy_name>.realms` ![logo cloud](https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg "Supported on Elastic Cloud Hosted")
9296
: ([Dynamic](docs-content://deploy-manage/deploy/self-managed/configure-elasticsearch.md#dynamic-cluster-setting)) A list of authentication realm names or wildcards. The specified policy will not print audit events for users in these realms.
9397

9498
$$$xpack-sa-lf-events-ignore-actions$$$
9599

96-
`xpack.security.audit.logfile.events.ignore_filters.<policy_name>.actions`
100+
`xpack.security.audit.logfile.events.ignore_filters.<policy_name>.actions` ![logo cloud](https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg "Supported on Elastic Cloud Hosted")
97101
: ([Dynamic](docs-content://deploy-manage/deploy/self-managed/configure-elasticsearch.md#dynamic-cluster-setting)) A list of action names or wildcards. Action name can be found in the `action` field of the audit event. The specified policy will not print audit events for actions matching these values.
98102

99103
$$$xpack-sa-lf-events-ignore-roles$$$
100104

101-
`xpack.security.audit.logfile.events.ignore_filters.<policy_name>.roles`
105+
`xpack.security.audit.logfile.events.ignore_filters.<policy_name>.roles` ![logo cloud](https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg "Supported on Elastic Cloud Hosted")
102106
: ([Dynamic](docs-content://deploy-manage/deploy/self-managed/configure-elasticsearch.md#dynamic-cluster-setting)) A list of role names or wildcards. The specified policy will not print audit events for users that have these roles. If the user has several roles, some of which are **not** covered by the policy, the policy will **not** cover this event.
103107

104108
$$$xpack-sa-lf-events-ignore-indices$$$
105109

106-
`xpack.security.audit.logfile.events.ignore_filters.<policy_name>.indices`
110+
`xpack.security.audit.logfile.events.ignore_filters.<policy_name>.indices` ![logo cloud](https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg "Supported on Elastic Cloud Hosted")
107111
: ([Dynamic](docs-content://deploy-manage/deploy/self-managed/configure-elasticsearch.md#dynamic-cluster-setting)) A list of index names or wildcards. The specified policy will not print audit events when all the indices in the event match these values. If the event concerns several indices, some of which are **not** covered by the policy, the policy will **not** cover this event.
108112

109113

docs/reference/elasticsearch/configuration-reference/circuit-breaker-settings.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
---
22
mapped_pages:
33
- https://www.elastic.co/guide/en/elasticsearch/reference/current/circuit-breaker.html
4+
applies_to:
5+
deployment:
6+
ess:
7+
self:
48
---
59

610
# Circuit breaker settings [circuit-breaker]
@@ -26,7 +30,7 @@ The parent-level breaker can be configured with the following settings:
2630

2731
$$$indices-breaker-total-limit$$$
2832

29-
`indices.breaker.total.limit` ![logo cloud](https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg "Supported on {{ess}}")
33+
`indices.breaker.total.limit` ![logo cloud](https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg "Supported on Elastic Cloud Hosted")
3034
: ([Dynamic](docs-content://deploy-manage/deploy/self-managed/configure-elasticsearch.md#dynamic-cluster-setting)) Starting limit for overall parent breaker. Defaults to 70% of JVM heap if `indices.breaker.total.use_real_memory` is `false`. If `indices.breaker.total.use_real_memory` is `true`, defaults to 95% of the JVM heap.
3135

3236

@@ -36,12 +40,12 @@ The field data circuit breaker estimates the heap memory required to load a fiel
3640

3741
$$$fielddata-circuit-breaker-limit$$$
3842

39-
`indices.breaker.fielddata.limit` ![logo cloud](https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg "Supported on {{ess}}")
43+
`indices.breaker.fielddata.limit` ![logo cloud](https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg "Supported on Elastic Cloud Hosted")
4044
: ([Dynamic](docs-content://deploy-manage/deploy/self-managed/configure-elasticsearch.md#dynamic-cluster-setting)) Limit for fielddata breaker. Defaults to 40% of JVM heap.
4145

4246
$$$fielddata-circuit-breaker-overhead$$$
4347

44-
`indices.breaker.fielddata.overhead` ![logo cloud](https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg "Supported on {{ess}}")
48+
`indices.breaker.fielddata.overhead` ![logo cloud](https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg "Supported on Elastic Cloud Hosted")
4549
: ([Dynamic](docs-content://deploy-manage/deploy/self-managed/configure-elasticsearch.md#dynamic-cluster-setting)) A constant that all field data estimations are multiplied with to determine a final estimation. Defaults to `1.03`.
4650

4751

@@ -51,12 +55,12 @@ The request circuit breaker allows Elasticsearch to prevent per-request data str
5155

5256
$$$request-breaker-limit$$$
5357

54-
`indices.breaker.request.limit` ![logo cloud](https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg "Supported on {{ess}}")
58+
`indices.breaker.request.limit` ![logo cloud](https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg "Supported on Elastic Cloud Hosted")
5559
: ([Dynamic](docs-content://deploy-manage/deploy/self-managed/configure-elasticsearch.md#dynamic-cluster-setting)) Limit for request breaker, defaults to 60% of JVM heap.
5660

5761
$$$request-breaker-overhead$$$
5862

59-
`indices.breaker.request.overhead` ![logo cloud](https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg "Supported on {{ess}}")
63+
`indices.breaker.request.overhead` ![logo cloud](https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg "Supported on Elastic Cloud Hosted")
6064
: ([Dynamic](docs-content://deploy-manage/deploy/self-managed/configure-elasticsearch.md#dynamic-cluster-setting)) A constant that all request estimations are multiplied with to determine a final estimation. Defaults to `1`.
6165

6266

@@ -89,7 +93,7 @@ Poorly written regular expressions can degrade cluster stability and performance
8993

9094
$$$script-painless-regex-enabled$$$
9195

92-
`script.painless.regex.enabled`
96+
`script.painless.regex.enabled` ![logo cloud](https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg "Supported on Elastic Cloud Hosted")
9397
: ([Static](docs-content://deploy-manage/deploy/self-managed/configure-elasticsearch.md#static-cluster-setting)) Enables regex in Painless scripts. Accepts:
9498

9599
`limited` (Default)

docs/reference/elasticsearch/configuration-reference/cluster-level-shard-allocation-routing-settings.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
---
22
mapped_pages:
33
- https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-cluster.html
4+
applies_to:
5+
deployment:
6+
ess:
7+
self:
48
---
59

610
# Cluster-level shard allocation and routing settings [modules-cluster]
@@ -165,20 +169,20 @@ You can use the following settings to control disk-based allocation:
165169

166170
$$$cluster-routing-disk-threshold$$$
167171

168-
`cluster.routing.allocation.disk.threshold_enabled`
172+
`cluster.routing.allocation.disk.threshold_enabled` ![logo cloud](https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg "Supported on Elastic Cloud Hosted")
169173
: ([Dynamic](docs-content://deploy-manage/deploy/self-managed/configure-elasticsearch.md#dynamic-cluster-setting)) Defaults to `true`. Set to `false` to disable the disk allocation decider. Upon disabling, it will also remove any existing `index.blocks.read_only_allow_delete` index blocks.
170174

171175
$$$cluster-routing-watermark-low$$$
172176

173-
`cluster.routing.allocation.disk.watermark.low` ![logo cloud](https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg "Supported on {{ess}}")
177+
`cluster.routing.allocation.disk.watermark.low` ![logo cloud](https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg "Supported on Elastic Cloud Hosted")
174178
: ([Dynamic](docs-content://deploy-manage/deploy/self-managed/configure-elasticsearch.md#dynamic-cluster-setting)) Controls the low watermark for disk usage. It defaults to `85%`, meaning that {{es}} will not allocate shards to nodes that have more than 85% disk used. It can alternatively be set to a ratio value, e.g., `0.85`. It can also be set to an absolute byte value (like `500mb`) to prevent {{es}} from allocating shards if less than the specified amount of space is available. This setting has no effect on the primary shards of newly-created indices but will prevent their replicas from being allocated.
175179

176180
`cluster.routing.allocation.disk.watermark.low.max_headroom`
177181
: ([Dynamic](docs-content://deploy-manage/deploy/self-managed/configure-elasticsearch.md#dynamic-cluster-setting)) Controls the max headroom for the low watermark (in case of a percentage/ratio value). Defaults to 200GB when `cluster.routing.allocation.disk.watermark.low` is not explicitly set. This caps the amount of free space required.
178182

179183
$$$cluster-routing-watermark-high$$$
180184

181-
`cluster.routing.allocation.disk.watermark.high` ![logo cloud](https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg "Supported on {{ess}}")
185+
`cluster.routing.allocation.disk.watermark.high` ![logo cloud](https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg "Supported on Elastic Cloud Hosted")
182186
: ([Dynamic](docs-content://deploy-manage/deploy/self-managed/configure-elasticsearch.md#dynamic-cluster-setting)) Controls the high watermark. It defaults to `90%`, meaning that {{es}} will attempt to relocate shards away from a node whose disk usage is above 90%. It can alternatively be set to a ratio value, e.g., `0.9`. It can also be set to an absolute byte value (similarly to the low watermark) to relocate shards away from a node if it has less than the specified amount of free space. This setting affects the allocation of all shards, whether previously allocated or not.
183187

184188
`cluster.routing.allocation.disk.watermark.high.max_headroom`
@@ -189,7 +193,7 @@ $$$cluster-routing-watermark-high$$$
189193

190194
$$$cluster-routing-flood-stage$$$
191195

192-
`cluster.routing.allocation.disk.watermark.flood_stage` ![logo cloud](https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg "Supported on {{ess}}")
196+
`cluster.routing.allocation.disk.watermark.flood_stage` ![logo cloud](https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg "Supported on Elastic Cloud Hosted")
193197
: ([Dynamic](docs-content://deploy-manage/deploy/self-managed/configure-elasticsearch.md#dynamic-cluster-setting)) Controls the flood stage watermark, which defaults to 95%. {{es}} enforces a read-only index block ([`index.blocks.read_only_allow_delete`](/reference/elasticsearch/index-settings/index-block.md)) on every index that has one or more shards allocated on the node, and that has at least one disk exceeding the flood stage. This setting is a last resort to prevent nodes from running out of disk space. The index block is automatically released when the disk utilization falls below the high watermark. Similarly to the low and high watermark values, it can alternatively be set to a ratio value, e.g., `0.95`, or an absolute byte value.
194198

195199

@@ -203,10 +207,10 @@ You can’t mix the usage of percentage/ratio values and byte values across the
203207

204208
$$$cluster-routing-flood-stage-frozen$$$
205209

206-
`cluster.routing.allocation.disk.watermark.flood_stage.frozen` ![logo cloud](https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg "Supported on {{ess}}")
210+
`cluster.routing.allocation.disk.watermark.flood_stage.frozen` ![logo cloud](https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg "Supported on Elastic Cloud Hosted")
207211
: ([Dynamic](docs-content://deploy-manage/deploy/self-managed/configure-elasticsearch.md#dynamic-cluster-setting)) Controls the flood stage watermark for dedicated frozen nodes, which defaults to 95%.
208212

209-
`cluster.routing.allocation.disk.watermark.flood_stage.frozen.max_headroom` ![logo cloud](https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg "Supported on {{ess}}")
213+
`cluster.routing.allocation.disk.watermark.flood_stage.frozen.max_headroom` ![logo cloud](https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg "Supported on Elastic Cloud Hosted")
210214
: ([Dynamic](docs-content://deploy-manage/deploy/self-managed/configure-elasticsearch.md#dynamic-cluster-setting)) Controls the max headroom for the flood stage watermark (in case of a percentage/ratio value) for dedicated frozen nodes. Defaults to 20GB when `cluster.routing.allocation.disk.watermark.flood_stage.frozen` is not explicitly set. This caps the amount of free space required on dedicated frozen nodes.
211215

212216
`cluster.info.update.interval`

docs/reference/elasticsearch/configuration-reference/cross-cluster-replication-settings.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
---
22
mapped_pages:
33
- https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-settings.html
4+
applies_to:
5+
deployment:
6+
self:
47
---
58

69
# Cross-cluster replication settings [ccr-settings]

docs/reference/elasticsearch/configuration-reference/data-stream-lifecycle-settings.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
navigation_title: "Data stream lifecycle settings"
33
mapped_pages:
44
- https://www.elastic.co/guide/en/elasticsearch/reference/current/data-stream-lifecycle-settings.html
5+
applies_to:
6+
deployment:
7+
self:
58
---
69

710
# Data stream lifecycle settings in {{es}} [data-stream-lifecycle-settings]

docs/reference/elasticsearch/configuration-reference/discovery-cluster-formation-settings.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
---
22
mapped_pages:
33
- https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-discovery-settings.html
4+
applies_to:
5+
deployment:
6+
self:
47
---
58

69
# Discovery and cluster formation settings [modules-discovery-settings]

0 commit comments

Comments
 (0)