-
Notifications
You must be signed in to change notification settings - Fork 184
[Private preview] Add docs for Cloud Connect + AutoOps for self-managed clusters #2287
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.
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
wajihaparvez
merged 12 commits into
elastic:main
from
wajihaparvez:cloud-connect-autoops
Jul 29, 2025
Merged
Changes from 8 commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
6c2f122
add initial pages
wajihaparvez 8dc8683
more pages
wajihaparvez 2e3dbe9
hide from toc
wajihaparvez cb9e41b
fix links
wajihaparvez b0a7ce9
update naming
wajihaparvez 9df2bbf
more requested edits
wajihaparvez 6b48a58
delete page
wajihaparvez 9f745f8
PR feedback
wajihaparvez fe1a3c7
more PR feedback + commented out section
wajihaparvez 31d85e9
fix anchor
wajihaparvez b6932ee
more info about privileges + new vs. existing users
wajihaparvez 148fa03
Merge branch 'main' into cloud-connect-autoops
wajihaparvez File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| --- | ||
| applies_to: | ||
| deployment: | ||
| self: | ||
| ece: | ||
| eck: | ||
| navigation_title: Cloud Connect | ||
| --- | ||
|
|
||
| # Cloud Connect | ||
wajihaparvez marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| Cloud Connect enables you to use {{ecloud}} services in your self-managed cluster without having to install and maintain their infrastructure yourself. In this way, you can get faster access to new features while significantly reducing your operational overhead. | ||
|
|
||
| Cloud Connect is included with your [self-managed Enterprise license](https://www.elastic.co/subscriptions) and works with self-managed free trials for the duration of the trial period. | ||
|
|
||
| AutoOps is the first service available for use with Cloud Connect. More services are coming soon. | ||
|
|
||
| ### AutoOps | ||
wajihaparvez marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| [AutoOps](/deploy-manage/monitor/autoops.md) is a monitoring tool that helps you manage your cluster with real-time issue detection, performance recommendations, and resolution paths. By analyzing hundreds of {{es}} metrics, your configuration, and usage patterns, AutoOps recommends operational and monitoring insights that deliver real savings in administration time and hardware cost. | ||
|
|
||
| Learn how to set up and use [](/deploy-manage/monitor/autoops/cc-autoops-as-cloud-connected.md). | ||
|
|
||
| ## FAQs | ||
|
|
||
| Find answers to your questions about Cloud Connect. | ||
|
|
||
| :::{dropdown} Does using Cloud Connect require additional payment? | ||
|
|
||
| $$$cc-payment$$$ | ||
|
|
||
| No. Cloud Connect is included with your [self-managed Enterprise license](https://www.elastic.co/subscriptions) and works with self-managed free trials for the duration of the trial period. | ||
|
|
||
| However, you may incur additional costs for specific functions within a cloud connected service. For example, when sending metrics data from your cluster in a CSP region to AutoOps in {{ecloud}}, shipping costs will be determined by your agreement with that CSP. | ||
| ::: | ||
|
|
||
| :::{dropdown} Does using Cloud Connect consume ECU? | ||
|
|
||
| $$$cc-ecu$$$ | ||
|
|
||
| No. The currently available functionality does not consume ECU, but this may change when more features are introduced. | ||
| ::: | ||
|
|
||
| :::{dropdown} Will my data be safe when using Cloud Connect? | ||
|
|
||
| $$$cc-data$$$ | ||
|
|
||
| Yes. For AutoOps, {{agent}} only sends cluster metrics to {{ecloud}}, not the underlying data within your cluster. Learn more in [](/deploy-manage/monitor/autoops/cc-cloud-connect-autoops-faq.md). | ||
| ::: | ||
|
|
||
| :::{dropdown} Are more services going to be available with Cloud Connect? | ||
|
|
||
| $$$cc-more-services$$$ | ||
|
|
||
| Yes. AutoOps is the first of many cloud connected services to come. The next planned service is the Elastic Inference Service (EIS), which will provide GPU-powered inference for use cases like semantic search and text embeddings. | ||
| ::: | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| :::{warning} | ||
| If you disconnect a cluster, its connection to your {{ecloud}} account will end and all metrics and AutoOps data will be permanently deleted. | ||
| ::: |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| Users can only belong to one {{ecloud}} organization at a time. If you want to create or join another organization, you must [leave the previous one](/cloud-account/join-or-leave-an-organization.md#ec-leave-organization) or use a different email address. |
23 changes: 23 additions & 0 deletions
23
deploy-manage/monitor/autoops/cc-autoops-as-cloud-connected.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| --- | ||
| applies_to: | ||
| deployment: | ||
| self: | ||
wajihaparvez marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| ece: | ||
| eck: | ||
| navigation_title: AutoOps for self-managed clusters | ||
| --- | ||
|
|
||
| # AutoOps for self-managed clusters | ||
|
|
||
| Use [AutoOps](/deploy-manage/monitor/autoops.md) with your self-managed cluster through [Cloud Connect](/deploy-manage/cloud-connect.md). | ||
|
|
||
| Cloud Connect enables users of self-managed clusters to use {{ecloud}} services. This means you can take advantage of the simplified cluster monitoring, real-time issue detection, and performance recommendations of AutoOps without having to run and manage the underlying infrastructure. | ||
|
|
||
| ## Section overview | ||
|
|
||
| In this section, you'll find the following information: | ||
|
|
||
| * How to [connect your self-managed cluster to AutoOps](/deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops.md). | ||
| * How to [manage users of your connected clusters](/deploy-manage/monitor/autoops/cc-manage-users.md). | ||
| * [FAQs](/deploy-manage/monitor/autoops/cc-cloud-connect-autoops-faq.md) about AutoOps for self-managed clusters. | ||
| * A [troubleshooting guide](/deploy-manage/monitor/autoops/cc-cloud-connect-autoops-troubleshooting.md) to help you with any issues you may encounter. | ||
wajihaparvez marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
72 changes: 72 additions & 0 deletions
72
deploy-manage/monitor/autoops/cc-cloud-connect-autoops-faq.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,72 @@ | ||
| --- | ||
| applies_to: | ||
| deployment: | ||
| self: | ||
wajihaparvez marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| ece: | ||
| eck: | ||
| navigation_title: FAQ | ||
| --- | ||
|
|
||
| # AutoOps for self-managed clusters FAQ | ||
|
|
||
| Find answers to your questions about AutoOps for self-managed clusters. | ||
|
|
||
| :::{dropdown} Why should I use AutoOps for my self-managed cluster? | ||
|
|
||
| AutoOps simplifies the operation of your {{es}} clusters by providing real-time monitoring, performance insights, and issue detection. It helps you identify and resolve problems like ingestion bottlenecks and unbalanced shards, reducing manual effort and preventing performance issues. | ||
|
|
||
| When you need support, AutoOps gives the Elastic team real-time visibility into your cluster, leading to faster resolutions. | ||
|
|
||
| Using AutoOps for your self-managed cluster lets you access all these features without the operational overhead of managing their infrastructure. | ||
| ::: | ||
|
|
||
| :::{dropdown} Which versions of {{es}} does AutoOps support? | ||
|
|
||
| AutoOps is compatible with all [supported {{es}} versions](https://www.elastic.co/support/eol). | ||
| ::: | ||
|
|
||
| :::{dropdown} Which deployment types can be connected to AutoOps? | ||
|
|
||
| You can connect to AutoOps on a standalone {{stack}}, ECE ({{ece}}), or ECK ({{eck}}) deployment. | ||
| ::: | ||
|
|
||
| :::{dropdown} Can I use AutoOps for self-managed clusters if my environment is air-gapped? | ||
|
|
||
| Not at this time. AutoOps is currently only available as a cloud service and you need an internet connection to send metrics to {{ecloud}}. For air-gapped environments, we plan to offer a locally deployable version in the future. | ||
| ::: | ||
|
|
||
| :::{dropdown} Do I have to define an Elastic IP address to enable the agent to send data to {{ecloud}}? | ||
|
|
||
| You may need to define an IP address if your organization’s settings will block the agent from sending out data. | ||
|
|
||
| To enable IP ranges, {{ecloud}} offers a selection of static IP addresses. All traffic directed to {{ecloud}} deployments, whether originating from the public internet, your private cloud network through the public internet, or your on-premise network through the public internet utilizes Ingress Static IPs as the network destination. | ||
|
|
||
| For more information, refer to [](/deploy-manage/security/elastic-cloud-static-ips.md). | ||
| ::: | ||
|
|
||
| :::{dropdown} Where are AutoOps metrics stored, and does it cost extra to ship metrics to {{ecloud}}? | ||
|
|
||
| You can choose the CSP and region in which your cluster metrics will be stored from a list of [available regions](/deploy-manage/monitor/autoops/ec-autoops-regions.md). | ||
|
|
||
| Shipping metrics to {{ecloud}} may come at an additional cost. For example, when sending metrics data from your cluster in a CSP region to {{ecloud}}, shipping costs will be determined by your agreement with that CSP. | ||
| ::: | ||
|
|
||
| :::{dropdown} What information does {{agent}} extract from my cluster? | ||
|
|
||
| {{agent}} only extracts and sends cluster metrics to {{ecloud}}, not the underlying data within your cluster. The following metrics are collected: | ||
|
|
||
| | API | Description | Collected data | | ||
| | --- | --- | --- | | ||
| | [_cat/shards](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-shards) | Returns detailed information about the shards within the cluster | Shard states, node allocation, index names, sizes, and replica information | | ||
| | [_nodes/stats](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-nodes-stats) | Retrieves statistics from cluster nodes including JVM, OS, process, and transport metrics | CPU usage, memory utilization, thread pools, file system stats | | ||
| | [_cluster/settings](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-get-settings) | Returns the settings configured for the cluster | Persistent and transient settings such as cluster-wide configurations | | ||
| | [_cluster/health](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-health) | Provides information about the overall health of the cluster | Status (green/yellow/red), number of nodes, number of shards | | ||
| | [_cat/template](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-templates) | Lists all index templates in the cluster | Template names, patterns, and basic settings | | ||
| | [_index_template](/manage-data/data-store/templates.md) | Retrieves composable index templates | Index settings, mappings, and aliases | | ||
| | [_component_template](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-get-component-template) | Fetches component templates used for building index templates | Metadata for re-usable mappings and settings | | ||
| | [_tasks](https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-tasks) | Displays information about currently running tasks on the cluster | Task descriptions, start times, running nodes, and execution details | | ||
| | [_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 | | ||
| ::: | ||
|
|
||
|
|
||
60 changes: 60 additions & 0 deletions
60
deploy-manage/monitor/autoops/cc-cloud-connect-autoops-troubleshooting.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| --- | ||
| applies_to: | ||
| deployment: | ||
| self: | ||
| ece: | ||
| eck: | ||
| navigation_title: Troubleshooting | ||
| --- | ||
|
|
||
| # AutoOps for self-managed clusters troubleshooting | ||
|
|
||
| Learn about issues that might come up when using AutoOps with your self-managed cluster. | ||
|
|
||
| ## Troubleshoot issues | ||
wajihaparvez marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| Use this guide to troubleshoot any issues you may encounter. | ||
|
|
||
| :::{dropdown} I’m trying to create a Cloud organization, but I’m already part of a different one. | ||
|
|
||
| :::{include} /deploy-manage/monitor/_snippets/single-cloud-org.md | ||
| ::: | ||
|
|
||
| ::: | ||
|
|
||
| :::{dropdown} I need to uninstall {{agent}}. | ||
|
|
||
| Refer to [](/solutions/security/configure-elastic-defend/uninstall-elastic-agent.md) for instructions. | ||
| ::: | ||
|
|
||
| :::{dropdown} My self-managed cluster was disconnected from {{ecloud}} and I want to reconnect it. | ||
|
|
||
| If the cluster was disconnected by one of the users in your Cloud organization, you can repeat the [installation process](/deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops.md) to reconnect. If not, explore [additional resources](/troubleshoot/index.md#troubleshoot-additional-resources) or [contact us](/troubleshoot/index.md#contact-us). | ||
|
|
||
| :::{include} /deploy-manage/monitor/_snippets/disconnect-cluster.md | ||
| ::: | ||
|
|
||
| ::: | ||
|
|
||
| :::{dropdown} After running the installation command, I can't move on to the next steps. | ||
|
|
||
| If an error appears on the screen, follow the suggestion in the error message and try to run the command again. If the issue is not resolved, explore [additional resources](/troubleshoot/index.md#troubleshoot-additional-resources) or [contact us](/troubleshoot/index.md#contact-us). | ||
| ::: | ||
|
|
||
| ## Potential errors | ||
|
|
||
| The following table shows the errors you might encounter if something goes wrong while you set up and use AutoOps for self-managed clusters. | ||
|
|
||
| | Error code | Error message | Description | | ||
| | :--- | :--- | :--- | | ||
| | `HTTP_401` | Authentication failed | Connection denied because of an authentication error. Verify that your API key and password are correct and all [necessary permissions](/deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops.md#prerequisites) have been granted. | | ||
| | `HTTP_502` | Server error | Received an invalid response from the server. Verify the server status and network configuration. | | ||
| | `HTTP_503` | Server unavailable | Invalid or corrupt response received from the server. The server acting as a proxy may be busy or undergoing scheduled maintenance. If the issue persists, check the cluster's health and resource usage. | | ||
| | `HTTP_504` | Request timed out | Did not receive a response from the cluster within the expected time frame. Check the cluster's performance or consider changing your connection timeout settings. | | ||
| | `CLUSTER_ALREADY_CONNECTED` | Cluster connected to another account | This cluster is already connected to another {{ecloud}} organization. Disconnect it and then try again. | | ||
| | `CLUSTER_NOT_READY` | {{es}} cluster is still connecting | Your {{es}} cluster is not yet ready to connect. Wait a few moments for it to finish starting up and then try again. | | ||
| | `HTTP_0` | Connection error | {{agent}} couldn't connect to the cluster. There may be various reasons for this issue. | | ||
| | `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 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://cloud.elastic.co/login?source=support&fromURI=https%3A%2F%2Fauth.elastic.co%2Fapp%2Felastic-customer_dreammachinecustomer_1%2Fexkgw653gkKlRTQXQ1t7%2Fsso%2Fsaml) for more help. | | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.