Skip to content

Commit ad87cad

Browse files
authored
Add diagram and explanation to AutoOps for self-managed overview doc (#3767)
This PR adds a diagram and explanation of how self-managed clusters are connected to AutoOps. For consistency, I also updated the connection steps on the troubleshooting page. Closes #3765
1 parent ca595c0 commit ad87cad

File tree

4 files changed

+53
-35
lines changed

4 files changed

+53
-35
lines changed
22.4 KB
Loading
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
1. {{agent}} connects to your ECE, ECK, or self-managed {{es}} cluster.
2+
2. The agent registers your cluster with {{ecloud}} using the Cloud Connect API.
3+
3. The agent begins to send metrics from your cluster to AutoOps in your selected CSP region.

deploy-manage/monitor/autoops/cc-autoops-as-cloud-connected.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,26 @@ products:
1212

1313
# AutoOps for self-managed clusters
1414

15-
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.
15+
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.
1616

1717
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.
1818

19+
## How your self-managed cluster connects to AutoOps
20+
21+
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:
22+
23+
:::{include} /deploy-manage/monitor/_snippets/autoops-cc-components.md
24+
:::
25+
26+
:::{image} /deploy-manage/images/self-managed-autoops-diagram.png
27+
:alt: Diagram depicting how AutoOps for self-managed clusters works
28+
:::
29+
30+
For instructions on how to get started, refer to [](/deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops.md).
31+
32+
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).
33+
34+
1935
## Section overview
2036

2137
In this section, you'll find the following information:
@@ -26,4 +42,5 @@ In this section, you'll find the following information:
2642
* A [troubleshooting guide](/deploy-manage/monitor/autoops/cc-cloud-connect-autoops-troubleshooting.md) to help you with any issues you may encounter
2743

2844
:::{tip}
29-
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.
45+
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.
46+
:::

deploy-manage/monitor/autoops/cc-cloud-connect-autoops-troubleshooting.md

Lines changed: 31 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -44,42 +44,12 @@ $$$firewall$$$**My organization's firewall may be preventing {{agent}} from coll
4444
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.
4545
:::
4646

47-
There are three main components of {{agent}}'s connection with your system:
47+
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:
4848

49-
1. {{agent}} registers your cluster with {{ecloud}}
50-
2. {{agent}} connects to your cluster
51-
3. {{agent}} sends metrics from your cluster to {{ecloud}}
52-
53-
If there is an issue with the first component, the agent will stop working and your logs might look like:
54-
55-
```sh
56-
... failed to register Cloud Connected Mode: ... Post \"https://api.elastic-cloud.com/api/v1/cloud-connected/clusters\": ...
57-
```
58-
59-
To test if your organization is not allowing the agent to register your cluster with {{ecloud}}, run the following command:
60-
61-
```json
62-
curl -XPOST -i \
63-
https://api.elastic-cloud.com/api/v1/cloud-connected/clusters \
64-
-H 'Content-Type: application/json' \
65-
-d '{"self_managed_cluster": {"id": "my-cluster-uuid", "name": "my-cluster-name", "version": "9.1.0"}, "license": {"uid": "my-license-id", "type": "basic"}}'
66-
```
67-
68-
The command should return an HTTP 401 response similar to:
69-
70-
```json
71-
{"UnauthorizedMessages":["Invalid credential headers"],"Cause":null}
72-
```
73-
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):
74-
75-
```json
76-
POST https://api.elastic-cloud.com/api/v1/cloud-connected/clusters
77-
```
78-
:::{note}
79-
If you are using Docker, you may need to complete this configuration directly via the `HTTP_PROXY`, `HTTPS_PROXY`, and `NO_PROXY` environment variables.
49+
:::{include} /deploy-manage/monitor/_snippets/autoops-cc-components.md
8050
:::
8151

82-
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:
52+
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:
8353

8454
:::::{tab-set}
8555
:group: api-key-or-basic
@@ -138,6 +108,34 @@ $$$firewall$$$**My organization's firewall may be preventing {{agent}} from coll
138108
| 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. <br><br> If you are using API key authentication, run the following command: <br><br>`curl -XGET --insecure -i $AUTOOPS_ES_URL \ -H "Authorization: ApiKey $AUTOOPS_ES_API_KEY"`. <br><br> If you are using username/password authentication, run the following command: <br><br> `curl -XGET --insecure -i $AUTOOPS_ES_URL \ -u $AUTOOPS_ES_USERNAME` <br><br> 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/).|
139109
| 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). <br> - 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 \`. |
140110

111+
If there is an issue with the second component, the agent will stop working and your logs might look like:
112+
113+
```sh
114+
... failed to register Cloud Connected Mode: ... Post \"https://api.elastic-cloud.com/api/v1/cloud-connected/clusters\": ...
115+
```
116+
117+
To test if your organization is not allowing the agent to register your cluster with {{ecloud}}, run the following command:
118+
119+
```json
120+
curl -XPOST -i \
121+
https://api.elastic-cloud.com/api/v1/cloud-connected/clusters \
122+
-H 'Content-Type: application/json' \
123+
-d '{"self_managed_cluster": {"id": "my-cluster-uuid", "name": "my-cluster-name", "version": "9.1.0"}, "license": {"uid": "my-license-id", "type": "basic"}}'
124+
```
125+
126+
The command should return an HTTP 401 response similar to:
127+
128+
```json
129+
{"UnauthorizedMessages":["Invalid credential headers"],"Cause":null}
130+
```
131+
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):
132+
133+
```json
134+
POST https://api.elastic-cloud.com/api/v1/cloud-connected/clusters
135+
```
136+
:::{note}
137+
If you are using Docker, you may need to complete this configuration directly via the `HTTP_PROXY`, `HTTPS_PROXY`, and `NO_PROXY` environment variables.
138+
:::
141139

142140
If there is an issue with the third component, the agent will attempt to establish the connection and your logs might look like:
143141

0 commit comments

Comments
 (0)