Add Elasticsearch user settings | Elasticsearch Service Documentation

» » »

« Edit your user settings Add Kibana user settings »

Add Elasticsearch user settingsedit

Change how Elasticsearch runs by providing your own user settings. User settings are appended to the elasticsearch.yml configuration file for your cluster and provide custom configuration options.

Some settings that could break your cluster if set incorrectly are blacklisted, such as certain zen discovery and security settings. Review the list of settings that are generally safe in cloud environments.

To add user settings:

Log in to the Elasticsearch Service Console.
Select your deployment on the home page in the Elasticsearch Service card or go to the deployments page.

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.
From your deployment menu, go to the Edit page.
In the Elasticsearch section, click Edit elasticsearch.yml. (For deployments with existing user settings, you may have to expand the User setting overrides caret for each node type instead.)
Update the user settings.
Click Save changes.

Note: In some cases, you may see a warning that "User settings are different across Elasticsearch instances". To fix this issue, ensure that your user settings (including the comments sections and whitespaces) are identical across all Elasticsearch nodes (not only the data tiers, but also the Master, Machine Learning, and Coordinating nodes)

Supported Elasticsearch settingsedit

Elasticsearch Service supports the following Elasticsearch settings:

http.cors.*

Enables cross-origin resource sharing (CORS) settings for the HTTP module.

If your use case depends on the ability to receive CORS requests and you have a cluster that was provisioned prior to January 25th 2019, you must manually set http.cors.enabled to true and allow a specific set of hosts with http.cors.allow-origin. Applying these changes in your Elasticsearch configuration allows cross-origin resource sharing requests.

http.compression

Support for compression when possible (with Accept-Encoding). Defaults to true.

repositories.url.allowed_urls

Enables whitelisting of read-only URL repositories.

reindex.remote.whitelist

Whitelists the hosts that can be reindexed from remotely. Expects a YAML array of host:port strings. Consists of a comma-delimited list of host:port entries. Defaults to ["\*.io:*", "\*.com:*"].

script.painless.regex.enabled

Enables regular expressions for the Painless scripting language.

action.auto_create_index

Automatically create index if it doesn’t already exist.

action.destructive_requires_name

When set to true, users must specify the index name to delete an index. It’s not possible to delete _all or use wildcards.

cluster.indices.close.enable

Enables closing indices in Elasticsearch version 2.2 and later. Defaults to true for versions 7.2.0 and later, and to false for previous versions. In versions 7.1 and below, closed indices represent a data loss risk: if you close an index, it is not included in snapshots and you will not be able to restore the data. Similarly, closed indices are not included when you make cluster configuration changes, such as scaling to a different capacity, failover, and many other operations. Lastly, closed indices can lead to inaccurate disk space counts.

For versions 7.1 and below, closed indices represent a data loss risk. Enable this setting only temporarily for these versions.

Circuit breaker settings

The following circuit breaker settings are supported:

indices.breaker.total.limit: Configures the parent circuit breaker settings.
indices.breaker.fielddata.limit: Configures the limit for the fielddata breaker.
indices.breaker.fielddata.overhead: Configures a constant that all field data estimations are multiplied with to determine a final estimation.
indices.breaker.request.limit: Configures the limit for the request breaker.
indices.breaker.request.overhead: Configures a constant that all request estimations are multiplied by to determine a final estimation.

Indexing pressure settings (for version 7.9 and later)

The following indexing pressure settings are supported:

indexing_pressure.memory.limit: Configures the indexing pressure settings.

Searchable Snapshots settings (for version 7.12.0 and later)

The following searchable snapshots settings are supported:

xpack.searchable.snapshot.shared_cache.size: Configures the size of the searchable snapshots shared cache.

From version 8.0.0 and later, you can only configure this setting on nodes with the data_frozen role. In earlier versions, the setting xpack.searchable.snapshot.shared_cache.size can be configured on any node.

X-Pack (for versions from 6.8.11 to 7.0.0 and 7.8.1 and later)