From 6c2f122d3e0cf9739e0888b276e64a02757909d2 Mon Sep 17 00:00:00 2001 From: wajihaparvez Date: Fri, 25 Jul 2025 18:06:41 -0400 Subject: [PATCH 01/11] add initial pages --- .../monitor/_snippets/single-cloud-org.md | 3 + .../autoops/cc-autoops-as-cloud-connected.md | 25 ++++ .../monitor/autoops/cc-collected-metrics.md | 23 ++++ .../cc-connect-self-managed-to-autoops.md | 117 ++++++++++++++++++ .../autoops/cc-manage-connected-clusters.md | 33 +++++ .../monitor/autoops/cc-manage-users.md | 39 ++++++ deploy-manage/toc.yml | 6 + 7 files changed, 246 insertions(+) create mode 100644 deploy-manage/monitor/_snippets/single-cloud-org.md create mode 100644 deploy-manage/monitor/autoops/cc-autoops-as-cloud-connected.md create mode 100644 deploy-manage/monitor/autoops/cc-collected-metrics.md create mode 100644 deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops.md create mode 100644 deploy-manage/monitor/autoops/cc-manage-connected-clusters.md create mode 100644 deploy-manage/monitor/autoops/cc-manage-users.md diff --git a/deploy-manage/monitor/_snippets/single-cloud-org.md b/deploy-manage/monitor/_snippets/single-cloud-org.md new file mode 100644 index 0000000000..a4d3c45c67 --- /dev/null +++ b/deploy-manage/monitor/_snippets/single-cloud-org.md @@ -0,0 +1,3 @@ +:::{note} +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. +::: \ No newline at end of file diff --git a/deploy-manage/monitor/autoops/cc-autoops-as-cloud-connected.md b/deploy-manage/monitor/autoops/cc-autoops-as-cloud-connected.md new file mode 100644 index 0000000000..7660d9de44 --- /dev/null +++ b/deploy-manage/monitor/autoops/cc-autoops-as-cloud-connected.md @@ -0,0 +1,25 @@ +--- +applies_to: + deployment: + self: +navigation_title: AutoOps as a cloud connected service +--- + +# AutoOps as a cloud connected service + +Use [AutoOps](/deploy-manage/monitor/autoops.md) with your self-managed cluster through Cloud Connect. 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. + +To use AutoOps with Cloud Connect, 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 then guide you through the steps of installing an Elastic agent to send metrics from your self-managed cluster to AutoOps in {{ecloud}}. + +The setup only takes about 10 minutes to complete. + +## 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). +* The [metrics](/deploy-manage/monitor/autoops/cc-collected-metrics.md) that are collected when you connect your self-managed cluster to AutoOps. +* FAQs about AutoOps as a cloud connected service. +* A troubleshooting guide to help you any issues you may encounter. \ No newline at end of file diff --git a/deploy-manage/monitor/autoops/cc-collected-metrics.md b/deploy-manage/monitor/autoops/cc-collected-metrics.md new file mode 100644 index 0000000000..b4deb14fac --- /dev/null +++ b/deploy-manage/monitor/autoops/cc-collected-metrics.md @@ -0,0 +1,23 @@ +--- +applies_to: + deployment: + self: +navigation_title: Collected metrics +--- + +# Collected metrics + +When you connect your self-managed cluster to AutoOps on Elastic Cloud, 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](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-templates) | 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 | \ No newline at end of file diff --git a/deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops.md b/deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops.md new file mode 100644 index 0000000000..7bf1af4cd5 --- /dev/null +++ b/deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops.md @@ -0,0 +1,117 @@ +--- +applies_to: + deployment: + self: +navigation_title: Connect your self-managed cluster +--- + +# Connect your self-managed cluster to AutoOps + +Complete the steps in the following subsections to set up AutoOps. + +## Prerequisites + +Ensure you meet the following requirements before proceeding: + +* 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 Elasticsearch version](https://www.elastic.co/support/eol). +* 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: + + | Type | Privilege | + | --- | --- | + | Cluster | `monitor`, `read_ilm`, and `read_slm` | + | Index | `monitor`, `view_index_metadata`, and `*` indices
`allow_restricted_indices`: `true` | + | Index | `read` and `.kibana*` indices
`allow_restricted_indices`: `true` | + +## Connect to AutoOps + +:::{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) 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**. + +### Select installation method + +Your cluster ships metrics to AutoOps with the help of the Elastic agent. + +:::{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: + +* Kubernetes +* Docker +* Linux +* Windows + +### Configure agent + +Depending on your selected installation method, you may have to provide the following information to create the installation command: + +* **Elasticsearch 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) 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 + +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. Don’t edit this URL. | +| `AUTOOPS_ES_URL` | The URL where the Elastic agent communicates with {{es}}. | +| `ELASTICSEARCH_READ_API_KEY` | The API key for API key authentication to access the cluster. This key combines the `${id}:${api_key}` values. Should not be used with `ELASTICSEARCH_READ_USERNAME` and `ELASTICSEARCH_READ_PASSWORD`. | +| `ELASTICSEARCH_READ_USERNAME` | The username for Basic authentication to access the cluster. Should be used with `ELASTICSEARCH_READ_PASSWORD`. | +| `ELASTICSEARCH_READ_PASSWORD` | The password for Basic authentication to access the cluster. Should be used with `ELASTICSEARCH_READ_USERNAME`. | +| `ELASTIC_CLOUD_CONNECTED_MODE_API_KEY` | The {{ecloud}} API Key used to register the cluster. Don’t edit this key. | +| `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. +4. Run the command from the machine on which you want to install the agent. + + :::{tip} + For this step, we recommend using a machine different from the one on which your self-managed cluster is running. + ::: + +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. For details on which metrics are collected by the agent, refer to [Collected metrics]. + +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 possible errors, refer to [Error messages]. + +### 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. Learn more about [AutoOps](/deploy-manage/monitor/autoops). + +## Access AutoOps + +Once you have completed the setup, you can access AutoOps for your self-managed cluster at any time: + +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**. \ No newline at end of file diff --git a/deploy-manage/monitor/autoops/cc-manage-connected-clusters.md b/deploy-manage/monitor/autoops/cc-manage-connected-clusters.md new file mode 100644 index 0000000000..996dab3236 --- /dev/null +++ b/deploy-manage/monitor/autoops/cc-manage-connected-clusters.md @@ -0,0 +1,33 @@ +--- +applies_to: + deployment: + self: +navigation_title: Manage connected clusters +--- + +# Manage connected clusters + +Once your self-managed clusters are connected to {{ecloud}}, you can manage them from your {{ecloud}} home page. + +:::{important} +You need the **Organization owner** role to perform these actions. +::: + +## Connect additional clusters + +To connect more self-managed clusters, we recommend repeating the steps to [connect your self-managed cluster to AutoOps](/deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops.md). + +You can use the same installation command to connect multiple clusters, but remember that each cluster needs a separate, dedicated Elastic agent. + +## Disconnect a cluster + +Disconnect your self-managed cluster from your Cloud organization. + +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**. + +:::{warning} +Disconnecting a cluster cannot be reversed. The cluster’s connection to your {{ecloud}} account will end and all metrics and AutoOps data will be permanently deleted. +::: \ No newline at end of file diff --git a/deploy-manage/monitor/autoops/cc-manage-users.md b/deploy-manage/monitor/autoops/cc-manage-users.md new file mode 100644 index 0000000000..0c1b46cda5 --- /dev/null +++ b/deploy-manage/monitor/autoops/cc-manage-users.md @@ -0,0 +1,39 @@ +--- +applies_to: + deployment: + self: +navigation_title: Manage users +--- + +# Manage users + +Learn how to invite users to your connected clusters and assign roles to new and existing users. + +## Invite users + +:::{include} /deploy-manage/monitor/_snippets/single-cloud-org.md +::: + +To invite users to your organization and give them access to your self-managed cluster: + +1. Log in to [{{ecloud}}](https://cloud.elastic.co/home). +2. In the **Connected clusters** section, select a cluster. +3. From the lower navigation menu, select **Organization**. +4. On the **Members** page, click **Invite members**. +5. Enter the email address of the user you want to invite in the textbox. \ +To add multiple users, enter their email addresses separated by a space. +6. In the **Assign roles** section, switch on **Connected cluster access**. +7. Set roles for the user(s) on all or selected self-managed clusters so that they have the appropriate permissions when they accept the invitation and sign in to {{ecloud}}. Learn more about roles and their levels of access to AutoOps in [Assign roles](#assign-roles). +8. Click **Send invites**. \ +Invitations to join an organization are sent by email. Invited users have 72 hours to accept the invitation before it expires. If the invite has expired, an admin can resend the invitation. + +You can also [manage existing users](/deploy-manage/users-roles/cloud-organization/manage-users#manage-existing-users) and [manage users through the {{ecloud}} API](/deploy-manage/users-roles/cloud-organization/manage-users#ec-api-organizations). + +## Assign roles + +Assign roles to new or existing users based on levels of access to AutoOps: + +| Role | Allowed actions in AutoOps | +| --- | --- | +| **Organization owner** | - View events and metrics reports
- Add or edit customizations and notification preferences
- Connect and disconnect clusters | +| **Connected cluster access** | **Viewer**
- View events and metrics reports

**Admin** for all connected clusters
- View events and metrics reports
- Add or edit customizations and notification preferences
- Connect and disconnect clusters

**Admin** for selected clusters
- View events and metrics reports
- Add or edit customizations and notification preferences
- Connect clusters | diff --git a/deploy-manage/toc.yml b/deploy-manage/toc.yml index e7db9aede7..e90eb6f64c 100644 --- a/deploy-manage/toc.yml +++ b/deploy-manage/toc.yml @@ -670,6 +670,12 @@ toc: - file: monitor/autoops/ec-autoops-dismiss-event.md - file: monitor/autoops/ec-autoops-regions.md - file: monitor/autoops/ec-autoops-faq.md + - file: monitor/autoops/cc-autoops-as-cloud-connected.md + children: + - file: monitor/autoops/cc-connect-self-managed-to-autoops.md + - file: monitor/autoops/cc-manage-connected-clusters.md + - file: monitor/autoops/cc-manage-users.md + - file: monitor/autoops/cc-collected-metrics.md - file: monitor/stack-monitoring.md children: - file: monitor/stack-monitoring/ece-ech-stack-monitoring.md From 8dc86833f473d92a89c711466bca897a897285d2 Mon Sep 17 00:00:00 2001 From: wajihaparvez Date: Sat, 26 Jul 2025 21:39:04 -0400 Subject: [PATCH 02/11] more pages --- deploy-manage/cloud-connect.md | 58 +++++++++++++++ .../monitor/_snippets/disconnect-cluster.md | 3 + .../monitor/_snippets/single-cloud-org.md | 4 +- .../autoops/cc-autoops-as-cloud-connected.md | 10 ++- .../autoops/cc-cloud-connect-autoops-faq.md | 71 +++++++++++++++++++ ...c-cloud-connect-autoops-troubleshooting.md | 64 +++++++++++++++++ .../monitor/autoops/cc-collected-metrics.md | 2 +- .../cc-connect-self-managed-to-autoops.md | 40 ++++++----- .../autoops/cc-manage-connected-clusters.md | 7 +- .../monitor/autoops/cc-manage-users.md | 4 +- deploy-manage/toc.yml | 3 + 11 files changed, 234 insertions(+), 32 deletions(-) create mode 100644 deploy-manage/cloud-connect.md create mode 100644 deploy-manage/monitor/_snippets/disconnect-cluster.md create mode 100644 deploy-manage/monitor/autoops/cc-cloud-connect-autoops-faq.md create mode 100644 deploy-manage/monitor/autoops/cc-cloud-connect-autoops-troubleshooting.md diff --git a/deploy-manage/cloud-connect.md b/deploy-manage/cloud-connect.md new file mode 100644 index 0000000000..abf37dd838 --- /dev/null +++ b/deploy-manage/cloud-connect.md @@ -0,0 +1,58 @@ +--- +applies_to: + deployment: + self: +navigation_title: Cloud Connect +--- + +# Cloud Connect + +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 + +[AutoOps](/deploy-manage/monitor/autoops) 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 about the [collected metrics](/deploy-manage/monitor/autoops/cc-collected-metrics.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. +::: + diff --git a/deploy-manage/monitor/_snippets/disconnect-cluster.md b/deploy-manage/monitor/_snippets/disconnect-cluster.md new file mode 100644 index 0000000000..1aef079105 --- /dev/null +++ b/deploy-manage/monitor/_snippets/disconnect-cluster.md @@ -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. +::: \ No newline at end of file diff --git a/deploy-manage/monitor/_snippets/single-cloud-org.md b/deploy-manage/monitor/_snippets/single-cloud-org.md index a4d3c45c67..edc4dfddfb 100644 --- a/deploy-manage/monitor/_snippets/single-cloud-org.md +++ b/deploy-manage/monitor/_snippets/single-cloud-org.md @@ -1,3 +1 @@ -:::{note} -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. -::: \ No newline at end of file +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. \ No newline at end of file diff --git a/deploy-manage/monitor/autoops/cc-autoops-as-cloud-connected.md b/deploy-manage/monitor/autoops/cc-autoops-as-cloud-connected.md index 7660d9de44..5905b4331e 100644 --- a/deploy-manage/monitor/autoops/cc-autoops-as-cloud-connected.md +++ b/deploy-manage/monitor/autoops/cc-autoops-as-cloud-connected.md @@ -7,11 +7,9 @@ navigation_title: AutoOps as a cloud connected service # AutoOps as a cloud connected service -Use [AutoOps](/deploy-manage/monitor/autoops.md) with your self-managed cluster through Cloud Connect. 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. +Use [AutoOps](/deploy-manage/monitor/autoops.md) with your self-managed cluster through [Cloud Connect](/deploy-manage/cloud-connect.md). -To use AutoOps with Cloud Connect, 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 then guide you through the steps of installing an Elastic agent to send metrics from your self-managed cluster to AutoOps in {{ecloud}}. - -The setup only takes about 10 minutes to complete. +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. ## Section overview @@ -21,5 +19,5 @@ In this section, you'll find the following information: * 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). * The [metrics](/deploy-manage/monitor/autoops/cc-collected-metrics.md) that are collected when you connect your self-managed cluster to AutoOps. -* FAQs about AutoOps as a cloud connected service. -* A troubleshooting guide to help you any issues you may encounter. \ No newline at end of file +* [FAQs](/deploy-manage/monitor/autoops/cc-cloud-connect-autoops-faq.md) about AutoOps as a cloud connected service. +* A [troubleshooting guide](/deploy-manage/monitor/autoops/cc-cloud-connect-autoops-troubleshooting.md) to help you with any issues you may encounter. \ No newline at end of file diff --git a/deploy-manage/monitor/autoops/cc-cloud-connect-autoops-faq.md b/deploy-manage/monitor/autoops/cc-cloud-connect-autoops-faq.md new file mode 100644 index 0000000000..9c76afcf81 --- /dev/null +++ b/deploy-manage/monitor/autoops/cc-cloud-connect-autoops-faq.md @@ -0,0 +1,71 @@ +--- +applies_to: + deployment: + self: +navigation_title: FAQ +--- + +# Cloud connected AutoOps FAQ + +Find answers to your questions about AutoOps as a cloud connected service. + +:::{dropdown} Why should I use AutoOps with Cloud Connect? + +$$$cc-autoops-why$$$ + +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 with Cloud Connect lets you access all these features in your self-managed cluster without the operational overhead of managing their infrastructure. +::: + +:::{dropdown} Which versions of {{es}} does AutoOps support? + +$$$cc-autoops-es-version$$$ + +AutoOps is compatible with all [supported {{es}} versions](https://www.elastic.co/support/eol). +::: + +:::{dropdown} Which deployment types can be connected to AutoOps? + +$$$cc-autoops-deployment-types$$$ + +You can connect to AutoOps on a standalone Elastic Stack, ECE (Elastic Cloud Enterprise), or ECK (Elastic Cloud on Kubernetes) deployment. +::: + +:::{dropdown} Can I use AutoOps with Cloud Connect if my environment is air-gapped? + +$$$cc-autoops-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}}? + +$$$cc-autoops-elastic-ip$$$ + +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}}? + +$$$cc-autoops-collected-metrics$$$ + +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? + +$$$cc-autoops-collected-metrics$$$ + +The Elastic Agent only extracts cluster metrics and sends them to the {{ecloud}}. For a list of these metrics, refer to [](/deploy-manage/monitor/autoops/cc-collected-metrics.md). +::: + + diff --git a/deploy-manage/monitor/autoops/cc-cloud-connect-autoops-troubleshooting.md b/deploy-manage/monitor/autoops/cc-cloud-connect-autoops-troubleshooting.md new file mode 100644 index 0000000000..32702fec83 --- /dev/null +++ b/deploy-manage/monitor/autoops/cc-cloud-connect-autoops-troubleshooting.md @@ -0,0 +1,64 @@ +--- +applies_to: + deployment: + self: +navigation_title: Troubleshooting guide +--- + +# Cloud connected AutoOps troubleshooting guide + +## Troubleshoot issues + +Use this guide to troubleshoot any issues you may encounter when using AutoOps as a cloud connected service. + +:::{dropdown} I’m trying to create a Cloud organization, but I’m already part of a different one. + +$$$cc-autoops-existing-cloud-org$$$ + +:::{include} /deploy-manage/monitor/_snippets/single-cloud-org.md +::: + +::: + +:::{dropdown} I need to uninstall Elastic Agent. + +$$$cc-autoops-uninstall-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. + +$$$cc-autoops-reconnect-cluster$$$ + +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). + +:::{include} /deploy-manage/monitor/_snippets/disconnect-cluster.md +::: + +::: + +:::{dropdown} After running the installation command, I can't move on to the next steps. + +$$$cc-autoops-command-error$$$ + +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 as a cloud connected service. + +| 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. | +| `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. | +| `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. | +| `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. | +| `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. | \ No newline at end of file diff --git a/deploy-manage/monitor/autoops/cc-collected-metrics.md b/deploy-manage/monitor/autoops/cc-collected-metrics.md index b4deb14fac..437f9770e3 100644 --- a/deploy-manage/monitor/autoops/cc-collected-metrics.md +++ b/deploy-manage/monitor/autoops/cc-collected-metrics.md @@ -7,7 +7,7 @@ navigation_title: Collected metrics # Collected metrics -When you connect your self-managed cluster to AutoOps on Elastic Cloud, the following metrics are collected: +When you connect your self-managed cluster to AutoOps on {{ecloud}}, the following metrics are collected: | API | Description | Collected data | | --- | --- | --- | diff --git a/deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops.md b/deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops.md index 7bf1af4cd5..2a0f90eac6 100644 --- a/deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops.md +++ b/deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops.md @@ -7,16 +7,18 @@ navigation_title: Connect your self-managed cluster # Connect your self-managed cluster to AutoOps -Complete the steps in the following subsections to set up AutoOps. +To use AutoOps with Cloud Connect, 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}}. + +Complete the steps in the following subsections to connect your cluster to AutoOps. The setup only takes about 10 minutes. ## Prerequisites Ensure you meet the following requirements before proceeding: * 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 Elasticsearch version](https://www.elastic.co/support/eol). +* Your cluster is on a [supported {{es}} version](https://www.elastic.co/support/eol). * 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: +* You have a dedicated user with following permissions to set up the Elastic Agent: | Type | Privilege | | --- | --- | @@ -26,8 +28,10 @@ Ensure you meet the following requirements before proceeding: ## 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). @@ -37,13 +41,13 @@ Ensure you meet the following requirements before proceeding: ### Select installation method -Your cluster ships metrics to AutoOps with the help of the Elastic agent. +Your cluster ships metrics to AutoOps with the help of the Elastic Agent. :::{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. +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: +Select one of the following methods to install the Elastic Agent: * Kubernetes * Docker @@ -54,7 +58,7 @@ Select one of the following methods to install the Elastic agent: Depending on your selected installation method, you may have to provide the following information to create the installation command: -* **Elasticsearch endpoint URL**: The agent will use this URL to identify which cluster you want to connect to AutoOps. +* **{{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) to grant access to the cluster. * **Basic**: Assign a username and password to a user with the required [permissions](#prerequisites). @@ -81,12 +85,12 @@ Complete the following steps to run the command: | 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. Don’t edit this URL. | -| `AUTOOPS_ES_URL` | The URL where the Elastic agent communicates with {{es}}. | -| `ELASTICSEARCH_READ_API_KEY` | The API key for API key authentication to access the cluster. This key combines the `${id}:${api_key}` values. Should not be used with `ELASTICSEARCH_READ_USERNAME` and `ELASTICSEARCH_READ_PASSWORD`. | -| `ELASTICSEARCH_READ_USERNAME` | The username for Basic authentication to access the cluster. Should be used with `ELASTICSEARCH_READ_PASSWORD`. | -| `ELASTICSEARCH_READ_PASSWORD` | The password for Basic authentication to access the cluster. Should be used with `ELASTICSEARCH_READ_USERNAME`. | -| `ELASTIC_CLOUD_CONNECTED_MODE_API_KEY` | The {{ecloud}} API Key used to register the cluster. Don’t edit this key. | +| `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.
This URL shouldn't be edited. | +| `AUTOOPS_ES_URL` | The URL where the Elastic Agent communicates with {{es}}. | +| `ELASTICSEARCH_READ_API_KEY` | The API key for API key authentication to access the cluster. It combines the `${id}:${api_key}` values.
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.
This variable should be used with `ELASTICSEARCH_READ_PASSWORD`. | +| `ELASTICSEARCH_READ_PASSWORD` | The password for basic authentication to access the cluster.
This variable should be used with `ELASTICSEARCH_READ_USERNAME`. | +| `ELASTIC_CLOUD_CONNECTED_MODE_API_KEY` | The {{ecloud}} API Key used to register the cluster.
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. @@ -98,19 +102,21 @@ Complete the following steps to run the command: 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. For details on which metrics are collected by the agent, refer to [Collected metrics]. +It may take a few minutes for your cluster details to be validated and the first metrics to be shipped to AutoOps. For details on which metrics are collected by the agent, refer to [](/deploy-manage/monitor/autoops/cc-collected-metrics.md). -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 possible errors, refer to [Error messages]. +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). ### 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. Learn more about [AutoOps](/deploy-manage/monitor/autoops). +Once the account is ready, the **Open AutoOps** button will appear. Select it to launch AutoOps. + +Learn more about [AutoOps](/deploy-manage/monitor/autoops). ## Access AutoOps -Once you have completed the setup, you can access AutoOps for your self-managed cluster at any time: +Once you've completed the setup, you can access AutoOps for your self-managed cluster at any time. 1. Log in to [{{ecloud}}](https://cloud.elastic.co/home). 2. In the **Connected clusters** section, locate the cluster you want to work on. diff --git a/deploy-manage/monitor/autoops/cc-manage-connected-clusters.md b/deploy-manage/monitor/autoops/cc-manage-connected-clusters.md index 996dab3236..9a20ef2a8b 100644 --- a/deploy-manage/monitor/autoops/cc-manage-connected-clusters.md +++ b/deploy-manage/monitor/autoops/cc-manage-connected-clusters.md @@ -17,17 +17,16 @@ You need the **Organization owner** role to perform these actions. To connect more self-managed clusters, we recommend repeating the steps to [connect your self-managed cluster to AutoOps](/deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops.md). -You can use the same installation command to connect multiple clusters, but remember that each cluster needs a separate, dedicated Elastic agent. +You can use the same installation command to connect multiple clusters, but remember that each cluster needs a separate, dedicated Elastic Agent. ## Disconnect a cluster -Disconnect your self-managed cluster from your Cloud organization. +Complete the following steps to disconnect your self-managed cluster from your Cloud organization. 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**. -:::{warning} -Disconnecting a cluster cannot be reversed. The cluster’s connection to your {{ecloud}} account will end and all metrics and AutoOps data will be permanently deleted. +:::{include} /deploy-manage/monitor/_snippets/disconnect-cluster.md ::: \ No newline at end of file diff --git a/deploy-manage/monitor/autoops/cc-manage-users.md b/deploy-manage/monitor/autoops/cc-manage-users.md index 0c1b46cda5..f79772922f 100644 --- a/deploy-manage/monitor/autoops/cc-manage-users.md +++ b/deploy-manage/monitor/autoops/cc-manage-users.md @@ -11,8 +11,10 @@ Learn how to invite users to your connected clusters and assign roles to new and ## Invite users +:::{note} :::{include} /deploy-manage/monitor/_snippets/single-cloud-org.md ::: +::: To invite users to your organization and give them access to your self-managed cluster: @@ -31,7 +33,7 @@ You can also [manage existing users](/deploy-manage/users-roles/cloud-organizati ## Assign roles -Assign roles to new or existing users based on levels of access to AutoOps: +Assign the following roles to new or existing users based on levels of access to AutoOps: | Role | Allowed actions in AutoOps | | --- | --- | diff --git a/deploy-manage/toc.yml b/deploy-manage/toc.yml index e90eb6f64c..a5a6db7b06 100644 --- a/deploy-manage/toc.yml +++ b/deploy-manage/toc.yml @@ -362,6 +362,7 @@ toc: - file: reference-architectures.md children: - file: reference-architectures/hotfrozen-high-availability.md + - file: cloud-connect.md - file: stack-settings.md - file: tools.md children: @@ -676,6 +677,8 @@ toc: - file: monitor/autoops/cc-manage-connected-clusters.md - file: monitor/autoops/cc-manage-users.md - file: monitor/autoops/cc-collected-metrics.md + - file: monitor/autoops/cc-cloud-connect-autoops-faq.md + - file: monitor/autoops/cc-cloud-connect-autoops-troubleshooting.md - file: monitor/stack-monitoring.md children: - file: monitor/stack-monitoring/ece-ech-stack-monitoring.md From 2e3dbe9640c132923af72f58388f23c9875f6aa2 Mon Sep 17 00:00:00 2001 From: wajihaparvez Date: Sat, 26 Jul 2025 21:46:12 -0400 Subject: [PATCH 03/11] hide from toc --- deploy-manage/toc.yml | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/deploy-manage/toc.yml b/deploy-manage/toc.yml index a5a6db7b06..65b88e2908 100644 --- a/deploy-manage/toc.yml +++ b/deploy-manage/toc.yml @@ -362,7 +362,7 @@ toc: - file: reference-architectures.md children: - file: reference-architectures/hotfrozen-high-availability.md - - file: cloud-connect.md + - hidden: cloud-connect.md - file: stack-settings.md - file: tools.md children: @@ -671,14 +671,13 @@ toc: - file: monitor/autoops/ec-autoops-dismiss-event.md - file: monitor/autoops/ec-autoops-regions.md - file: monitor/autoops/ec-autoops-faq.md - - file: monitor/autoops/cc-autoops-as-cloud-connected.md - children: - - file: monitor/autoops/cc-connect-self-managed-to-autoops.md - - file: monitor/autoops/cc-manage-connected-clusters.md - - file: monitor/autoops/cc-manage-users.md - - file: monitor/autoops/cc-collected-metrics.md - - file: monitor/autoops/cc-cloud-connect-autoops-faq.md - - file: monitor/autoops/cc-cloud-connect-autoops-troubleshooting.md + - hidden: monitor/autoops/cc-autoops-as-cloud-connected.md + - hidden: monitor/autoops/cc-connect-self-managed-to-autoops.md + - hidden: monitor/autoops/cc-manage-connected-clusters.md + - hidden: monitor/autoops/cc-manage-users.md + - hidden: monitor/autoops/cc-collected-metrics.md + - hidden: monitor/autoops/cc-cloud-connect-autoops-faq.md + - hidden: monitor/autoops/cc-cloud-connect-autoops-troubleshooting.md - file: monitor/stack-monitoring.md children: - file: monitor/stack-monitoring/ece-ech-stack-monitoring.md From cb9e41bde576de427990ca15feb8614ca61a35c8 Mon Sep 17 00:00:00 2001 From: wajihaparvez Date: Sat, 26 Jul 2025 22:18:50 -0400 Subject: [PATCH 04/11] fix links --- deploy-manage/cloud-connect.md | 2 +- .../monitor/autoops/cc-connect-self-managed-to-autoops.md | 6 +++--- deploy-manage/monitor/autoops/cc-manage-users.md | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/deploy-manage/cloud-connect.md b/deploy-manage/cloud-connect.md index abf37dd838..d2e5050c28 100644 --- a/deploy-manage/cloud-connect.md +++ b/deploy-manage/cloud-connect.md @@ -18,7 +18,7 @@ The following service is currently available for use with Cloud Connect. More se ### AutoOps -[AutoOps](/deploy-manage/monitor/autoops) 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. +[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). diff --git a/deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops.md b/deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops.md index 2a0f90eac6..66519a0e28 100644 --- a/deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops.md +++ b/deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops.md @@ -35,7 +35,7 @@ Ensure you meet the following requirements before proceeding: 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) and create an organization. + * 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**. @@ -60,7 +60,7 @@ Depending on your selected installation method, you may have to provide the foll * **{{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) to grant access to the cluster. + * **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. @@ -112,7 +112,7 @@ If the connection is successful, AutoOps will start analyzing your metrics and r Once the account is ready, the **Open AutoOps** button will appear. Select it to launch AutoOps. -Learn more about [AutoOps](/deploy-manage/monitor/autoops). +Learn more about [AutoOps](/deploy-manage/monitor/autoops.md). ## Access AutoOps diff --git a/deploy-manage/monitor/autoops/cc-manage-users.md b/deploy-manage/monitor/autoops/cc-manage-users.md index f79772922f..3e33db9569 100644 --- a/deploy-manage/monitor/autoops/cc-manage-users.md +++ b/deploy-manage/monitor/autoops/cc-manage-users.md @@ -29,7 +29,7 @@ To add multiple users, enter their email addresses separated by a space. 8. Click **Send invites**. \ Invitations to join an organization are sent by email. Invited users have 72 hours to accept the invitation before it expires. If the invite has expired, an admin can resend the invitation. -You can also [manage existing users](/deploy-manage/users-roles/cloud-organization/manage-users#manage-existing-users) and [manage users through the {{ecloud}} API](/deploy-manage/users-roles/cloud-organization/manage-users#ec-api-organizations). +You can also [manage existing users](/deploy-manage/users-roles/cloud-organization/manage-users.md#manage-existing-users) and [manage users through the {{ecloud}} API](/deploy-manage/users-roles/cloud-organization/manage-users.md#ec-api-organizations). ## Assign roles From b0a7ce98c046c3425f009e8c76f97b7b64a0cb66 Mon Sep 17 00:00:00 2001 From: wajihaparvez Date: Sun, 27 Jul 2025 22:11:05 -0400 Subject: [PATCH 05/11] update naming --- .../monitor/autoops/cc-autoops-as-cloud-connected.md | 6 +++--- .../monitor/autoops/cc-cloud-connect-autoops-faq.md | 10 +++++----- .../cc-cloud-connect-autoops-troubleshooting.md | 6 +++--- .../autoops/cc-connect-self-managed-to-autoops.md | 2 +- 4 files changed, 12 insertions(+), 12 deletions(-) diff --git a/deploy-manage/monitor/autoops/cc-autoops-as-cloud-connected.md b/deploy-manage/monitor/autoops/cc-autoops-as-cloud-connected.md index 5905b4331e..03bd5837cf 100644 --- a/deploy-manage/monitor/autoops/cc-autoops-as-cloud-connected.md +++ b/deploy-manage/monitor/autoops/cc-autoops-as-cloud-connected.md @@ -2,10 +2,10 @@ applies_to: deployment: self: -navigation_title: AutoOps as a cloud connected service +navigation_title: AutoOps for self-managed clusters --- -# AutoOps as a cloud connected service +# 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). @@ -19,5 +19,5 @@ In this section, you'll find the following information: * 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). * The [metrics](/deploy-manage/monitor/autoops/cc-collected-metrics.md) that are collected when you connect your self-managed cluster to AutoOps. -* [FAQs](/deploy-manage/monitor/autoops/cc-cloud-connect-autoops-faq.md) about AutoOps as a cloud connected service. +* [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. \ No newline at end of file diff --git a/deploy-manage/monitor/autoops/cc-cloud-connect-autoops-faq.md b/deploy-manage/monitor/autoops/cc-cloud-connect-autoops-faq.md index 9c76afcf81..610c526a0a 100644 --- a/deploy-manage/monitor/autoops/cc-cloud-connect-autoops-faq.md +++ b/deploy-manage/monitor/autoops/cc-cloud-connect-autoops-faq.md @@ -5,11 +5,11 @@ applies_to: navigation_title: FAQ --- -# Cloud connected AutoOps FAQ +# AutoOps for self-managed clusters FAQ -Find answers to your questions about AutoOps as a cloud connected service. +Find answers to your questions about AutoOps for self-managed clusters. -:::{dropdown} Why should I use AutoOps with Cloud Connect? +:::{dropdown} Why should I use AutoOps for my self-managed cluster? $$$cc-autoops-why$$$ @@ -17,7 +17,7 @@ AutoOps simplifies the operation of your {{es}} clusters by providing real-time When you need support, AutoOps gives the Elastic team real-time visibility into your cluster, leading to faster resolutions. -Using AutoOps with Cloud Connect lets you access all these features in your self-managed cluster without the operational overhead of managing their infrastructure. +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? @@ -34,7 +34,7 @@ $$$cc-autoops-deployment-types$$$ You can connect to AutoOps on a standalone Elastic Stack, ECE (Elastic Cloud Enterprise), or ECK (Elastic Cloud on Kubernetes) deployment. ::: -:::{dropdown} Can I use AutoOps with Cloud Connect if my environment is air-gapped? +:::{dropdown} Can I use AutoOps for self-managed clusters if my environment is air-gapped? $$$cc-autoops-air-gapped$$$ diff --git a/deploy-manage/monitor/autoops/cc-cloud-connect-autoops-troubleshooting.md b/deploy-manage/monitor/autoops/cc-cloud-connect-autoops-troubleshooting.md index 32702fec83..f84fe13f7f 100644 --- a/deploy-manage/monitor/autoops/cc-cloud-connect-autoops-troubleshooting.md +++ b/deploy-manage/monitor/autoops/cc-cloud-connect-autoops-troubleshooting.md @@ -5,11 +5,11 @@ applies_to: navigation_title: Troubleshooting guide --- -# Cloud connected AutoOps troubleshooting guide +# AutoOps for self-managed clusters troubleshooting guide ## Troubleshoot issues -Use this guide to troubleshoot any issues you may encounter when using AutoOps as a cloud connected service. +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. @@ -47,7 +47,7 @@ If an error appears on the screen, follow the suggestion in the error message an ## Potential errors -The following table shows the errors you might encounter if something goes wrong while you set up and use AutoOps as a cloud connected service. +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 | | :--- | :--- | :--- | diff --git a/deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops.md b/deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops.md index 66519a0e28..9a1700da5b 100644 --- a/deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops.md +++ b/deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops.md @@ -7,7 +7,7 @@ navigation_title: Connect your self-managed cluster # Connect your self-managed cluster to AutoOps -To use AutoOps with Cloud Connect, 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}}. +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}}. Complete the steps in the following subsections to connect your cluster to AutoOps. The setup only takes about 10 minutes. From 9df2bbf87f80c1860f147f5af817b15b7ab1b8c2 Mon Sep 17 00:00:00 2001 From: wajihaparvez Date: Mon, 28 Jul 2025 14:38:49 -0400 Subject: [PATCH 06/11] more requested edits --- deploy-manage/cloud-connect.md | 2 +- .../autoops/cc-autoops-as-cloud-connected.md | 1 - .../autoops/cc-cloud-connect-autoops-faq.md | 29 +++++++++---------- ...c-cloud-connect-autoops-troubleshooting.md | 8 ----- .../monitor/autoops/cc-collected-metrics.md | 2 +- .../cc-connect-self-managed-to-autoops.md | 11 +++---- deploy-manage/toc.yml | 1 - 7 files changed, 22 insertions(+), 32 deletions(-) diff --git a/deploy-manage/cloud-connect.md b/deploy-manage/cloud-connect.md index d2e5050c28..5559f085e7 100644 --- a/deploy-manage/cloud-connect.md +++ b/deploy-manage/cloud-connect.md @@ -46,7 +46,7 @@ No. The currently available functionality does not consume ECU, but this may cha $$$cc-data$$$ -Yes. For AutoOps, the Elastic Agent only sends cluster metrics to {{ecloud}}, not the underlying data within your cluster. Learn more about the [collected metrics](/deploy-manage/monitor/autoops/cc-collected-metrics.md). +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). ::: :::{dropdown} Are more services going to be available with Cloud Connect? diff --git a/deploy-manage/monitor/autoops/cc-autoops-as-cloud-connected.md b/deploy-manage/monitor/autoops/cc-autoops-as-cloud-connected.md index 03bd5837cf..7ce96fb912 100644 --- a/deploy-manage/monitor/autoops/cc-autoops-as-cloud-connected.md +++ b/deploy-manage/monitor/autoops/cc-autoops-as-cloud-connected.md @@ -18,6 +18,5 @@ 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). -* The [metrics](/deploy-manage/monitor/autoops/cc-collected-metrics.md) that are collected when you connect your self-managed cluster to AutoOps. * [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. \ No newline at end of file diff --git a/deploy-manage/monitor/autoops/cc-cloud-connect-autoops-faq.md b/deploy-manage/monitor/autoops/cc-cloud-connect-autoops-faq.md index 610c526a0a..725f541f69 100644 --- a/deploy-manage/monitor/autoops/cc-cloud-connect-autoops-faq.md +++ b/deploy-manage/monitor/autoops/cc-cloud-connect-autoops-faq.md @@ -11,8 +11,6 @@ Find answers to your questions about AutoOps for self-managed clusters. :::{dropdown} Why should I use AutoOps for my self-managed cluster? -$$$cc-autoops-why$$$ - 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. @@ -22,29 +20,21 @@ Using AutoOps for your self-managed cluster lets you access all these features w :::{dropdown} Which versions of {{es}} does AutoOps support? -$$$cc-autoops-es-version$$$ - AutoOps is compatible with all [supported {{es}} versions](https://www.elastic.co/support/eol). ::: :::{dropdown} Which deployment types can be connected to AutoOps? -$$$cc-autoops-deployment-types$$$ - You can connect to AutoOps on a standalone Elastic Stack, ECE (Elastic Cloud Enterprise), or ECK (Elastic Cloud on Kubernetes) deployment. ::: :::{dropdown} Can I use AutoOps for self-managed clusters if my environment is air-gapped? -$$$cc-autoops-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}}? -$$$cc-autoops-elastic-ip$$$ - 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. @@ -54,8 +44,6 @@ For more information, refer to [](/deploy-manage/security/elastic-cloud-static-i :::{dropdown} Where are AutoOps metrics stored, and does it cost extra to ship metrics to the {{ecloud}}? -$$$cc-autoops-collected-metrics$$$ - 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. @@ -63,9 +51,20 @@ Shipping metrics to the {{ecloud}} may come at an additional cost. For example, :::{dropdown} What information does the Elastic Agent extract from my cluster? -$$$cc-autoops-collected-metrics$$$ - -The Elastic Agent only extracts cluster metrics and sends them to the {{ecloud}}. For a list of these metrics, refer to [](/deploy-manage/monitor/autoops/cc-collected-metrics.md). +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 | ::: diff --git a/deploy-manage/monitor/autoops/cc-cloud-connect-autoops-troubleshooting.md b/deploy-manage/monitor/autoops/cc-cloud-connect-autoops-troubleshooting.md index f84fe13f7f..fe2e235aee 100644 --- a/deploy-manage/monitor/autoops/cc-cloud-connect-autoops-troubleshooting.md +++ b/deploy-manage/monitor/autoops/cc-cloud-connect-autoops-troubleshooting.md @@ -13,8 +13,6 @@ Use this guide to troubleshoot any issues you may encounter when using AutoOps f :::{dropdown} I’m trying to create a Cloud organization, but I’m already part of a different one. -$$$cc-autoops-existing-cloud-org$$$ - :::{include} /deploy-manage/monitor/_snippets/single-cloud-org.md ::: @@ -22,15 +20,11 @@ $$$cc-autoops-existing-cloud-org$$$ :::{dropdown} I need to uninstall Elastic Agent. -$$$cc-autoops-uninstall-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. -$$$cc-autoops-reconnect-cluster$$$ - 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). :::{include} /deploy-manage/monitor/_snippets/disconnect-cluster.md @@ -40,8 +34,6 @@ If the cluster was disconnected by one of the users in your Cloud organization, :::{dropdown} After running the installation command, I can't move on to the next steps. -$$$cc-autoops-command-error$$$ - 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). ::: diff --git a/deploy-manage/monitor/autoops/cc-collected-metrics.md b/deploy-manage/monitor/autoops/cc-collected-metrics.md index 437f9770e3..a4e5c870aa 100644 --- a/deploy-manage/monitor/autoops/cc-collected-metrics.md +++ b/deploy-manage/monitor/autoops/cc-collected-metrics.md @@ -16,7 +16,7 @@ When you connect your self-managed cluster to AutoOps on {{ecloud}}, the followi | [_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](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-templates) | Retrieves composable index templates | Index settings, mappings, and aliases | +| [_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 | diff --git a/deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops.md b/deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops.md index 9a1700da5b..9f51239f96 100644 --- a/deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops.md +++ b/deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops.md @@ -20,11 +20,10 @@ Ensure you meet the following requirements before proceeding: * 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: - | Type | Privilege | + | Setting | Privileges | | --- | --- | - | Cluster | `monitor`, `read_ilm`, and `read_slm` | - | Index | `monitor`, `view_index_metadata`, and `*` indices
`allow_restricted_indices`: `true` | - | Index | `read` and `.kibana*` indices
`allow_restricted_indices`: `true` | + | Cluster privileges | `monitor`, `read_ilm`, and `read_slm` | + | Index privileges | `*` indices: `monitor`, `view_index_metadata`

`.kibana*` indices: `read` | ## Connect to AutoOps @@ -102,10 +101,12 @@ Complete the following steps to run the command: 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. For details on which metrics are collected by the agent, refer to [](/deploy-manage/monitor/autoops/cc-collected-metrics.md). +It may take a few minutes for your cluster details to be validated and the first metrics to be shipped to AutoOps. 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. diff --git a/deploy-manage/toc.yml b/deploy-manage/toc.yml index 65b88e2908..9ccdbf5ed4 100644 --- a/deploy-manage/toc.yml +++ b/deploy-manage/toc.yml @@ -675,7 +675,6 @@ toc: - hidden: monitor/autoops/cc-connect-self-managed-to-autoops.md - hidden: monitor/autoops/cc-manage-connected-clusters.md - hidden: monitor/autoops/cc-manage-users.md - - hidden: monitor/autoops/cc-collected-metrics.md - hidden: monitor/autoops/cc-cloud-connect-autoops-faq.md - hidden: monitor/autoops/cc-cloud-connect-autoops-troubleshooting.md - file: monitor/stack-monitoring.md From 6b48a5859abb347d3cd6a23499b918e072a398f0 Mon Sep 17 00:00:00 2001 From: wajihaparvez Date: Mon, 28 Jul 2025 14:41:05 -0400 Subject: [PATCH 07/11] delete page --- .../monitor/autoops/cc-collected-metrics.md | 23 ------------------- 1 file changed, 23 deletions(-) delete mode 100644 deploy-manage/monitor/autoops/cc-collected-metrics.md diff --git a/deploy-manage/monitor/autoops/cc-collected-metrics.md b/deploy-manage/monitor/autoops/cc-collected-metrics.md deleted file mode 100644 index a4e5c870aa..0000000000 --- a/deploy-manage/monitor/autoops/cc-collected-metrics.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -applies_to: - deployment: - self: -navigation_title: Collected metrics ---- - -# Collected metrics - -When you connect your self-managed cluster to AutoOps on {{ecloud}}, 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 | \ No newline at end of file From 9f745f895fe3961462d1d40bb7e772dfee69f665 Mon Sep 17 00:00:00 2001 From: wajihaparvez Date: Mon, 28 Jul 2025 21:39:57 -0400 Subject: [PATCH 08/11] PR feedback --- deploy-manage/cloud-connect.md | 9 ++- .../autoops/cc-autoops-as-cloud-connected.md | 5 +- .../autoops/cc-cloud-connect-autoops-faq.md | 16 +++-- ...c-cloud-connect-autoops-troubleshooting.md | 26 ++++---- .../cc-connect-self-managed-to-autoops.md | 64 ++++++++++++------- .../autoops/cc-manage-connected-clusters.md | 32 ---------- .../monitor/autoops/cc-manage-users.md | 28 ++++---- deploy-manage/toc.yml | 1 - 8 files changed, 89 insertions(+), 92 deletions(-) delete mode 100644 deploy-manage/monitor/autoops/cc-manage-connected-clusters.md diff --git a/deploy-manage/cloud-connect.md b/deploy-manage/cloud-connect.md index 5559f085e7..7e28ab70d1 100644 --- a/deploy-manage/cloud-connect.md +++ b/deploy-manage/cloud-connect.md @@ -2,6 +2,8 @@ applies_to: deployment: self: + ece: + eck: navigation_title: Cloud Connect --- @@ -11,10 +13,7 @@ Cloud Connect enables you to use {{ecloud}} services in your self-managed cluste 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 is the first service available for use with Cloud Connect. More services are coming soon. ### AutoOps @@ -46,7 +45,7 @@ No. The currently available functionality does not consume ECU, but this may cha $$$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). +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? diff --git a/deploy-manage/monitor/autoops/cc-autoops-as-cloud-connected.md b/deploy-manage/monitor/autoops/cc-autoops-as-cloud-connected.md index 7ce96fb912..ae10605696 100644 --- a/deploy-manage/monitor/autoops/cc-autoops-as-cloud-connected.md +++ b/deploy-manage/monitor/autoops/cc-autoops-as-cloud-connected.md @@ -2,6 +2,8 @@ applies_to: deployment: self: + ece: + eck: navigation_title: AutoOps for self-managed clusters --- @@ -9,14 +11,13 @@ navigation_title: 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. +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 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. \ No newline at end of file diff --git a/deploy-manage/monitor/autoops/cc-cloud-connect-autoops-faq.md b/deploy-manage/monitor/autoops/cc-cloud-connect-autoops-faq.md index 725f541f69..81c962c287 100644 --- a/deploy-manage/monitor/autoops/cc-cloud-connect-autoops-faq.md +++ b/deploy-manage/monitor/autoops/cc-cloud-connect-autoops-faq.md @@ -2,6 +2,8 @@ applies_to: deployment: self: + ece: + eck: navigation_title: FAQ --- @@ -25,15 +27,15 @@ AutoOps is compatible with all [supported {{es}} versions](https://www.elastic.c :::{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. +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 the {{ecloud}}. For air-gapped environments, we plan to offer a locally deployable version in the future. +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 the {{ecloud}}? +:::{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. @@ -42,16 +44,16 @@ To enable IP ranges, {{ecloud}} offers a selection of static IP addresses. All t 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}}? +:::{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 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. +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 the Elastic Agent extract from my cluster? +:::{dropdown} What information does {{agent}} extract from my cluster? -The Elastic Agent only extracts and sends cluster metrics to the {{ecloud}}, not the underlying data within your cluster. The following metrics are collected: +{{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 | | --- | --- | --- | diff --git a/deploy-manage/monitor/autoops/cc-cloud-connect-autoops-troubleshooting.md b/deploy-manage/monitor/autoops/cc-cloud-connect-autoops-troubleshooting.md index fe2e235aee..e031de42c2 100644 --- a/deploy-manage/monitor/autoops/cc-cloud-connect-autoops-troubleshooting.md +++ b/deploy-manage/monitor/autoops/cc-cloud-connect-autoops-troubleshooting.md @@ -2,14 +2,18 @@ applies_to: deployment: self: -navigation_title: Troubleshooting guide + ece: + eck: +navigation_title: Troubleshooting --- -# AutoOps for self-managed clusters troubleshooting guide +# AutoOps for self-managed clusters troubleshooting + +Learn about issues that might come up when using AutoOps with your self-managed cluster. ## Troubleshoot issues -Use this guide to troubleshoot any issues you may encounter when using AutoOps for self-managed clusters. +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. @@ -18,14 +22,14 @@ Use this guide to troubleshoot any issues you may encounter when using AutoOps f ::: -:::{dropdown} I need to uninstall Elastic Agent. +:::{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 the {{ecloud}} and I want to reconnect it. +:::{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 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). +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 ::: @@ -43,14 +47,14 @@ The following table shows the errors you might encounter if something goes wrong | 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. | +| `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 cloud organization. Disconnect it and then try again. | +| `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 | The Elastic Agent couldn't connect to the cluster. There may be various reasons for this issue. | +| `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 cloud organization. Contact Elastic support for help. | +| `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 | 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. | \ No newline at end of file +| `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. | \ No newline at end of file diff --git a/deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops.md b/deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops.md index 9f51239f96..e85c27edef 100644 --- a/deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops.md +++ b/deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops.md @@ -2,28 +2,30 @@ applies_to: deployment: self: + ece: + eck: 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}}. +To use AutoOps with your self-managed cluster, you first need to create an {{ecloud}} account or log in to your existing account. After you choose to connect AutoOps to your self-managed cluster, an installation wizard will guide you through the steps of installing {{agent}} to send metrics from your self-managed cluster to AutoOps in {{ecloud}}. -Complete the steps in the following subsections to connect your cluster to AutoOps. The setup only takes about 10 minutes. +Complete the steps in the following subsections to connect your cluster to AutoOps. The setup takes about 10 minutes. ## Prerequisites -Ensure you meet the following requirements before proceeding: +Ensure your system meets the following requirements before proceeding: -* 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). +* You have an [Enterprise self-managed license](https://www.elastic.co/subscriptions) or an active self-managed [free trial](https://cloud.elastic.co/registration). * 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: +* You have a dedicated user with the following permissions to set up {{agent}}: | Setting | Privileges | | --- | --- | | Cluster privileges | `monitor`, `read_ilm`, and `read_slm` | - | Index privileges | `*` indices: `monitor`, `view_index_metadata`

`.kibana*` indices: `read` | + | Index privileges | `*` indices: `monitor`, `view_index_metadata` | ## Connect to AutoOps @@ -36,17 +38,17 @@ Ensure you meet the following requirements before proceeding: * 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**. +3. On the **Cloud Connected Services** page, in the **AutoOps** section, select **Connect**. ### Select installation method -Your cluster ships metrics to AutoOps with the help of the Elastic Agent. +Your cluster ships metrics to AutoOps with the help of {{agent}}. :::{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. +Using AutoOps for your self-managed cluster requires a new, dedicated {{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: +Select one of the following methods to install {{agent}}: * Kubernetes * Docker @@ -77,6 +79,10 @@ The wizard will generate an installation command based on your configuration. De * Linux * Windows +:::{tip} +We recommend installing the agent on a machine different from the one on which your self-managed cluster is running. +::: + Complete the following steps to run the command: 1. Copy the command. @@ -84,24 +90,18 @@ Complete the following steps to run the command: | 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.
This URL shouldn't be edited. | -| `AUTOOPS_ES_URL` | The URL where the Elastic Agent communicates with {{es}}. | +| `AUTOOPS_OTEL_URL` | The {{ecloud}} URL to which {{agent}} ships data. The URL is generated based on the CSP and region you pick.
This URL shouldn't be edited. | +| `AUTOOPS_ES_URL` | The URL {{agent}} uses to communicate with {{es}}. | | `ELASTICSEARCH_READ_API_KEY` | The API key for API key authentication to access the cluster. It combines the `${id}:${api_key}` values.
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.
This variable should be used with `ELASTICSEARCH_READ_PASSWORD`. | | `ELASTICSEARCH_READ_PASSWORD` | The password for basic authentication to access the cluster.
This variable should be used with `ELASTICSEARCH_READ_USERNAME`. | | `ELASTIC_CLOUD_CONNECTED_MODE_API_KEY` | The {{ecloud}} API Key used to register the cluster.
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. -4. Run the command from the machine on which you want to install the agent. - - :::{tip} - For this step, we recommend using a machine different from the one on which your self-managed cluster is running. - ::: - +4. Run the command from the machine where you want to install the agent. 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. +It might take a few minutes for your cluster details to be validated and the first metrics to be shipped to AutoOps. 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). @@ -111,14 +111,32 @@ Sometimes, an exact reason for the failure cannot be determined. In this case, e 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. +After the account is ready, the **Open AutoOps** button will appear in the wizard. Select it to launch AutoOps. 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. +After you've completed the setup, you can access AutoOps for your self-managed cluster at any time. 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**. \ No newline at end of file +3. In the **Services** column, select **AutoOps**. + +## Connect additional clusters + +To connect more self-managed clusters, we recommend repeating the steps to [connect your self-managed cluster to AutoOps](/deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops.md). + +You can use the same installation command to connect multiple clusters, but each cluster needs a separate, dedicated {{agent}}. + +## Disconnect a cluster + +Complete the following steps to disconnect your self-managed 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. + +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**. + +:::{include} /deploy-manage/monitor/_snippets/disconnect-cluster.md +::: \ No newline at end of file diff --git a/deploy-manage/monitor/autoops/cc-manage-connected-clusters.md b/deploy-manage/monitor/autoops/cc-manage-connected-clusters.md deleted file mode 100644 index 9a20ef2a8b..0000000000 --- a/deploy-manage/monitor/autoops/cc-manage-connected-clusters.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -applies_to: - deployment: - self: -navigation_title: Manage connected clusters ---- - -# Manage connected clusters - -Once your self-managed clusters are connected to {{ecloud}}, you can manage them from your {{ecloud}} home page. - -:::{important} -You need the **Organization owner** role to perform these actions. -::: - -## Connect additional clusters - -To connect more self-managed clusters, we recommend repeating the steps to [connect your self-managed cluster to AutoOps](/deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops.md). - -You can use the same installation command to connect multiple clusters, but remember that each cluster needs a separate, dedicated Elastic Agent. - -## Disconnect a cluster - -Complete the following steps to disconnect your self-managed cluster from your Cloud organization. - -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**. - -:::{include} /deploy-manage/monitor/_snippets/disconnect-cluster.md -::: \ No newline at end of file diff --git a/deploy-manage/monitor/autoops/cc-manage-users.md b/deploy-manage/monitor/autoops/cc-manage-users.md index 3e33db9569..1e4dd22fab 100644 --- a/deploy-manage/monitor/autoops/cc-manage-users.md +++ b/deploy-manage/monitor/autoops/cc-manage-users.md @@ -2,12 +2,14 @@ applies_to: deployment: self: -navigation_title: Manage users + ece: + eck: +navigation_title: Manage connected cluster users --- -# Manage users +# Manage connected cluster users -Learn how to invite users to your connected clusters and assign roles to new and existing users. +Learn how to invite users to your {{ecloud}} organization and give them access to AutoOps on your connected clusters. ## Invite users @@ -22,12 +24,16 @@ To invite users to your organization and give them access to your self-managed c 2. In the **Connected clusters** section, select a cluster. 3. From the lower navigation menu, select **Organization**. 4. On the **Members** page, click **Invite members**. -5. Enter the email address of the user you want to invite in the textbox. \ -To add multiple users, enter their email addresses separated by a space. -6. In the **Assign roles** section, switch on **Connected cluster access**. -7. Set roles for the user(s) on all or selected self-managed clusters so that they have the appropriate permissions when they accept the invitation and sign in to {{ecloud}}. Learn more about roles and their levels of access to AutoOps in [Assign roles](#assign-roles). -8. Click **Send invites**. \ -Invitations to join an organization are sent by email. Invited users have 72 hours to accept the invitation before it expires. If the invite has expired, an admin can resend the invitation. +5. Enter the email address of the user you want to invite. + + To add multiple users, enter their email addresses separated by a space. +6. In the **Assign roles** section, enable **Connected cluster access**. +7. Set roles for the users on all or selected self-managed clusters so that they have the appropriate permissions when they accept the invitation and sign in to {{ecloud}}. + + Learn more about roles and their levels of access to AutoOps in [Assign roles](#assign-roles). +8. Click **Send invites**. + + Invitations to join an organization are sent by email. Invited users have 72 hours to accept the invitation before it expires. If an invitation expires, an admin can resend it. You can also [manage existing users](/deploy-manage/users-roles/cloud-organization/manage-users.md#manage-existing-users) and [manage users through the {{ecloud}} API](/deploy-manage/users-roles/cloud-organization/manage-users.md#ec-api-organizations). @@ -37,5 +43,5 @@ Assign the following roles to new or existing users based on levels of access to | Role | Allowed actions in AutoOps | | --- | --- | -| **Organization owner** | - View events and metrics reports
- Add or edit customizations and notification preferences
- Connect and disconnect clusters | -| **Connected cluster access** | **Viewer**
- View events and metrics reports

**Admin** for all connected clusters
- View events and metrics reports
- Add or edit customizations and notification preferences
- Connect and disconnect clusters

**Admin** for selected clusters
- View events and metrics reports
- Add or edit customizations and notification preferences
- Connect clusters | +| **Organization owner** | View events and metrics reports
Add or edit customizations and notification preferences
Connect and disconnect clusters | +| **Connected cluster access** | **Viewer**:
View events and metrics reports

**Admin** for all connected clusters:
View events and metrics reports
Add or edit customizations and notification preferences
Connect and disconnect clusters

**Admin** for selected clusters:
View events and metrics reports
Add or edit customizations and notification preferences
Connect clusters | diff --git a/deploy-manage/toc.yml b/deploy-manage/toc.yml index 9ccdbf5ed4..6d4ef3636e 100644 --- a/deploy-manage/toc.yml +++ b/deploy-manage/toc.yml @@ -673,7 +673,6 @@ toc: - file: monitor/autoops/ec-autoops-faq.md - hidden: monitor/autoops/cc-autoops-as-cloud-connected.md - hidden: monitor/autoops/cc-connect-self-managed-to-autoops.md - - hidden: monitor/autoops/cc-manage-connected-clusters.md - hidden: monitor/autoops/cc-manage-users.md - hidden: monitor/autoops/cc-cloud-connect-autoops-faq.md - hidden: monitor/autoops/cc-cloud-connect-autoops-troubleshooting.md From fe1a3c75f8651c24c65c936862919dc29ca896de Mon Sep 17 00:00:00 2001 From: wajihaparvez Date: Tue, 29 Jul 2025 12:53:58 -0400 Subject: [PATCH 09/11] more PR feedback + commented out section --- .../cc-connect-self-managed-to-autoops.md | 43 +++++++++++++++++-- deploy-manage/toc.yml | 2 +- 2 files changed, 41 insertions(+), 4 deletions(-) diff --git a/deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops.md b/deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops.md index e85c27edef..91e98cf12d 100644 --- a/deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops.md +++ b/deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops.md @@ -27,6 +27,42 @@ Ensure your system meets the following requirements before proceeding: | Cluster privileges | `monitor`, `read_ilm`, and `read_slm` | | Index privileges | `*` indices: `monitor`, `view_index_metadata` | + ## Connect to AutoOps :::{note} @@ -38,7 +74,8 @@ Ensure your system meets the following requirements before proceeding: * 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, in the **AutoOps** section, select **Connect**. +3. On the **Connected clusters** page, select **Accept and Continue**. This button only appears the first time you connect a cluster. +3. On the **Connect your self-managed cluster** page, in the **AutoOps** section, select **Connect**. ### Select installation method @@ -80,7 +117,7 @@ The wizard will generate an installation command based on your configuration. De * Windows :::{tip} -We recommend installing the agent on a machine different from the one on which your self-managed cluster is running. +If the machine where your self-managed cluster is running experiences technical issues, shipping metrics to AutoOps will be interrupted. We recommend installing the agent on a separate machine. ::: Complete the following steps to run the command: @@ -125,7 +162,7 @@ After you've completed the setup, you can access AutoOps for your self-managed c ## Connect additional clusters -To connect more self-managed clusters, we recommend repeating the steps to [connect your self-managed cluster to AutoOps](/deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops.md). +To connect more self-managed clusters, we recommend repeating the steps to [connect your self-managed cluster to AutoOps](#connect-your-self-managed-cluster-to-autoops). You can use the same installation command to connect multiple clusters, but each cluster needs a separate, dedicated {{agent}}. diff --git a/deploy-manage/toc.yml b/deploy-manage/toc.yml index 6d4ef3636e..6f1785321e 100644 --- a/deploy-manage/toc.yml +++ b/deploy-manage/toc.yml @@ -362,7 +362,6 @@ toc: - file: reference-architectures.md children: - file: reference-architectures/hotfrozen-high-availability.md - - hidden: cloud-connect.md - file: stack-settings.md - file: tools.md children: @@ -652,6 +651,7 @@ toc: - file: remote-clusters/remote-clusters-migrate.md - file: remote-clusters/remote-clusters-settings.md - file: remote-clusters/eck-remote-clusters.md + - hidden: cloud-connect.md - file: monitor.md children: - file: monitor/autoops.md From 31d85e95efc5d6f5c110ae163a6948e811e6a67d Mon Sep 17 00:00:00 2001 From: wajihaparvez Date: Tue, 29 Jul 2025 12:57:38 -0400 Subject: [PATCH 10/11] fix anchor --- .../monitor/autoops/cc-connect-self-managed-to-autoops.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops.md b/deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops.md index 91e98cf12d..75449cf364 100644 --- a/deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops.md +++ b/deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops.md @@ -162,7 +162,7 @@ After you've completed the setup, you can access AutoOps for your self-managed c ## Connect additional clusters -To connect more self-managed clusters, we recommend repeating the steps to [connect your self-managed cluster to AutoOps](#connect-your-self-managed-cluster-to-autoops). +To connect more self-managed clusters, we recommend repeating the steps to [connect to AutoOps](#connect-to-autoops). You can use the same installation command to connect multiple clusters, but each cluster needs a separate, dedicated {{agent}}. From b6932eec71b5be1193ee4e4fbc8a0b6c00d5751c Mon Sep 17 00:00:00 2001 From: wajihaparvez Date: Tue, 29 Jul 2025 17:09:15 -0400 Subject: [PATCH 11/11] more info about privileges + new vs. existing users --- .../autoops/cc-autoops-as-cloud-connected.md | 8 +- ...c-cloud-connect-autoops-troubleshooting.md | 6 +- .../cc-connect-self-managed-to-autoops.md | 127 ++++++++++++------ 3 files changed, 90 insertions(+), 51 deletions(-) diff --git a/deploy-manage/monitor/autoops/cc-autoops-as-cloud-connected.md b/deploy-manage/monitor/autoops/cc-autoops-as-cloud-connected.md index ae10605696..a68182d229 100644 --- a/deploy-manage/monitor/autoops/cc-autoops-as-cloud-connected.md +++ b/deploy-manage/monitor/autoops/cc-autoops-as-cloud-connected.md @@ -17,7 +17,7 @@ Cloud Connect enables users of self-managed clusters to use {{ecloud}} services. 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. \ No newline at end of file +* 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 \ No newline at end of file diff --git a/deploy-manage/monitor/autoops/cc-cloud-connect-autoops-troubleshooting.md b/deploy-manage/monitor/autoops/cc-cloud-connect-autoops-troubleshooting.md index e031de42c2..c250ab4460 100644 --- a/deploy-manage/monitor/autoops/cc-cloud-connect-autoops-troubleshooting.md +++ b/deploy-manage/monitor/autoops/cc-cloud-connect-autoops-troubleshooting.md @@ -47,14 +47,14 @@ The following table shows the errors you might encounter if something goes wrong | 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_401` | Authentication failed | Connection denied because of an authentication error. Verify that your API key and password are correct and all [necessary privileges](/deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops.md#configure-agent) 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. | +| `HTTP_0` | Connection error | {{agent}} couldn't connect to the cluster. There may be various reasons for this issue. Review the [documentation](/deploy-manage/monitor/autoops/cc-autoops-as-cloud-connected.md) 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) if the issue persists. | | `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. | +| `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://cloud.elastic.co/login?source=support&fromURI=https%3A%2F%2Fauth.elastic.co%2Fapp%2Felastic-customer_dreammachinecustomer_1%2Fexkgw653gkKlRTQXQ1t7%2Fsso%2Fsaml) 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. | \ No newline at end of file diff --git a/deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops.md b/deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops.md index 75449cf364..5dc430f652 100644 --- a/deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops.md +++ b/deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops.md @@ -9,9 +9,9 @@ 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. After you choose to connect AutoOps to your self-managed cluster, an installation wizard will guide you through the steps of installing {{agent}} to send metrics from your self-managed cluster to AutoOps in {{ecloud}}. +To use AutoOps with your self-managed cluster, you first need to create an {{ecloud}} account or log in to your existing account. An installation wizard will then guide you through the steps of installing {{agent}} to send metrics from your self-managed cluster to AutoOps in {{ecloud}}. -Complete the steps in the following subsections to connect your cluster to AutoOps. The setup takes about 10 minutes. +Complete the steps in the following subsections to connect your cluster to AutoOps. The connection process takes about 10 minutes. ## Prerequisites @@ -20,18 +20,83 @@ Ensure your system meets the following requirements before proceeding: * Your cluster is on a [supported {{es}} version](https://www.elastic.co/support/eol). * You have an [Enterprise self-managed license](https://www.elastic.co/subscriptions) or an active self-managed [free trial](https://cloud.elastic.co/registration). * The agent you install for the connection is allowed to send metrics outside your organization to {{ecloud}}. -* You have a dedicated user with the following permissions to set up {{agent}}: - | Setting | Privileges | +## Connect to AutoOps + +:::{note} +:::{include} /deploy-manage/monitor/_snippets/single-cloud-org.md +::: +::: + +:::::{tab-set} +:group: existing-or-new-cloud-account + +::::{tab-item} Existing account +:sync: existing + +If you already have an {{ecloud}} account: +1. Log in to [{{ecloud}}](https://cloud.elastic.co?page=docs&placement=docs-body). +2. On your home page, in the **Connected clusters** section, select **Connect self-managed cluster**. +3. On the **Connected clusters** page, select **Accept and continue**. This button only appears the first time you connect a cluster. +4. On the **Connect your self-managed cluster** page, in the **AutoOps** section, select **Connect**. +:::: + +::::{tab-item} New account +:sync: new + +If you don’t have an existing {{ecloud}} account: +1. Sign up for an account. + +2. Follow the prompts on your screen to create an organization. +3. Go through the installation wizard as detailed in the following sections. +:::: + +::::: + +### Select installation method + +This is the first step of the installation wizard. Your cluster ships metrics to AutoOps with the help of {{agent}}. + +Select one of the following methods to install {{agent}}: + +* Kubernetes +* Docker +* Linux +* Windows + +:::{important} +Using AutoOps for your self-managed cluster requires a new, dedicated {{agent}}. You must install an agent even if you already have an existing one for other purposes. +::: + +### 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. +* **Preferred authentication method**: Choose one of the following: +:::::{tab-set} +:group: api-key-or-basic + +::::{tab-item} API key +:sync: api-key + +With this authentication method, you need to [create an API key](/solutions/observability/apm/grant-access-using-api-keys.md) with the following privileges to grant access to your cluster: + +| Setting | Privileges | | --- | --- | | Cluster privileges | `monitor`, `read_ilm`, and `read_slm` | - | Index privileges | `*` indices: `monitor`, `view_index_metadata` | + | Index privileges | Indices: `*`
`monitor`, `view_index_metadata`, `allow_restricted_indices: true` | - -## 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 **Connected clusters** page, select **Accept and Continue**. This button only appears the first time you connect a cluster. -3. On the **Connect your self-managed cluster** page, in the **AutoOps** section, select **Connect**. +* Alternatively, manually assign the following privileges in your account: -### Select installation method - -Your cluster ships metrics to AutoOps with the help of {{agent}}. - -:::{important} -Using AutoOps for your self-managed cluster requires a new, dedicated {{agent}}. You must install an agent even if you already have an existing one for other purposes. + | 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 {{agent}} to access restricted indices. ::: +:::: -Select one of the following methods to install {{agent}}: - -* Kubernetes -* Docker -* Linux -* Windows - -### 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. -* **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. @@ -117,7 +156,7 @@ The wizard will generate an installation command based on your configuration. De * Windows :::{tip} -If the machine where your self-managed cluster is running experiences technical issues, shipping metrics to AutoOps will be interrupted. We recommend installing the agent on a separate machine. +We recommend installing the agent on a separate machine from the one where your self-managed cluster is running. ::: Complete the following steps to run the command: