Skip to content

[Private preview] Update AutoOps for self-managed clusters docs #3160

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Sep 25, 2025
Merged

[Private preview] Update AutoOps for self-managed clusters docs #3160

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
bdf5357
[Private preview] Small updates for AutoOps for self-managed clusters…
wajihaparvez Sep 24, 2025
70f2961
more updates
wajihaparvez Sep 24, 2025
044d85d
PR feedback
wajihaparvez Sep 25, 2025
ba6318e
Merge branch 'main' into self-managed-autoops-updates
wajihaparvez Sep 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 15 additions & 3 deletions deploy-manage/monitor/autoops/cc-cloud-connect-autoops-faq.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,10 @@ Find answers to your questions about AutoOps for ECE, ECK, and self-managed clus
* [Can I use macOS to install {{agent}} for this feature?](#macos-install)
* [Do I have to define an Elastic IP address to enable the agent to send data to {{ecloud}}?](#elastic-ip-address)

**Questions about collected metrics**
**Questions about collected metrics and data**
* [Where are AutoOps metrics stored?](#autoops-metrics-storage)
* [What information does {{agent}} extract from my cluster?](#extracted-info)
* [How does AutoOps gather data from my cluster and ensure its security?](#data-gathering)

## General questions
$$$why-autoops$$$ **Why should I use AutoOps for my clusters?**
Expand All @@ -42,7 +43,7 @@ $$$autoops-metrics-cost$$$ **Is there an added cost for shipping metrics data to
You can [choose the CSP region where your data is stored](#autoops-metrics-storage).

$$$es-versions$$$ **Which versions of {{es}} does AutoOps support?**
: AutoOps is compatible with all [supported {{es}} versions](https://www.elastic.co/support/eol).
: AutoOps is compatible with [supported {{es}} versions](https://www.elastic.co/support/eol) (7.17.x and above).

$$$deployment-types$$$ **Which deployment types can be connected to AutoOps?**
: You can connect to AutoOps on a standalone {{stack}}, ECE ({{ece}}), or ECK ({{eck}}) deployment.
Expand All @@ -65,7 +66,7 @@ $$$elastic-ip-address$$$ **Do I have to define an Elastic IP address to enable t

: For more information, refer to [](/deploy-manage/security/elastic-cloud-static-ips.md).

## Questions about collected metrics
## Questions about collected metrics and data
$$$autoops-metrics-storage$$$ **Where are AutoOps metrics stored?**
: You can choose where to store your metrics from the following AWS regions:

Expand All @@ -88,3 +89,14 @@ $$$extracted-info$$$ **What information does {{agent}} extract from my cluster?*
| [_template](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-template) | Retrieves legacy index templates | Similar to composable index templates but in older format |
| [_resolve/index/*](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-resolve-index) | Resolves index, data stream, and alias names to their current definitions | Mappings between names and underlying data objects |

$$$data-gathering$$$ **How does AutoOps gather data from my cluster and ensure its security?**
: AutoOps gathers data from your cluster using two protocols:
* **HTTP request**: Made to our Cloud Connected API to register your cluster with {{ecloud}} and gather registration-related data.
* **OpenTelemetry Protocol (OTLP)**: Used to gather all other operational data.

Each channel is authenticated through an API key or token to ensure your data's security. The following table offers more details:

| Protocol | Data extracted | Port | Authentication method |
| --- | --- | --- | --- |
| HTTP | Basic cluster information from the `/` endpoint <br><br> License information from the `/_license` endpoint | **443**: standard HTTPS port | Uses an {{ecloud}} API key which is limited for use with Cloud Connect only. |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just to be 100% sure, is this really supposed to be "the / endpoint? I thought it might have some path, but I guess it's the very top level of the API.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @kilfoyle! @arnonst can you please confirm?

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@wajihaparvez @kilfoyle the API call 'GET /' is a valid one

| OTLP | Operational information | **4318**: standard OTLP HTTP port <br><br> This service will be exposed on port 443 in the future. | Uses an AutoOps token which is functionally equivalent to an API key. |
3 changes: 2 additions & 1 deletion deploy-manage/monitor/autoops/cc-cloud-connect-autoops-troubleshooting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,4 +49,5 @@ The following table shows the errors you might encounter if something goes wrong
| `LICENSE_EXPIRED` | Elastic license is expired | Contact [sales](https://www.elastic.co/contact#sales) to renew your license. |
| `LICENSE_USED_BY_ANOTHER_ACCOUNT` | License key connected to another account | A license key can only be connected to one {{ecloud}} organization. Contact [Elastic support](https://support.elastic.co/) for help. |
| `VERSION_MISMATCH` | {{es}} version is unsupported | Upgrade your cluster to a [supported version](https://www.elastic.co/support/eol). |
| `UNKNOWN_ERROR` | Installation failed | {{agent}} couldn't be installed due to an unknown issue. Consult the troubleshooting guide or contact [Elastic support](https://support.elastic.co/) for more help. |
| `UNKNOWN_ERROR` | Installation failed | {{agent}} couldn't be installed due to an unknown issue. Consult the troubleshooting guide or contact [Elastic support](https://support.elastic.co/) for more help. |
| `` | Failed to register Cloud Connected Mode: cluster license type is not supported | The cluster you are trying to connect doesn't have the required license to connect to AutoOps. For more information, refer to the [prerequisites](/deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops.md#prerequisites). |
15 changes: 9 additions & 6 deletions deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ If you have an {{es}} cluster set up for local development or testing, you can c

Ensure your system meets the following requirements before proceeding:

* Your cluster is on a [supported {{es}} version](https://www.elastic.co/support/eol).
* Your cluster is on a [supported {{es}} version](https://www.elastic.co/support/eol) (7.17.x and above).
* Your cluster is on an [Enterprise self-managed license](https://www.elastic.co/subscriptions) or an active self-managed [trial](https://cloud.elastic.co/registration).
* The agent you install for the connection is allowed to send metrics to {{ecloud}}.

Expand Down Expand Up @@ -101,11 +101,13 @@ Select one of the following methods to install {{agent}}:
Using AutoOps for your ECE, ECK, and self-managed clusters requires a new, dedicated {{agent}}. You must install an agent even if you already have an existing one for other purposes.
:::

To learn more about how AutoOps securely gathers data from your cluster, refer to our [FAQ](/deploy-manage/monitor/autoops/cc-cloud-connect-autoops-faq.md#data-gathering).

### Configure agent

Depending on your selected installation method, you may have to provide the following information to create the installation command:

* **{{es}} endpoint URL**: The agent will use this URL to identify which cluster you want to connect to AutoOps.
* **{{es}} endpoint URL**: Enter the URL for the {{es}} cluster you want to monitor by connecting to AutoOps.
* **Preferred authentication method**: Choose one of the following:
:::::{tab-set}
:group: api-key-or-basic
Expand Down Expand Up @@ -204,7 +206,7 @@ If you manually assign privileges, you won't be able to allow {{agent}} to acces

:::::
* **System architecture**: Select the system architecture of the machine running the agent.
* **Metrics storage location**: Select where to store your metrics data from the list of available regions.
* **Metrics storage location**: Select where to store your metrics data from the list of available AWS regions.

:::{include} ../_snippets/autoops-cc-regions.md
:::
Expand Down Expand Up @@ -281,10 +283,11 @@ You can use the same installation command to connect multiple clusters, but each

Complete the following steps to disconnect your cluster from your Cloud organization. You need the **Organization owner** [role](/deploy-manage/monitor/autoops/cc-manage-users.md#assign-roles) to perform this action.

2. Based on your [installation method](#select-installation-method), complete the steps to stop {{agent}} from shipping metrics to {{ecloud}}.
1. Log in to [{{ecloud}}](https://cloud.elastic.co/home).
2. In the **Connected clusters** section, locate the cluster you want to disconnect.
3. From that cluster’s actions menu, select **Disconnect cluster**.
4. Enter the cluster’s name in the field that appears and then select **Disconnect cluster**.
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 appears and then select **Disconnect cluster**.

:::{include} /deploy-manage/monitor/_snippets/disconnect-cluster.md
:::