Skip to content

Commit 53a7eb2

Browse files
authored
[Private preview] Add page about connecting localhost to AutoOps (#2486)
This PR adds a page explaining [how to connect a local development cluster to AutoOps](https://docs.google.com/document/d/1bhi-ChuqS1lnTkC9fmseXIPC3Y04k1tC8q8g7UE5hpY/edit?tab=t.u0r4otlndm4k#heading=h.wolypdlz1nl2) through Cloud Connect + some small clarifications. ### Note to reviewers: - @arnonst will check for accuracy of the workflow and the code snippets. - Users of this new **Connect your local development cluster to AutoOps** page will follow almost the same steps as the ones in [Connect your self-managed cluster to AutoOps](https://www.elastic.co/docs/deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops), so I opted to send them to that page and pointed out the differences in their workflow. Alternatively, we could duplicate all the instructions (in snippets) and edit for the differences, but I'm hesitant about this approach because a) the page will be much longer and b) the differences might not stand out. Let me know what you think. - I didn't add the `applies_to ECE` or `ECK` tags to the **Connect your local development cluster to AutoOps** page because this is for [local dev install](https://www.elastic.co/docs/deploy-manage/deploy/self-managed/local-development-installation-quickstart) only, but I'm not sure about this. Please correct me if I'm wrong. Closes: #2483
1 parent 1739c6c commit 53a7eb2

File tree

6 files changed

+85
-20
lines changed

6 files changed

+85
-20
lines changed
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
:::{dropdown} Can I use Cloud Connect to connect my {{ech}} clusters to AutoOps?
22

33
This path is not supported. Currently, we only support using Cloud Connect to connect ECE, ECK, and self-managed clusters to AutoOps.
4+
5+
For {{ech}} clusters, AutoOps is set up and enabled automatically in all supported [regions](/deploy-manage/monitor/autoops/ec-autoops-regions.md), and can be [accessed](/deploy-manage/monitor/autoops/ec-autoops-how-to-access.md) from the deployment overview page.
46
:::

deploy-manage/monitor/autoops.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,6 @@ products:
1212

1313
AutoOps diagnoses issues in {{es}} by analyzing hundreds of metrics, providing root-cause analysis and accurate resolution paths. With AutoOps, customers can prevent and resolve issues, cut down administration time, and optimize resource utilization.
1414

15-
AutoOps is currently only available for [{{ech}} deployments](/deploy-manage/deploy/elastic-cloud/cloud-hosted.md).
16-
1715
:::{image} /deploy-manage/images/cloud-autoops-overview-page.png
1816
:alt: The Overview page
1917
:::

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,8 @@ Cloud Connect enables users of ECE, ECK, and self-managed clusters to use {{eclo
1717

1818
In this section, you'll find the following information:
1919

20-
* How to [connect your cluster to AutoOps](/deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops.md)
20+
* How to [connect your self-managed cluster to AutoOps](/deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops.md)
21+
* How to [connect your local development cluster to AutoOps](/deploy-manage/monitor/autoops/cc-connect-local-dev-to-autoops.md)
2122
* How to [manage users of your connected clusters](/deploy-manage/monitor/autoops/cc-manage-users.md)
2223
* [FAQs](/deploy-manage/monitor/autoops/cc-cloud-connect-autoops-faq.md) about AutoOps for your clusters
2324
* A [troubleshooting guide](/deploy-manage/monitor/autoops/cc-cloud-connect-autoops-troubleshooting.md) to help you with any issues you may encounter
Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
---
2+
applies_to:
3+
deployment:
4+
self:
5+
navigation_title: Connect your local development cluster
6+
---
7+
8+
# Connect your local development cluster to AutoOps
9+
10+
If you have an {{es}} cluster set up for local development or testing, you can connect it to AutoOps using Docker.
11+
12+
## Prerequisites
13+
14+
Ensure your system meets the following requirements before proceeding:
15+
16+
* You have set up [{{es}} for local development](/deploy-manage/deploy/self-managed/local-development-installation-quickstart.md).
17+
* You have installed [Docker Desktop](https://www.docker.com/products/docker-desktop).
18+
* You have an {{ecloud}} account with the [Organization owner role](/deploy-manage/monitor/autoops/cc-manage-users.md#assign-roles).
19+
20+
## Connect your local development cluster to AutoOps
21+
22+
Complete the following steps to connect your local development cluster to AutoOps.
23+
24+
1. Run the following command in your terminal to open the `/etc/hosts` file in a text editor with administrator privileges:
25+
26+
```sh
27+
vim /etc/hosts
28+
```
29+
2. On a new line in the `/etc/hosts` file, add an entry to map the {{es}} cluster URL to the IP address representing the local development cluster.
30+
31+
The entry should be formatted as `127.0.0.1 {{hostname}}`.
32+
3. Save the changes.
33+
4. In your terminal, run the following command to reload the hostname service:
34+
* For Linux:
35+
```sh
36+
/bin/systemctl restart systemd-hostnamed
37+
```
38+
* For macOS:
39+
```sh
40+
sudo dscacheutil -flushcache
41+
```
42+
5. Follow the instructions to [Connect to AutoOps](/deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops.md#connect-to-autoops) with the following differences:
43+
* In the [Select installation method](/deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops.md#select-installation-method) step, select **Docker**.
44+
* In the [Configure agent](/deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops.md#configure-agent) step, when prompted to enter your **{{es}} endpoint URL**, enter the name of your local development cluster or enter the following:
45+
```sh
46+
http://localhost:9200
47+
```
48+
* In the [Install agent](/deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops.md#install-agent) step, paste the command into the text editor and replace `docker run -d \` with:
49+
```sh
50+
docker run -d --network host \
51+
```
52+
53+
This replacement is also required if your cluster is running on macOS.
54+
55+
After completing all the steps, you can [Access AutoOps](/deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops.md#access-autoops).
56+
57+
58+
59+

deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops.md

Lines changed: 21 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,19 @@ applies_to:
44
self:
55
ece:
66
eck:
7-
navigation_title: Connect your cluster
7+
navigation_title: Connect your self-managed cluster
88
---
99

10-
# Connect your cluster to AutoOps
10+
# Connect your self-managed cluster to AutoOps
1111

1212
To use AutoOps with your ECE, ECK, or 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 cluster to AutoOps in {{ecloud}}.
1313

1414
Complete the steps in the following subsections to connect your cluster to AutoOps. The connection process takes about 10 minutes.
1515

16+
:::{note}
17+
If you have an {{es}} cluster set up for local development or testing, you can connect it to AutoOps using Docker. Refer to [](/deploy-manage/monitor/autoops/cc-connect-local-dev-to-autoops.md).
18+
:::
19+
1620
## Prerequisites
1721

1822
Ensure your system meets the following requirements before proceeding:
@@ -21,7 +25,7 @@ Ensure your system meets the following requirements before proceeding:
2125
* Your cluster is on an [Enterprise self-managed license](https://www.elastic.co/subscriptions) or an active self-managed [trial](https://cloud.elastic.co/registration).
2226
* The agent you install for the connection is allowed to send metrics to {{ecloud}}.
2327

24-
## Connect to AutoOps
28+
## Connect to AutoOps (private preview) [connect-to-autoops]
2529

2630
:::{note}
2731
:::{include} /deploy-manage/monitor/_snippets/single-cloud-org.md
@@ -86,8 +90,8 @@ This is the first step of the installation wizard. Your cluster ships metrics to
8690

8791
Select one of the following methods to install {{agent}}:
8892

89-
* Kubernetes
90-
* Docker
93+
* **Kubernetes**
94+
* **Docker**
9195
<!-- Not applicable for private preview
9296
* Linux
9397
* Windows
@@ -226,18 +230,18 @@ Complete the following steps to run the command:
226230
1. Copy the command.
227231
2. Paste it into a text editor and update the placeholder values in the following environment variables:
228232

229-
| Environment variable | Description |
230-
| --- | --- |
231-
| `AUTOOPS_OTEL_URL` | The {{ecloud}} URL to which {{agent}} ships data. The URL is generated based on the CSP and region you pick. <br> This URL shouldn't be edited. |
232-
| `AUTOOPS_ES_URL` | The URL {{agent}} uses to communicate with {{es}}. |
233-
| `ELASTICSEARCH_READ_API_KEY` | The API key for API key authentication to access the cluster. It combines the `${id}:${api_key}` values. <br> This variable shouldn't be used with `ELASTICSEARCH_READ_USERNAME` and `ELASTICSEARCH_READ_PASSWORD`. |
234-
| `ELASTICSEARCH_READ_USERNAME` | The username for basic authentication to access the cluster. <br> This variable should be used with `ELASTICSEARCH_READ_PASSWORD`. |
235-
| `ELASTICSEARCH_READ_PASSWORD` | The password for basic authentication to access the cluster. <br> This variable should be used with `ELASTICSEARCH_READ_USERNAME`. |
236-
| `ELASTIC_CLOUD_CONNECTED_MODE_API_KEY` | The {{ecloud}} API Key used to register the cluster. <br> This key shouldn't be edited. |
237-
| `AUTOOPS_TEMP_RESOURCE_ID` | The temporary ID for the current installation wizard. |
238-
239-
4. Run the command from the machine where you want to install the agent.
240-
5. Return to the wizard and select **I have run the command**.
233+
| Environment variable | Description |
234+
| --- | --- |
235+
| `AUTOOPS_OTEL_URL` | The {{ecloud}} URL to which {{agent}} ships data. The URL is generated based on the CSP and region you pick. <br> This URL shouldn't be edited. |
236+
| `AUTOOPS_ES_URL` | The URL {{agent}} uses to communicate with {{es}}. |
237+
| `ELASTICSEARCH_READ_API_KEY` | The API key for API key authentication to access the cluster. It combines the `${id}:${api_key}` values. <br> This variable shouldn't be used with `ELASTICSEARCH_READ_USERNAME` and `ELASTICSEARCH_READ_PASSWORD`. |
238+
| `ELASTICSEARCH_READ_USERNAME` | The username for basic authentication to access the cluster. <br> This variable should be used with `ELASTICSEARCH_READ_PASSWORD`. |
239+
| `ELASTICSEARCH_READ_PASSWORD` | The password for basic authentication to access the cluster. <br> This variable should be used with `ELASTICSEARCH_READ_USERNAME`. |
240+
| `ELASTIC_CLOUD_CONNECTED_MODE_API_KEY` | The {{ecloud}} API Key used to register the cluster. <br> This key shouldn't be edited. |
241+
| `AUTOOPS_TEMP_RESOURCE_ID` | The temporary ID for the current installation wizard. |
242+
243+
3. Run the command from the machine where you want to install the agent.
244+
4. Return to the wizard and select **I have run the command**.
241245

242246
It might take a few minutes for your cluster details to be validated and the first metrics to be shipped to AutoOps.
243247

deploy-manage/toc.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -676,6 +676,7 @@ toc:
676676
- file: monitor/autoops/ec-autoops-faq.md
677677
- hidden: monitor/autoops/cc-autoops-as-cloud-connected.md
678678
- hidden: monitor/autoops/cc-connect-self-managed-to-autoops.md
679+
- hidden: monitor/autoops/cc-connect-local-dev-to-autoops.md
679680
- hidden: monitor/autoops/cc-manage-users.md
680681
- hidden: monitor/autoops/cc-cloud-connect-autoops-faq.md
681682
- hidden: monitor/autoops/cc-cloud-connect-autoops-troubleshooting.md

0 commit comments

Comments
 (0)