diff --git a/deploy-manage/images/self-managed-autoops-diagram.png b/deploy-manage/images/self-managed-autoops-diagram.png new file mode 100644 index 0000000000..e7ac9df6c0 Binary files /dev/null and b/deploy-manage/images/self-managed-autoops-diagram.png differ diff --git a/deploy-manage/monitor/_snippets/autoops-cc-components.md b/deploy-manage/monitor/_snippets/autoops-cc-components.md new file mode 100644 index 0000000000..a66b29433d --- /dev/null +++ b/deploy-manage/monitor/_snippets/autoops-cc-components.md @@ -0,0 +1,3 @@ +1. {{agent}} connects to your ECE, ECK, or self-managed {{es}} cluster. +2. The agent registers your cluster with {{ecloud}} using the Cloud Connect API. +3. The agent begins to send metrics from your cluster to AutoOps in your selected CSP region. 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 eb43be2f13..8ae4346c37 100644 --- a/deploy-manage/monitor/autoops/cc-autoops-as-cloud-connected.md +++ b/deploy-manage/monitor/autoops/cc-autoops-as-cloud-connected.md @@ -12,10 +12,26 @@ products: # AutoOps for self-managed clusters -For ECE ({{ece}}), ECK ({{eck}}), and self-managed clusters, AutoOps can be set up in all supported [regions](ec-autoops-regions.md#autoops-for-self-managed-clusters-regions) through [Cloud Connect](/deploy-manage/cloud-connect.md). More regions are coming soon. +For ECE ({{ece}}), ECK ({{eck}}), and self-managed {{es}} clusters, AutoOps can be set up in all supported [regions](ec-autoops-regions.md#autoops-for-self-managed-clusters-regions) through [Cloud Connect](/deploy-manage/cloud-connect.md). More regions are coming soon. Cloud Connect enables users of ECE, ECK, and 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. +## How your self-managed cluster connects to AutoOps + +To connect your ECE, ECK, or self-managed cluster to AutoOps, you have to use your {{ecloud}} account to install {{agent}}. After that, the process can be broken down into three components: + +:::{include} /deploy-manage/monitor/_snippets/autoops-cc-components.md +::: + +:::{image} /deploy-manage/images/self-managed-autoops-diagram.png +:alt: Diagram depicting how AutoOps for self-managed clusters works +::: + +For instructions on how to get started, refer to [](/deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops.md). + +After this setup is complete, you can start using AutoOps to monitor your cluster. Learn more about what you can do with AutoOps in [views](/deploy-manage/monitor/autoops/views.md) and [events](/deploy-manage/monitor/autoops/ec-autoops-events.md). + + ## Section overview In this section, you'll find the following information: @@ -26,4 +42,5 @@ In this section, you'll find the following information: * A [troubleshooting guide](/deploy-manage/monitor/autoops/cc-cloud-connect-autoops-troubleshooting.md) to help you with any issues you may encounter :::{tip} -Refer to our [FAQ](/deploy-manage/monitor/autoops/ec-autoops-faq.md#questions-about-autoops-for-self-managed-clusters) for answers to commonly asked questions about AutoOps for self-managed clusters. \ No newline at end of file +Refer to our [FAQ](/deploy-manage/monitor/autoops/ec-autoops-faq.md#questions-about-autoops-for-self-managed-clusters) for answers to commonly asked questions about AutoOps for self-managed clusters. +::: \ 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 0a6fd44f75..61fd9ebb20 100644 --- a/deploy-manage/monitor/autoops/cc-cloud-connect-autoops-troubleshooting.md +++ b/deploy-manage/monitor/autoops/cc-cloud-connect-autoops-troubleshooting.md @@ -44,42 +44,12 @@ $$$firewall$$$**My organization's firewall may be preventing {{agent}} from coll Run the following tests within the context of your execution environment. That is, if your chosen installation method is Kubernetes, run the commands from within the pod; for Docker, run the commands from within the container, and so on. ::: - There are three main components of {{agent}}'s connection with your system: + There are [three main components](/deploy-manage/monitor/autoops/cc-autoops-as-cloud-connected.md#how-your-self-managed-cluster-connects-to-autoops) of {{agent}}'s connection with your system: - 1. {{agent}} registers your cluster with {{ecloud}} - 2. {{agent}} connects to your cluster - 3. {{agent}} sends metrics from your cluster to {{ecloud}} - - If there is an issue with the first component, the agent will stop working and your logs might look like: - - ```sh - ... failed to register Cloud Connected Mode: ... Post \"https://api.elastic-cloud.com/api/v1/cloud-connected/clusters\": ... - ``` - - To test if your organization is not allowing the agent to register your cluster with {{ecloud}}, run the following command: - - ```json - curl -XPOST -i \ - https://api.elastic-cloud.com/api/v1/cloud-connected/clusters \ - -H 'Content-Type: application/json' \ - -d '{"self_managed_cluster": {"id": "my-cluster-uuid", "name": "my-cluster-name", "version": "9.1.0"}, "license": {"uid": "my-license-id", "type": "basic"}}' - ``` - - The command should return an HTTP 401 response similar to: - - ```json - {"UnauthorizedMessages":["Invalid credential headers"],"Cause":null} - ``` - If you do not receive a similar response, configure your HTTP proxy to allow it to reach the URL (with headers and a JSON body): - - ```json - POST https://api.elastic-cloud.com/api/v1/cloud-connected/clusters - ``` - :::{note} - If you are using Docker, you may need to complete this configuration directly via the `HTTP_PROXY`, `HTTPS_PROXY`, and `NO_PROXY` environment variables. + :::{include} /deploy-manage/monitor/_snippets/autoops-cc-components.md ::: - If there is an issue with the second component, {{agent}} cannot connect to your cluster. To test if your organization is not allowing this connection, run the following command depending on your chosen authentication method: + If there is an issue with the first component, {{agent}} cannot connect to your cluster. To test if your organization is not allowing this connection, run the following command depending on your chosen authentication method: :::::{tab-set} :group: api-key-or-basic @@ -138,6 +108,34 @@ $$$firewall$$$**My organization's firewall may be preventing {{agent}} from coll | You are using a custom SSL/TLS configuration with {{es}} | Disable SSL/TLS verification so that your system trusts all certificates. We do not recommend disabling verification in production environments.

If you are using API key authentication, run the following command:

`curl -XGET --insecure -i $AUTOOPS_ES_URL \ -H "Authorization: ApiKey $AUTOOPS_ES_API_KEY"`.

If you are using username/password authentication, run the following command:

`curl -XGET --insecure -i $AUTOOPS_ES_URL \ -u $AUTOOPS_ES_USERNAME`

If the issue is resolved, you need to configure your custom SSL/TLS settings with {{agent}}. If the issue persists, contact [Elastic support](https://support.elastic.co/).| | You are connecting a local development cluster using Docker without specifying `--network host` | - Make sure you are following all the steps to [connect your local development cluster to AutoOps](/deploy-manage/monitor/autoops/cc-connect-local-dev-to-autoops.md#connect-your-local-development-cluster-to-autoops).
- In the [Install agent](/deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops.md#install-agent) step, make sure you are replacing `docker run -d \` with `docker run -d --network host \`. | + If there is an issue with the second component, the agent will stop working and your logs might look like: + + ```sh + ... failed to register Cloud Connected Mode: ... Post \"https://api.elastic-cloud.com/api/v1/cloud-connected/clusters\": ... + ``` + + To test if your organization is not allowing the agent to register your cluster with {{ecloud}}, run the following command: + + ```json + curl -XPOST -i \ + https://api.elastic-cloud.com/api/v1/cloud-connected/clusters \ + -H 'Content-Type: application/json' \ + -d '{"self_managed_cluster": {"id": "my-cluster-uuid", "name": "my-cluster-name", "version": "9.1.0"}, "license": {"uid": "my-license-id", "type": "basic"}}' + ``` + + The command should return an HTTP 401 response similar to: + + ```json + {"UnauthorizedMessages":["Invalid credential headers"],"Cause":null} + ``` + If you do not receive a similar response, configure your HTTP proxy to allow it to reach the URL (with headers and a JSON body): + + ```json + POST https://api.elastic-cloud.com/api/v1/cloud-connected/clusters + ``` + :::{note} + If you are using Docker, you may need to complete this configuration directly via the `HTTP_PROXY`, `HTTPS_PROXY`, and `NO_PROXY` environment variables. + ::: If there is an issue with the third component, the agent will attempt to establish the connection and your logs might look like: