New

The executive guide to generative AI

Read more
About usPartnersSupport|Login

It is time to say goodbye: This version of Elastic Cloud Enterprise has reached end-of-life (EOL) and is no longer supported.

The documentation for this version is no longer being maintained. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.

« Tag Your Allocators Create Instance Configurations »
Elastic Docs ›Elastic Cloud Enterprise Reference [2.0] ›Configuring Your Installation ›Configure Deployment Templates

Edit Instance Configurations

edit

Edit Instance Configurations

edit

Instance configurations enable components of the Elastic Stack to be matched to allocators for a specific use case. The matching is accomplished by defining a query that filters possible allocators based on their tags. For existing instance configurations, you can edit the query to change how allocators get matched, which in turn changes what components of the Elastic Stack get hosted on the matching allocators when creating or changing a deployment.

You might need to edit instance configurations under the following circumstances:

  • After you upgrade to or install Elastic Cloud Enterprise 2.0 or later and have tagged your allocators, t o indicate how you want to use these tagged allocators. You should edit at least some of the default instance configurations that are used by the hot-warm deployment template, so that ECE knows where to send incoming hot data and how to curate indices for warm data. At a minimum, this means editing the data.default and data.highstorage instance configurations, but we also recommend that you edit the master, kibana, and ml instance configurations.
  • If tagged allocators in your ECE installation are not being used as expected when you create or change deployments. Editing an instance configuration affects all deployments that depend on it, and tagged allocators that do not get matched by an instance configuration will not be used. If this happens, you can edit your instance configurations to create less restrictive queries.

If you edit instance configurations, so that they match fewer allocators, instances of the Elastic Stack that were previously matched to those allocators might be relocated. Keep this in mind when making queries more restrictive.

Steps

edit

To edit an instance configuration in the UI:

  1. Log into the Cloud UI.
  2. From the Platform menu, select Templates.
  3. Select the Instance configurations tab to see the default instance configurations that ship with ECE.

  4. Select one of the instance configurations and click Edit instance configuration.

    For example: Select to edit the data.default default instance configuration, so that you can specify where Elasticsearch data nodes for incoming data should be deployed. In a hot-warm architecture, this will determine where your hot data gets sent to.

  5. In the Input section, construct a query that filters on specific allocator tags.

    The following steps assume that no query exists, as is the case when you edit the default instance configurations for the first time after installing ECE version 2.0 or later. You can also edit an existing query by modifying the inner and outer clauses.

    An outer clause ANDs or ORs your main filtering criteria. You use outer clauses to find the allocators that you tagged earlier. An inner clause modifies an outer clause and let’s you refine your filtering criteria further. If you are unsure how the process works, try searching on some of the allocator tags that you added and see how the query results change. If you are editing the data.default default instance configuration, you want your query to return all allocators on which Elasticsearch data nodes for incoming data can be placed.

    1. Click And or Or to add a first outer clause.

    2. Enter a key-value pair in the Key and Value fields that you previously tagged your allocators with.

      For example: Enter SSD and true, if you tagged your allocators with this tag, or enter whatever tag you are using to identify allocators that can host Elasticsearch data nodes for incoming data.

      Creating a query that filters on allocator tags

    3. Check the list of allocators that get matched by your query:

      • If you are satisfied that your query matches all the allocators where the component(s) of the Elastic Stack can be deployed, move on to the next step. For the data.default default instance configuration, this means all the allocators where Elasticsearch data nodes for incoming data should be deployed, for example.
      • If you need to refine your query further, continue to adjust your outer or inner clauses. If you are unsure what to do, keep your initial query simple. You can always refine the query later on by re-editing the instance configuration.
  6. Click Save changes.

  7. If you are configuring the default instance configurations for the hot-warm template: Repeat steps 4 through 6 for the data.highstorage, master, kibana, and ml instance configurations.

    For example: For the data.highstorage instance configuration, your query should filter for allocators that use spindle-based storage. If you are using our sample tags, you could filter on either SSD: false or highstorage: true, depending on which tag you decided to use. For the master and kibana configurations, some multi-purpose hardware might work well. The ml instance configuration can benefit from hardware that provides higher CPU (highCPU: true in our sample tags).

After you have saved your changes, the updated instance configurations will be used whenever you create or edit deployments that use deployment templates based on these instance configurations.

« Tag Your Allocators Create Instance Configurations »

On this page

Was this helpful?
Feedback