Connect your ECE, ECK, or self-managed cluster to AutoOps

To use AutoOps with your ECE, ECK, or self-managed Elasticsearch cluster, you first need to create an Elastic Cloud account or log in to your existing account. An installation wizard then guides you through the steps of installing Elastic Agent to send metrics from your cluster to AutoOps in Elastic Cloud.

The connection process takes about 10 minutes.

Ensure your system meets the following requirements before proceeding:

• Your cluster is on a supported Elasticsearch version (7.17.x and above).
• Your cluster is on an Enterprise self-managed license or an active self-managed trial.
• The agent you install for the connection is allowed to send metrics to Elastic Cloud.
• To install Elastic Agent using ECK, your ECK operator is on version 3.3.0 and above.

The following steps describe how to connect your cluster to AutoOps.

This is the first step of the installation wizard. Your cluster ships metrics to AutoOps with the help of Elastic Agent.

Select one of the following methods to install Elastic Agent:

• Kubernetes
• Docker
• Linux
• Elastic Cloud on Kubernetes (ECK)

To learn more about how AutoOps securely gathers data from your cluster, refer to our FAQ.

Depending on your selected installation method, you might have to provide some or all of the following information to create the installation command:

• Elasticsearch endpoint URL: Enter the URL for the Elasticsearch cluster you want to monitor by connecting to AutoOps.

• Preferred authentication method: Choose one of the following:

  API key

  With this authentication method, you need to create an API key to grant access to your cluster. Complete the following steps:

  1. Go to Kibana in your Elasticsearch cluster.
  2. Go to the API keys management page in the navigation menu or use the global search field.
  3. Select Create API key.
  4. In the flyout, enter a name for your key and select User API key.
  5. Enable Control security privileges and enter the following script:

  {
  "autoops": {
    "cluster": [
      "monitor",
      "read_ilm",
      "read_slm"
    ],
    "indices": [
      {
        "names": [
          "*"
        ],
        "privileges": [
          "monitor",
          "view_index_metadata"
        ],
        "allow_restricted_indices": true
      }
    ],
    "applications": [],
    "run_as": [],
    "metadata": {},
    "transient_metadata": {
      "enabled": true
    }
  }
  }
  		

  6. Select Create API key.
  7. Copy the key and save it for later. You will need it when you install the agent.

  Basic

  With this authentication method, you need the username and password of a user with the necessary privileges to grant access to your cluster. There are two ways to set up a user with these privileges:

  • (Recommended) Go to Kibana in your cluster and then go to Developer tools. In Console, run the following command:

  POST /_security/role/autoops
  {
    "cluster": [
      "monitor",
      "read_ilm",
      "read_slm"
    ],
    "indices": [
      {
        "names": [
          "*"
        ],
        "privileges": [
          "monitor",
          "view_index_metadata"
        ],
        "allow_restricted_indices": true
      }
    ],
    "applications": [],
    "run_as": [],
    "metadata": {
      "description": "Allows Elastic agent to pull cluster metrics for AutoOps."
    },
    "transient_metadata": {
      "enabled": true
    }
  }
  		

  • Alternatively, manually assign the following privileges in your account:

    Setting	Privileges
    Cluster privileges	monitor, read_ilm, and read_slm
    Index privileges	Indices: * monitor, view_index_metadata

  Note

  If you manually assign privileges, you won't be able to allow Elastic Agent to access restricted indices.

• System architecture: Select the system architecture of the machine running the agent.

• Storage location: Select where to store your metrics data.
  In the Cloud provider field, select Amazon Web Services. In the Region field, select from the list of available AWS regions:

  Region	Name
  us-east-2	US East (Ohio)
  us-west-2	US West (Oregon)
  eu-west-1	EU (Ireland)
  eu-west-2	Europe (London)
  eu-central-1	Europe (Frankfurt)
  ap-northeast-1	Asia Pacific (Tokyo)
  ap-southeast-1	Asia Pacific (Singapore)

  More cloud service providers and regions are coming soon.

The wizard generates an installation command or a YAML manifest based on your configuration. Depending on your installation method, complete the following steps to install the agent:

kubectl describe autoopsagentpolicy <policy_name>
		

If the connection is unsuccessful, an error message is displayed with a possible reason for the failure and recommended next steps. For a list of these errors, refer to Potential errors. Sometimes, an exact reason for the failure cannot be determined. In this case, explore additional resources or contact us.

To uninstall the agent, refer to Uninstall Elastic Agent.

If the connection is successful, AutoOps starts analyzing your metrics and reporting on any issues found. Depending on the size of your cluster, this process can take up to 30 minutes.

kubectl -n {{namespace}} label elasticsearch <elasticsearch_cluster_name> autoops=enabled
		

After completing the setup, you can access AutoOps for your cluster at any time.

1. Log in to Elastic Cloud.
2. In the Connected clusters section, locate the cluster you want to work on.
3. In the Services column, select AutoOps.

Perform the actions described in the following sections to manage your connected cluster(s).

By default, each cluster has a name made up of a string of characters, but you can add a human-readable alias by completing the following steps. You need admin privileges to perform this action.

1. From the Elastic Cloud home page, go to the Connected clusters section and select the cluster you want to work on.
2. On the cluster details page, select Edit in the Cluster display name field.
3. Enter the alias in the field that is displayed and then select the checkmark icon.

To connect more clusters, repeat the steps to connect to AutoOps.

If you don't need to change any of your configuration settings for the additional clusters, you can skip ahead and reuse the same installation command if you used the Kubernetes, Docker, or Linux methods, or apply the same resourceSelector label if you used the ECK method.

Remember that you must install a separate, dedicated Elastic Agent for each cluster. You only need to install the agent once per cluster.

Complete the following steps to disconnect your cluster from your Cloud organization. You need the Organization owner role to perform this action.

1. Based on your installation method, complete the steps to stop Elastic Agent from shipping metrics to Elastic Cloud.
2. Log in to Elastic Cloud.
3. On the Connected clusters page or the Connected clusters section of the home page, locate the cluster you want to disconnect.
4. From that cluster’s actions menu, select Disconnect cluster.
5. Enter the cluster’s name in the field that is displayed and then select Disconnect cluster.

kubectl -n {{namespace}} label elasticsearch <elasticsearch_cluster_name> autoops-