Loading

Add Elasticsearch user settings

ECE

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.

Important

If a feature requires both standard elasticsearch.yml settings and secure settings, 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 might fail to start. Adding secure settings does not trigger a restart.

Elastic Cloud Enterprise automatically rejects elasticsearch.yml settings that could break your cluster, including some zen discovery and security settings.

For a list of supported settings, check Supported Elasticsearch settings.

To add or edit Elasticsearch user settings:

  1. Log into the Cloud UI.

  2. On the Deployments page, select your deployment.

    Narrow the list by name, ID, or choose from several other filters. To further define the list, use a combination of filters.

  3. From your deployment menu, go to the Edit page.

  4. In the Elasticsearch section, select Manage user settings and extensions. For deployments with existing user settings, you may have to expand the User setting overrides caret for each node type instead.

  5. Update the user settings.

  6. Select Save changes.

    Warning

    If you encounter the Edit elasticsearch.yml carets, be sure to make your changes on all Elasticsearch node types.

To enable email notifications in your Elasticsearch cluster, you need to configure an email account and related settings. For complete instructions, refer to Configuring email accounts.

xpack.notification.email.account:
    gmail_account:
        profile: gmail
        smtp:
            auth: true
            starttls.enable: true
            host: smtp.gmail.com
            port: 587
            user: <username>

Before you add the xpack.notification.email* user settings, make sure to store the SMTP password in the keystore as a secure setting. In the previous example, use the key xpack.notification.email.account.gmail_account.smtp.secure_password.