Edit Elasticsearch user settings | Elasticsearch Service Documentation

» » »

« Edit your user settings Edit Kibana user settings »

Edit Elasticsearch user settingsedit

Change how Elasticsearch runs by providing your own user settings. Elasticsearch Service appends these settings to each node’s elasticsearch.yml configuration file.

Elasticsearch Service automatically rejects elasticsearch.yml settings that could break your cluster. For a list of supported settings, check Supported Elasticsearch settings.

You can also update dynamic cluster settings using Elasticsearch’s update cluster settings API. However, Elasticsearch Service doesn’t reject unsafe setting changes made using this API. Use with caution.

To add or edit 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, select Edit user settings and plugins.
Update the user settings.
Select Save changes.

In some cases, you may get a warning saying "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.yml 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 versions 7.12.0 and 7.12.1 only)

The following searchable snapshots setting is supported:

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

From version 7.13.0 and later, this setting is automatically configured to 90% of total disk space for dedicated frozen data tier nodes and to 0b for non-frozen data tier nodes.

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