-
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 7 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,58 @@ | ||
| --- | ||
| applies_to: | ||
| deployment: | ||
| self: | ||
| 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. | ||
|
|
||
| ## Available cloud connected services | ||
|
|
||
| The following service is currently 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, the Elastic 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). | ||
wajihaparvez marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| ::: | ||
|
|
||
| :::{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. |
22 changes: 22 additions & 0 deletions
22
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,22 @@ | ||
| --- | ||
| applies_to: | ||
| deployment: | ||
| self: | ||
wajihaparvez marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| 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 by connecting to the {{ecloud}}. 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. | ||
wajihaparvez marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ## 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 your connected clusters](/deploy-manage/monitor/autoops/cc-manage-connected-clusters.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. | ||
70 changes: 70 additions & 0 deletions
70
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,70 @@ | ||
| --- | ||
| applies_to: | ||
| deployment: | ||
| self: | ||
wajihaparvez marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| 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 Elastic Stack, ECE (Elastic Cloud Enterprise), or ECK (Elastic Cloud on Kubernetes) deployment. | ||
wajihaparvez marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| ::: | ||
|
|
||
| :::{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 the {{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 the {{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 the {{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 the {{ecloud}} may come at an additional cost. For example, when sending metrics data from your cluster in a CSP region to the {{ecloud}}, shipping costs will be determined by your agreement with that CSP. | ||
| ::: | ||
|
|
||
| :::{dropdown} What information does the Elastic Agent extract from my cluster? | ||
wajihaparvez marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| The Elastic Agent only extracts and sends cluster metrics to the {{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 | | ||
| ::: | ||
|
|
||
|
|
||
56 changes: 56 additions & 0 deletions
56
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,56 @@ | ||
| --- | ||
| applies_to: | ||
| deployment: | ||
| self: | ||
| navigation_title: Troubleshooting guide | ||
wajihaparvez marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| --- | ||
|
|
||
| # AutoOps for self-managed clusters troubleshooting guide | ||
wajihaparvez marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ## Troubleshoot issues | ||
wajihaparvez marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| Use this guide to troubleshoot any issues you may encounter when using AutoOps for self-managed clusters. | ||
|
|
||
| :::{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 Elastic Agent. | ||
|
|
||
| Refer to [](/solutions/security/configure-elastic-defend/uninstall-elastic-agent.md) for instructions. | ||
| ::: | ||
|
|
||
| :::{dropdown} My self-managed cluster was disconnected from the {{ecloud}} and I want to reconnect it. | ||
|
|
||
| If the cluster was disconnected by one of the users in your Cloud organization, you can simply 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). | ||
wajihaparvez marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| :::{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 have been granted. | | ||
wajihaparvez marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| | `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 cloud organization. Disconnect it and then try again. | | ||
wajihaparvez marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| | `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 | The Elastic Agent couldn't connect to the cluster. There may be various reasons for this issue. | | ||
wajihaparvez marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| | `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 cloud organization. Contact Elastic support for help. | | ||
wajihaparvez marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| | `VERSION_MISMATCH` | {{es}} version is unsupported | Upgrade your cluster to a [supported version](https://www.elastic.co/support/eol). | | ||
| | `UNKNOWN_ERROR` | Installation failed | The Elastic 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. | | ||
wajihaparvez marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
124 changes: 124 additions & 0 deletions
124
deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops.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,124 @@ | ||
| --- | ||
| applies_to: | ||
| deployment: | ||
| self: | ||
wajihaparvez marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| navigation_title: Connect your self-managed cluster | ||
| --- | ||
|
|
||
| # Connect your self-managed cluster to AutoOps | ||
|
|
||
| To use AutoOps with your self-managed cluster, you first need to create an {{ecloud}} account or log in to your existing account. Once you choose to connect AutoOps to your self-managed cluster, an installation wizard will guide you through the steps of installing Elastic Agent to send metrics from your self-managed cluster to AutoOps in {{ecloud}}. | ||
wajihaparvez marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| Complete the steps in the following subsections to connect your cluster to AutoOps. The setup only takes about 10 minutes. | ||
wajihaparvez marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ## Prerequisites | ||
|
|
||
| Ensure you meet the following requirements before proceeding: | ||
wajihaparvez marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| * You have an [Enterprise self-managed license](https://www.elastic.co/subscriptions) or an active self-managed [free trial](https://cloud.elastic.co/registration). | ||
| * Your cluster is on a [supported {{es}} version](https://www.elastic.co/support/eol). | ||
wajihaparvez marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| * The agent you install for the connection is allowed to send metrics outside your organization to {{ecloud}}. | ||
| * You have a dedicated user with following permissions to set up the Elastic Agent: | ||
wajihaparvez marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| | Setting | Privileges | | ||
| | --- | --- | | ||
| | Cluster privileges | `monitor`, `read_ilm`, and `read_slm` | | ||
| | Index privileges | `*` indices: `monitor`, `view_index_metadata` <br><br> `.kibana*` indices: `read` | | ||
|
|
||
| ## Connect to AutoOps | ||
|
|
||
| :::{note} | ||
| :::{include} /deploy-manage/monitor/_snippets/single-cloud-org.md | ||
| ::: | ||
| ::: | ||
|
|
||
| 1. Go to your {{ecloud}} home page. | ||
| * If you already have an {{ecloud}} account, log in to [{{ecloud}}](https://cloud.elastic.co?page=docs&placement=docs-body). | ||
| * If you don’t have an {{ecloud}} account, [sign up](/deploy-manage/deploy/elastic-cloud/create-an-organization.md) and create an organization. | ||
| 2. In the **Connected clusters** section, select **Connect self-managed cluster**. | ||
| 3. On the **Cloud Connected Services** page, under **AutoOps**, select **Connect**. | ||
wajihaparvez marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ### Select installation method | ||
wajihaparvez marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| Your cluster ships metrics to AutoOps with the help of the Elastic Agent. | ||
wajihaparvez marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| :::{important} | ||
| Using AutoOps for your self-managed cluster requires a new, dedicated Elastic Agent. You must install an agent even if you already have an existing one for other purposes. | ||
| ::: | ||
|
|
||
| Select one of the following methods to install the Elastic Agent: | ||
wajihaparvez marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| * Kubernetes | ||
| * Docker | ||
| * Linux | ||
| * Windows | ||
|
|
||
| ### Configure agent | ||
wajihaparvez marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| 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. | ||
| * **Preferred authentication method**: Choose from the following: | ||
| * **API key**: [Create an API key](/solutions/observability/apm/grant-access-using-api-keys.md) to grant access to the cluster. | ||
| * **Basic**: Assign a username and password to a user with the required [permissions](#prerequisites). | ||
| * **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 cloud service providers and regions. | ||
|
|
||
| ### Install agent | ||
wajihaparvez marked this conversation as resolved.
Show resolved
Hide resolved
wajihaparvez marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| The wizard will generate an installation command based on your configuration. Depending on your installation method, the following command formats are available: | ||
|
|
||
| * Kubernetes | ||
| * YAML | ||
| * Helm Chart | ||
| * Docker | ||
| * Docker | ||
| * Docker compose | ||
| * Linux | ||
| * Windows | ||
|
|
||
| Complete the following steps to run the command: | ||
|
|
||
| 1. Copy the command. | ||
| 2. Paste it into a text editor and update the placeholder values in the following environment variables: | ||
|
|
||
| | Environment variable | Description | | ||
| | --- | --- | | ||
| | `AUTOOPS_OTEL_URL` | The {{ecloud}} URL to which the Elastic Agent ships data. The URL is generated based on the CSP and region you pick. <br> This URL shouldn't be edited. | | ||
| | `AUTOOPS_ES_URL` | The URL where the Elastic Agent communicates with {{es}}. | | ||
wajihaparvez marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| | `ELASTICSEARCH_READ_API_KEY` | The API key for API key authentication to access the cluster. It combines the `${id}:${api_key}` values. <br> This variable shouldn't be used with `ELASTICSEARCH_READ_USERNAME` and `ELASTICSEARCH_READ_PASSWORD`. | | ||
| | `ELASTICSEARCH_READ_USERNAME` | The username for basic authentication to access the cluster. <br> This variable should be used with `ELASTICSEARCH_READ_PASSWORD`. | | ||
| | `ELASTICSEARCH_READ_PASSWORD` | The password for basic authentication to access the cluster. <br> This variable should be used with `ELASTICSEARCH_READ_USERNAME`. | | ||
| | `ELASTIC_CLOUD_CONNECTED_MODE_API_KEY` | The {{ecloud}} API Key used to register the cluster. <br> This key shouldn't be edited. | | ||
| | `AUTOOPS_TEMP_RESOURCE_ID` | The temporary ID for the current installation wizard. | | ||
|
|
||
| 3. Ensure you meet the prerequisite for [permissions](#prerequisites) to run the command. | ||
wajihaparvez marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
wajihaparvez marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| 4. Run the command from the machine on which you want to install the agent. | ||
wajihaparvez marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| :::{tip} | ||
| For this step, we recommend using a machine different from the one on which your self-managed cluster is running. | ||
wajihaparvez marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| ::: | ||
|
|
||
| 5. Return to the wizard and select **I have run the command**. | ||
|
|
||
| It may take a few minutes for your cluster details to be validated and the first metrics to be shipped to AutoOps. | ||
wajihaparvez marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| If the connection is unsuccessful, an error message will appear with a possible reason for the failure and recommended next steps. For a list of these errors, refer to [Potential errors](/deploy-manage/monitor/autoops/cc-cloud-connect-autoops-troubleshooting.md#potential-errors). | ||
|
|
||
| Sometimes, an exact reason for the failure cannot be determined. In this case, explore [additional resources](/troubleshoot/index.md#troubleshoot-additional-resources) or [contact us](/troubleshoot/index.md#contact-us). | ||
|
|
||
| ### Launch AutoOps | ||
|
|
||
| If the connection is successful, AutoOps will start analyzing your metrics and reporting on any issues found. Depending on the size of your cluster, this process can take up to 30 minutes. | ||
|
|
||
| Once the account is ready, the **Open AutoOps** button will appear. Select it to launch AutoOps. | ||
wajihaparvez marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| Learn more about [AutoOps](/deploy-manage/monitor/autoops.md). | ||
|
|
||
| ## Access AutoOps | ||
|
|
||
| Once you've completed the setup, you can access AutoOps for your self-managed cluster at any time. | ||
wajihaparvez marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
wajihaparvez marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| 1. Log in to [{{ecloud}}](https://cloud.elastic.co/home). | ||
| 2. In the **Connected clusters** section, locate the cluster you want to work on. | ||
| 3. In the **Services** column, select **AutoOps**. | ||
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.