Add Enterprise Search user settingsedit

Change how Enterprise Search runs by providing your own user settings. User settings are appended to the ent-search.yml configuration file for your instance and provide custom configuration options.

Some settings that could break your cluster if set incorrectly are blacklisted. Review the list of settings that are generally safe in cloud environments. For detailed information about Enterprise Search settings, see the Enterprise Search documentation.

To add user settings:

  1. Log in to the Elasticsearch Service Console.
  2. 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.

  3. From your deployment menu, go to the Edit page.
  4. At the bottom of the Enterprise Search section, expand the User settings overrides caret.
  5. Update the user settings.
  6. Click Save changes.

If a setting is not supported by Elasticsearch Service, an error message displays when you try to save your settings.

Supported Enterprise Search settingsedit

Elasticsearch Service supports the following Enterprise Search settings.

For version 7.9 and later:

ent_search.auth.<auth_name>.source
The origin of authenticated Enterprise Search users. Options are standard, elasticsearch-native, and elasticsearch-saml.
ent_search.auth.<auth_name>.order
The order in which to display this provider on the login screen.
ent_search.auth.<auth_name>.description
The name to be displayed on the login screen associated with this provider.
ent_search.auth.<auth_name>.icon
The URL to an icon to be displayed on the login screen associated with this provider.
ent_search.auth.<auth_name>.hidden
Boolean value to determine whether or not to display this login option on the login screen.
ent_search.login_assistance_message
Adds a message to the login screen. This field supports Markdown.

For version 7.7 and later:

workplace_search.custom_api_source.document_size.limit
Maximum allowed document size for Custom API Sources (in bytes).
workplace_search.custom_api_source.total_fields.limit
Number of fields a Custom API Source can have.
app_search.engine.document_size.limit
Maximum allowed document size in App Search engines (in bytes).
app_search.engine.total_fields.limit
Number of fields an App Search engine can have.
app_search.engine.source_engines_per_meta_engine.limit
Number of source engines a meta engine can have.
app_search.engine.total_facet_values_returned.limit
Number of facet values that can be returned by a search.
app_search.engine.query.limit
Size of full-text queries that are allowed.
app_search.engine.synonyms.sets.limit
Total number of synonym sets an engine can have.
app_search.engine.synonyms.terms_per_set.limit
Total number of terms a synonym set can have.
app_search.engine.analytics.total_tags.limit
Number of analytics tags that can be associated with a single query or clickthrough.