Skip to content

Commit 659559b

Browse files
authored
[Private preview] Update AutoOps for self-managed clusters docs (#3160)
Closes: - elastic/opex-product#621 - elastic/opex-product#622 - elastic/opex-product#630 - elastic/opex-product#632 - elastic/opex-product#637
1 parent a2d9f13 commit 659559b

File tree

3 files changed

+26
-10
lines changed

3 files changed

+26
-10
lines changed

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

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,10 @@ Find answers to your questions about AutoOps for ECE, ECK, and self-managed clus
2424
* [Can I use macOS to install {{agent}} for this feature?](#macos-install)
2525
* [Do I have to define an Elastic IP address to enable the agent to send data to {{ecloud}}?](#elastic-ip-address)
2626

27-
**Questions about collected metrics**
27+
**Questions about collected metrics and data**
2828
* [Where are AutoOps metrics stored?](#autoops-metrics-storage)
2929
* [What information does {{agent}} extract from my cluster?](#extracted-info)
30+
* [How does AutoOps gather data from my cluster and ensure its security?](#data-gathering)
3031

3132
## General questions
3233
$$$why-autoops$$$ **Why should I use AutoOps for my clusters?**
@@ -42,7 +43,7 @@ $$$autoops-metrics-cost$$$ **Is there an added cost for shipping metrics data to
4243
You can [choose the CSP region where your data is stored](#autoops-metrics-storage).
4344

4445
$$$es-versions$$$ **Which versions of {{es}} does AutoOps support?**
45-
: AutoOps is compatible with all [supported {{es}} versions](https://www.elastic.co/support/eol).
46+
: AutoOps is compatible with [supported {{es}} versions](https://www.elastic.co/support/eol) (7.17.x and above).
4647

4748
$$$deployment-types$$$ **Which deployment types can be connected to AutoOps?**
4849
: You can connect to AutoOps on a standalone {{stack}}, ECE ({{ece}}), or ECK ({{eck}}) deployment.
@@ -65,7 +66,7 @@ $$$elastic-ip-address$$$ **Do I have to define an Elastic IP address to enable t
6566

6667
: For more information, refer to [](/deploy-manage/security/elastic-cloud-static-ips.md).
6768

68-
## Questions about collected metrics
69+
## Questions about collected metrics and data
6970
$$$autoops-metrics-storage$$$ **Where are AutoOps metrics stored?**
7071
: You can choose where to store your metrics from the following AWS regions:
7172

@@ -88,3 +89,14 @@ $$$extracted-info$$$ **What information does {{agent}} extract from my cluster?*
8889
| [_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 |
8990
| [_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 |
9091

92+
$$$data-gathering$$$ **How does AutoOps gather data from my cluster and ensure its security?**
93+
: AutoOps gathers data from your cluster using two protocols:
94+
* **HTTP request**: Made to our Cloud Connected API to register your cluster with {{ecloud}} and gather registration-related data.
95+
* **OpenTelemetry Protocol (OTLP)**: Used to gather all other operational data.
96+
97+
Each channel is authenticated through an API key or token to ensure your data's security. The following table offers more details:
98+
99+
| Protocol | Data extracted | Port | Authentication method |
100+
| --- | --- | --- | --- |
101+
| HTTP | Basic cluster information from the `/` endpoint <br><br> License information from the `/_license` endpoint | **443**: standard HTTPS port | Uses an {{ecloud}} API key which is limited for use with Cloud Connect only. |
102+
| OTLP | Operational information | **4318**: standard OTLP HTTP port <br><br> This service will be exposed on port 443 in the future. | Uses an AutoOps token which is functionally equivalent to an API key. |

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,4 +49,5 @@ The following table shows the errors you might encounter if something goes wrong
4949
| `LICENSE_EXPIRED` | Elastic license is expired | Contact [sales](https://www.elastic.co/contact#sales) to renew your license. |
5050
| `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://support.elastic.co/) for help. |
5151
| `VERSION_MISMATCH` | {{es}} version is unsupported | Upgrade your cluster to a [supported version](https://www.elastic.co/support/eol). |
52-
| `UNKNOWN_ERROR` | Installation failed | {{agent}} couldn't be installed due to an unknown issue. Consult the troubleshooting guide or contact [Elastic support](https://support.elastic.co/) for more help. |
52+
| `UNKNOWN_ERROR` | Installation failed | {{agent}} couldn't be installed due to an unknown issue. Consult the troubleshooting guide or contact [Elastic support](https://support.elastic.co/) for more help. |
53+
| `` | Failed to register Cloud Connected Mode: cluster license type is not supported | The cluster you are trying to connect doesn't have the required license to connect to AutoOps. For more information, refer to the [prerequisites](/deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops.md#prerequisites). |

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

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ If you have an {{es}} cluster set up for local development or testing, you can c
2121

2222
Ensure your system meets the following requirements before proceeding:
2323

24-
* Your cluster is on a [supported {{es}} version](https://www.elastic.co/support/eol).
24+
* Your cluster is on a [supported {{es}} version](https://www.elastic.co/support/eol) (7.17.x and above).
2525
* 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).
2626
* The agent you install for the connection is allowed to send metrics to {{ecloud}}.
2727

@@ -101,11 +101,13 @@ Select one of the following methods to install {{agent}}:
101101
Using AutoOps for your ECE, ECK, and self-managed clusters requires a new, dedicated {{agent}}. You must install an agent even if you already have an existing one for other purposes.
102102
:::
103103

104+
To learn more about how AutoOps securely gathers data from your cluster, refer to our [FAQ](/deploy-manage/monitor/autoops/cc-cloud-connect-autoops-faq.md#data-gathering).
105+
104106
### Configure agent
105107

106108
Depending on your selected installation method, you may have to provide the following information to create the installation command:
107109

108-
* **{{es}} endpoint URL**: The agent will use this URL to identify which cluster you want to connect to AutoOps.
110+
* **{{es}} endpoint URL**: Enter the URL for the {{es}} cluster you want to monitor by connecting to AutoOps.
109111
* **Preferred authentication method**: Choose one of the following:
110112
:::::{tab-set}
111113
:group: api-key-or-basic
@@ -204,7 +206,7 @@ If you manually assign privileges, you won't be able to allow {{agent}} to acces
204206

205207
:::::
206208
* **System architecture**: Select the system architecture of the machine running the agent.
207-
* **Metrics storage location**: Select where to store your metrics data from the list of available regions.
209+
* **Metrics storage location**: Select where to store your metrics data from the list of available AWS regions.
208210

209211
:::{include} ../_snippets/autoops-cc-regions.md
210212
:::
@@ -281,10 +283,11 @@ You can use the same installation command to connect multiple clusters, but each
281283

282284
Complete the following steps to disconnect your 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.
283285

286+
2. Based on your [installation method](#select-installation-method), complete the steps to stop {{agent}} from shipping metrics to {{ecloud}}.
284287
1. Log in to [{{ecloud}}](https://cloud.elastic.co/home).
285-
2. In the **Connected clusters** section, locate the cluster you want to disconnect.
286-
3. From that cluster’s actions menu, select **Disconnect cluster**.
287-
4. Enter the cluster’s name in the field that appears and then select **Disconnect cluster**.
288+
3. On the **Connected clusters** page or the **Connected clusters** section of the home page, locate the cluster you want to disconnect.
289+
4. From that cluster’s actions menu, select **Disconnect cluster**.
290+
5. Enter the cluster’s name in the field that appears and then select **Disconnect cluster**.
288291

289292
:::{include} /deploy-manage/monitor/_snippets/disconnect-cluster.md
290293
:::

0 commit comments

Comments
 (0)