You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: deploy-manage/deploy/cloud-enterprise/edit-stack-settings-apm.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,7 +21,7 @@ Starting in {{stack}} version 8.0, how you change APM settings and the settings
21
21
Standalone APM Server (legacy)
22
22
: Deployments created prior to {{stack}} version 8.0 are in legacy mode. Upgrading to or past {{stack}} 8.0 does not remove you from legacy mode.
23
23
24
-
Check [Edit standalone APM settings (legacy)](#ece-edit-apm-standalone-settings-ece)for information on how to configure Elastic APM in this mode.
24
+
Check [Edit standalone APM settings (legacy)](#ece-edit-apm-standalone-settings-ece)for information on how to configure Elastic APM in this mode.
25
25
26
26
27
27
To learn more about the differences between these modes, or to switch from Standalone APM Server (legacy) mode to {{fleet}}-managed, check [Switch to the Elastic APM integration](/solutions/observability/apm/switch-to-elastic-apm-integration.md).
{{es}} settings that are typically defined in the `elasticsearch.yml` configuration file can be specified for a set of nodes in the `spec.nodeSets[?].config` section of the {{es}} resource manifest.
2
+
3
+
Some settings are managed by ECK. It is not recommended to change these managed settings. For a complete list, refer to [Settings managed by ECK](/deploy-manage/deploy/cloud-on-k8s/settings-managed-by-eck.md).
4
+
5
+
```yaml
6
+
spec:
7
+
nodeSets:
8
+
- name: masters
9
+
count: 3
10
+
config:
11
+
# On Elasticsearch versions before 7.9.0, replace the node.roles configuration with the following:
12
+
# node.master: true
13
+
node.roles: ["master"]
14
+
xpack.ml.enabled: true
15
+
- name: data
16
+
count: 10
17
+
config:
18
+
# On Elasticsearch versions before 7.9.0, replace the node.roles configuration with the following:
19
+
# node.master: false
20
+
# node.data: true
21
+
# node.ingest: true
22
+
# node.ml: true
23
+
# node.transform: true
24
+
node.roles: ["data", "ingest", "ml", "transform"]
25
+
```
26
+
27
+
:::{warning}
28
+
ECK parses {{es}} configuration and normalizes it to YAML. Consequently, some {{es}} configuration schema are impossible to express with ECK and, therefore, must be set using [dynamic cluster settings](/deploy-manage/deploy/self-managed/configure-elasticsearch.md#cluster-setting-types). For example:
29
+
```yaml
30
+
spec:
31
+
nodeSets:
32
+
- name: data
33
+
# ...
34
+
config:
35
+
cluster.max_shards_per_node: 1000
36
+
cluster.max_shards_per_node.frozen: 1000# This won't work because cluster.max_shards_per_node is defined as a scalar value on the previous line
You can add your own {{kib}} settings to the `spec.config` section.
2
+
3
+
The following example demonstrates how to set the [`elasticsearch.requestHeadersWhitelist`](kibana://reference/configuration-reference/general-settings.md#elasticsearch-requestheaderswhitelist) configuration option.
*[{{es}} Configuration](/deploy-manage/deploy/self-managed/configure-elasticsearch.md) (configuration settings for {{es}} that will go into `elasticsearch.yml`) [ECK 2.11.0]
31
+
*[{{es}} Configuration](/deploy-manage/deploy/self-managed/configure-elasticsearch.md) (configuration settings for {{es}} that will go into [`elasticsearch.yml`](/deploy-manage/stack-settings.md)) [ECK 2.11.0]
@@ -58,13 +58,13 @@ At least one of `spec.elasticsearch` or `spec.kibana` needs to be defined with a
58
58
*`indexLifecyclePolicies` are index lifecycle policies, to automatically manage the index lifecycle.
59
59
*`indexTemplates.componentTemplates` are component templates that are building blocks for constructing index templates that specify index mappings, settings, and aliases.
60
60
*`indexTemplates.composableIndexTemplates` are index templates to define settings, mappings, and aliases that can be applied automatically to new indices.
61
-
*`config` are the settings that go into the `elasticsearch.yml` file.
61
+
*`config` are the settings that go into the [`elasticsearch.yml`](/deploy-manage/stack-settings.md) file.
62
62
*`secretMounts` are the additional user created secrets that need to be mounted to the {{es}} Pods.
63
63
*`secureSettings` is a list of Secrets containing Secure Settings to inject into the keystore(s) of the {{es}} cluster(s) to which this policy applies, similar to the [{{es}} Secure Settings](../../security/secure-settings.md).
64
64
65
65
*`spec.kibana` describes the settings to configure for {{kib}}.
66
66
67
-
*`config` are the settings that go into the `kibana.yml` file.
67
+
*`config` are the settings that go into the [`kibana.yml`](/deploy-manage/stack-settings.md) file.
68
68
*`secureSettings` is a list of Secrets containing Secure Settings to inject into the keystore(s) of the {{kib}} instance(s) to which this policy applies, similar to the [{{kib}} Secure Settings](../../security/k8s-secure-settings.md).
You can add your own {{kib}} settings to the `spec.config` section.
61
-
62
-
The following example demonstrates how to set the [`elasticsearch.requestHeadersWhitelist`](kibana://reference/configuration-reference/general-settings.md#elasticsearch-requestheaderswhitelist) configuration option.
63
-
64
-
```yaml
65
-
apiVersion: kibana.k8s.elastic.co/v1
66
-
kind: Kibana
67
-
metadata:
68
-
name: kibana-sample
69
-
spec:
70
-
version: 8.16.1
71
-
count: 1
72
-
elasticsearchRef:
73
-
name: "elasticsearch-sample"
74
-
config:
75
-
elasticsearch.requestHeadersWhitelist:
76
-
- authorization
77
-
```
60
+
:::{include} _snippets/kib-config.md
61
+
:::
78
62
79
63
80
64
## Scale out a {{kib}} deployment [k8s-kibana-scaling]
Copy file name to clipboardExpand all lines: deploy-manage/deploy/cloud-on-k8s/node-configuration.md
+3-41Lines changed: 3 additions & 41 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,45 +8,7 @@ mapped_pages:
8
8
9
9
# Node configuration [k8s-node-configuration]
10
10
11
-
Any setting defined in the `elasticsearch.yml` configuration file can also be defined for a set of {{es}} nodes in the `spec.nodeSets[?].config` section.
12
-
13
-
Some settings are managed by ECK, it is not recommended to change them, refer to [Settings managed by ECK](settings-managed-by-eck.md) for more details.
14
-
15
-
```yaml
16
-
spec:
17
-
nodeSets:
18
-
- name: masters
19
-
count: 3
20
-
config:
21
-
# On Elasticsearch versions before 7.9.0, replace the node.roles configuration with the following:
22
-
# node.master: true
23
-
node.roles: ["master"]
24
-
xpack.ml.enabled: true
25
-
- name: data
26
-
count: 10
27
-
config:
28
-
# On Elasticsearch versions before 7.9.0, replace the node.roles configuration with the following:
29
-
# node.master: false
30
-
# node.data: true
31
-
# node.ingest: true
32
-
# node.ml: true
33
-
# node.transform: true
34
-
node.roles: ["data", "ingest", "ml", "transform"]
35
-
```
36
-
37
-
::::{warning}
38
-
ECK parses {{es}} configuration and normalizes it to YAML. Consequently, some {{es}} configuration schema are impossible to express with ECK and, therefore, must be set using [dynamic cluster settings](/deploy-manage/deploy/self-managed/configure-elasticsearch.md#cluster-setting-types). For example:
39
-
```yaml
40
-
spec:
41
-
nodeSets:
42
-
- name: data
43
-
# ...
44
-
config:
45
-
cluster.max_shards_per_node: 1000
46
-
cluster.max_shards_per_node.frozen: 1000# This won't work because cluster.max_shards_per_node is defined as a scalar value on the previous line
47
-
# ...
48
-
```
49
-
::::
50
-
51
-
For more information on {{es}} settings, check [Configuring Elasticsearch](/deploy-manage/deploy/self-managed/configure-elasticsearch.md).
11
+
:::{include} _snippets/es-config.md
12
+
:::
52
13
14
+
For more information on {{es}} settings, check [Configuring Elasticsearch](/deploy-manage/deploy/self-managed/configure-elasticsearch.md).
Copy file name to clipboardExpand all lines: deploy-manage/deploy/elastic-cloud/edit-stack-settings.md
+20-72Lines changed: 20 additions & 72 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,102 +17,50 @@ mapped_pages:
17
17
18
18
# Edit {{stack}} settings
19
19
20
-
% What needsto be done: Refine
20
+
From the {{ecloud}} Console you can customize {{es}}, {{kib}}, and related products to suit your needs. These editors append your changes to the appropriate YAML configuration file and they affect all users of that cluster.
21
21
22
-
% Use migrated content from existing pages that map to this page:
From the {{ecloud}} Console you can customize {{es}}, {{kib}}, and related products to suit your needs. These editors append your changes to the appropriate YAML configuration file and they affect all users of that cluster. In each editor you can:
54
-
55
-
56
-
## Edit {{es}} user settings [ec-add-user-settings]
57
-
58
-
Change how {{es}} runs by providing your own user settings. {{ech}} appends these settings to each node’s `elasticsearch.yml` configuration file.
24
+
### Elasticsearch settings
59
25
60
26
:::{important}
61
27
If a feature requires both standard `elasticsearch.yml` settings and [secure settings](/deploy-manage/security/secure-settings.md), configure the secure settings first. Updating standard user settings can trigger a cluster rolling restart, and if the required secure settings are not yet in place, the nodes may fail to start. In contrast, adding secure settings does not trigger a restart.
62
28
:::
63
29
64
30
{{ech}} automatically rejects `elasticsearch.yml` settings that could break your cluster.
65
31
66
-
For a list of supported settings, check [Supported {{es}} settings](elasticsearch://reference/elasticsearch/configuration-reference/index.md).
67
-
68
-
::::{warning}
69
-
You can also update [dynamic cluster settings](../../../deploy-manage/deploy/self-managed/configure-elasticsearch.md#dynamic-cluster-setting) using {{es}}'s [update cluster settings API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-settings). However, {{ech}} doesn’t reject unsafe setting changes made using this API. Use it with caution.
70
-
::::
71
-
72
-
73
-
To add or edit user settings:
32
+
For a list of supported settings, refer to the [{{es}} configuration reference](elasticsearch://reference/elasticsearch/configuration-reference/index.md). Settings supported on {{ech}} are indicated by an {{ecloud}} icon (![logo cloud](https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg"Supported on {{ecloud}}")).
74
33
75
-
1. Log in to the [{{ecloud}} Console](https://cloud.elastic.co?page=docs&placement=docs-body).
76
-
2. Find your deployment on the home page or on the **Hosted deployments** page, then select **Manage** to access its settings menus.
77
-
78
-
On the **Hosted deployments** page you can narrow your deployments by name, ID, or choose from several other filters. To customize your view, use a combination of filters, or change the format from a grid to a list.
34
+
### Kibana settings
79
35
80
-
3. From your deployment menu, go to the **Edit** page.
81
-
4. In the **Elasticsearch** section, select **Manage user settings and extensions**.
82
-
5. Update the user settings.
83
-
6. Select **Save changes**.
36
+
{{ech}} supports most of the standard {{kib}} settings.
84
37
85
-
::::{note}
86
-
In some cases, you may get a warning saying "User settings are different across {{es}} instances". To fix this issue, ensure that your user settings (including the comments sections and whitespaces) are identical across all {{es}} nodes (not only the data tiers, but also the Master, Machine Learning, and Coordinating nodes).
87
-
::::
38
+
Be aware that some settings that could break your cluster if set incorrectly and that the syntax might change between major versions.
88
39
89
-
## Edit {{kib}} user settings[ec-manage-kibana-settings]
40
+
For a list of supported settings, check [{{kib}} settings](kibana://reference/cloud/elastic-cloud-kibana-settings.md).
90
41
91
-
{{ech}} supports most of the standard {{kib}} and X-Pack settings. Through a YAML editor in the console, you can append {{kib}} properties to the `kibana.yml` file. Your changes to the configuration file are read on startup.
42
+
### APM settings
92
43
93
-
Be aware that some settings that could break your cluster if set incorrectly and that the syntax might change between major versions.
44
+
Refer to [APM configuration reference](/solutions/observability/apm/configure-apm-server.md) for information on how to configure the {{fleet}}-managed APM integration.
94
45
95
-
For a list of supported settings, check [{{kib}} settings](kibana://reference/cloud/elastic-cloud-kibana-settings.md).
46
+
## Edit settings[ec-add-user-settings]
96
47
97
-
To change {{kib}} settings:
48
+
To add or edit user settings:
98
49
99
50
1. Log in to the [{{ecloud}} Console](https://cloud.elastic.co?page=docs&placement=docs-body).
100
51
2. Find your deployment on the home page or on the **Hosted deployments** page, then select **Manage** to access its settings menus.
101
52
102
53
On the **Hosted deployments** page you can narrow your deployments by name, ID, or choose from several other filters. To customize your view, use a combination of filters, or change the format from a grid to a list.
103
54
104
-
3. From your deployment menu, go to the **Edit** page.
105
-
4. In the **Kibana** section, select **Edit user settings**. For deployments with existing user settings, you may have to expand the **Edit kibana.yml** caret instead.
106
-
5. Update the user settings.
107
-
6. Select **Save changes**.
108
-
109
-
Saving your changes initiates a configuration plan change that restarts {{kib}} automatically for you.
55
+
1. Under the deployment's name in the navigation menu, select **Edit**.
56
+
2. Look for the **Manage user settings and extensions** and **Edit user settings** links for each deployment, and select the one corresponding to the component you want to update, such as {{es}} or {{kib}}.
57
+
3. Apply the necessary settings in the **Users Settings** tab of the editor and select **Back** when finished.
58
+
4. Select **Save** to apply the changes to the deployment. Saving your changes initiates a configuration plan change that restarts the affected components for you.
110
59
111
60
::::{note}
112
-
If a setting is not supported by {{ech}}, you will get an error message when you try to save.
61
+
In some cases, you may get a warning saying "User settings are different across {{es}} instances". To fix this issue, ensure that your user settings (including the comments sections and whitespaces) are identical across all {{es}} nodes (not only the data tiers, but also the Master, Machine Learning, and Coordinating nodes).
113
62
::::
114
63
115
-
## Edit APM user settings [ec-manage-apm-settings]
116
-
117
-
Change how Elastic APM runs by providing your own user settings.
118
-
Check [APM configuration reference](/solutions/observability/apm/configure-apm-server.md) for information on how to configure the {{fleet}}-managed APM integration.
64
+
::::{warning}
65
+
You can also update [dynamic cluster settings](../../../deploy-manage/deploy/self-managed/configure-elasticsearch.md#dynamic-cluster-setting) using {{es}}'s [update cluster settings API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-settings). However, {{ech}} doesn’t reject unsafe setting changes made using this API. Use it with caution.
Copy file name to clipboardExpand all lines: deploy-manage/deploy/self-managed/_snippets/auto-security-config-rpm-deb.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,10 +1,10 @@
1
1
When you start {{es}} for the first time, it automatically performs the following security setup:
2
2
3
3
* Generates [TLS certificates](#stack-security-certificates) for the [transport and HTTP layers](/deploy-manage/security/secure-cluster-communications.md#communication-channels)
4
-
* Applies TLS configuration settings to `elasticsearch.yml`
4
+
* Applies TLS configuration settings to [`elasticsearch.yml`](/deploy-manage/stack-settings.md)
5
5
* Creates an enrollment token to securely connect {{kib}} to {{es}}
6
6
7
-
You can then start {{kib}} and enter the enrollment token, which is valid for 30 minutes. This token automatically applies the security settings from your {{es}} cluster, authenticates to {{es}} with the built-in `kibana` service account, and writes the security configuration to `kibana.yml`.
7
+
You can then start {{kib}} and enter the enrollment token, which is valid for 30 minutes. This token automatically applies the security settings from your {{es}} cluster, authenticates to {{es}} with the built-in `kibana` service account, and writes the security configuration to [`kibana.yml`](/deploy-manage/stack-settings.md).
8
8
9
9
::::{note}
10
10
There are [some cases](/deploy-manage/security/self-auto-setup.md#stack-skip-auto-configuration) where security can’t be configured automatically because the node startup process detects that the node is already part of a cluster, or that security is already configured or explicitly disabled.
Copy file name to clipboardExpand all lines: deploy-manage/deploy/self-managed/_snippets/auto-security-config.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,11 +1,11 @@
1
1
When you start your first {{es}} node for the first time, it automatically performs the following security setup:
2
2
3
3
* Generates [TLS certificates](#stack-security-certificates) for the [transport and HTTP layers](/deploy-manage/security/secure-cluster-communications.md#communication-channels)
4
-
* Applies TLS configuration settings to `elasticsearch.yml`
4
+
* Applies TLS configuration settings to [`elasticsearch.yml`](/deploy-manage/stack-settings.md)
5
5
* Sets a password for the `elastic` superuser
6
6
* Creates an enrollment token to securely connect {{kib}} to {{es}}
7
7
8
-
You can then start {{kib}} and enter the enrollment token, which is valid for 30 minutes. This token automatically applies the security settings from your {{es}} cluster, authenticates to {{es}} with the built-in `kibana` service account, and writes the security configuration to `kibana.yml`.
8
+
You can then start {{kib}} and enter the enrollment token, which is valid for 30 minutes. This token automatically applies the security settings from your {{es}} cluster, authenticates to {{es}} with the built-in `kibana` service account, and writes the security configuration to [`kibana.yml`](/deploy-manage/stack-settings.md).
9
9
10
10
::::{note}
11
11
There are [some cases](/deploy-manage/security/self-auto-setup.md#stack-skip-auto-configuration) where security can’t be configured automatically because the node startup process detects that the node is already part of a cluster, or that security is already configured or explicitly disabled.
Copy file name to clipboardExpand all lines: deploy-manage/deploy/self-managed/_snippets/clean-up-multinode.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
Perform the following steps on each node in the cluster:
2
2
3
-
1. Open `elasticsearch.yml` in a text editor.
3
+
1. Open [`elasticsearch.yml`](/deploy-manage/deploy/self-managed/configure-elasticsearch.md) in a text editor.
4
4
2. Comment out or remove the `cluster.initial_master_nodes` setting, if present.
5
5
3. Update the `discovery.seed_hosts` value so it contains the IP address and port of each of the master-eligible {{es}} nodes in the cluster. In the first node in the cluster, you need to add the `discovery.seed_hosts` setting manually.
6
6
4. Optionally, [restart the {{es}} service](/deploy-manage/maintenance/start-stop-services/start-stop-elasticsearch.md) to validate your configuration changes.
0 commit comments