Elastic Stack settings

For Elastic Cloud Hosted and Elastic Cloud Enterprise deployments, you edit Elastic Stack settings through the Elastic Cloud Console or ECE Cloud UI. These settings are internally mapped to the appropriate YAML configuration files, such as elasticsearch.yml and kibana.yml, and they affect all users of that cluster.

Elastic Cloud Hosted and Elastic Cloud Enterprise block the configuration of certain settings that could break your cluster if misconfigured. If a setting is not supported, you will get an error message when you try to save. We suggest changing one setting with each save, so you know which one is not supported.

1. Log in to the Elastic Cloud Console or ECE Cloud UI.

2. On the home page, find your deployment.

   Tip

   If you have many deployments, you can instead go to the Hosted deployments (Elastic Cloud Hosted) or Deployments (Elastic Cloud Enterprise) page. On that page, you can narrow your deployments by name, ID, or choose from several other filters.

3. Select Manage.

1. Under the deployment's name in the navigation menu, select Edit.
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 Elasticsearch or Kibana.
3. Apply the necessary settings in the Users Settings tab of the editor and select Back when finished.
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.

For further details and examples, refer to the resource for your deployment type:

• Elastic Cloud Hosted
• Elastic Cloud Enterprise

Stack settings are defined as part of your resource specification.

Elasticsearch 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 Elasticsearch resource manifest.

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.

spec:
  nodeSets:
  - name: masters
    count: 3
    config:
      # On Elasticsearch versions before 7.9.0, replace the node.roles configuration with the following:
      # node.master: true
      node.roles: ["master"]
      xpack.ml.enabled: true
  - name: data
    count: 10
    config:
      # On Elasticsearch versions before 7.9.0, replace the node.roles configuration with the following:
      # node.master: false
      # node.data: true
      # node.ingest: true
      # node.ml: true
      # node.transform: true
      node.roles: ["data", "ingest", "ml", "transform"]

spec:
  nodeSets:
  - name: data
    # ...
    config:
      cluster.max_shards_per_node: 1000
      cluster.max_shards_per_node.frozen: 1000
    # ...

You can add your own Kibana settings to the spec.config section.

The following example demonstrates how to set the elasticsearch.requestHeadersWhitelist configuration option.

apiVersion: kibana.k8s.elastic.co/v1
kind: Kibana
metadata:
  name: kibana-sample
spec:
  version: 8.16.1
  count: 1
  elasticsearchRef:
    name: "elasticsearch-sample"
  config:
     elasticsearch.requestHeadersWhitelist:
     - authorization

The method and location where you can update your Elastic Stack settings depends on the component and installation method.

Most settings can be changed on a running cluster using the Cluster update settings API.

You can also set Elasticsearch settings in elasticsearch.yml. Some settings require a cluster restart. To learn more, refer to Dynamic and static Elasticsearch settings.

To learn more about configuring Elasticsearch in a self-managed environment, refer to Configure Elasticsearch.

To learn more about configuring Kibana in a self-managed environment, refer to Configure Kibana.

For APM and Enterprise Search, refer to the product's documentation:

• APM
• Enterprise Search

The elasticsearch.yml configuration format is YAML. Here is an example of changing the path of the data and logs directories in Elasticsearch:

path:
    data: /var/lib/elasticsearch
    logs: /var/log/elasticsearch

Settings can also be flattened as follows:

path.data: /var/lib/elasticsearch
path.logs: /var/log/elasticsearch

In YAML, you can format non-scalar values as sequences:

discovery.seed_hosts:
   - 192.168.1.10:9300
   - 192.168.1.11
   - seeds.mydomain.com

Though less common, you can also format non-scalar values as arrays:

discovery.seed_hosts: ["192.168.1.10:9300", "192.168.1.11", "seeds.mydomain.com"]

Environment variables referenced with the ${...} notation within the elasticsearch.yml configuration file will be replaced with the value of the environment variable. For example:

node.name:    ${HOSTNAME}
network.host: ${ES_NETWORK_HOST}

Values for environment variables must be simple strings. Use a comma-separated string to provide values that the component will parse as a list. For example, Elasticsearch will split the following string into a list of values for the ${HOSTNAME} environment variable:

export HOSTNAME="host1,host2"

By default, configuration validation will fail if an environment variable used in the config file is not present when the component starts. This behavior can be changed by using a default value for the environment variable, using the ${MY_ENV_VAR:defaultValue} syntax.