Skip to content
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions deploy-manage/_snippets/autoops-cc-ech-faq.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
:::{dropdown} Can I use Cloud Connect to connect my {{ech}} clusters to AutoOps?

This path is not supported. Currently, we only support using Cloud Connect to connect self-managed clusters to AutoOps.
:::
10 changes: 3 additions & 7 deletions deploy-manage/cloud-connect.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ Cloud Connect enables you to use {{ecloud}} services in your self-managed cluste

AutoOps is the first service available for use with Cloud Connect. More services are coming soon.

### AutoOps
### AutoOps for self-managed clusters

[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.
[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 your 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).

Expand All @@ -34,11 +34,7 @@ Each cloud connected service has its own licensing and payment requirements.

:::

:::{dropdown} Will my data be safe when using Cloud Connect?

$$$cc-data$$$

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).
:::{include} /deploy-manage/_snippets/autoops-cc-ech-faq.md
:::

:::{dropdown} Are more services going to be available with Cloud Connect?
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ navigation_title: FAQ

Find answers to your questions about AutoOps for self-managed clusters.

:::{dropdown} Why should I use AutoOps for my self-managed cluster?
:::{dropdown} Why should I use AutoOps for my self-managed clusters?

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.

Expand All @@ -20,6 +20,9 @@ When you need support, AutoOps gives the Elastic team real-time visibility into
Using AutoOps for your self-managed cluster lets you access all these features without the operational overhead of managing their infrastructure.
:::

:::{include} /deploy-manage/_snippets/autoops-cc-ech-faq.md
:::

:::{dropdown} Does AutoOps for self-managed clusters require additional payment?

:::{include} /deploy-manage/_snippets/autoops-cc-payment-faq.md
Expand All @@ -42,6 +45,11 @@ You can connect to AutoOps on a standalone {{stack}}, ECE ({{ece}}), or ECK ({{e
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} Can I use macOS to install {{agent}}?

macOS is not a supported platform for installing {{agent}} and connecting your self-managed cluster to AutoOps.
:::

:::{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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,8 @@ The following table shows the errors you might encounter if something goes wrong
| `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. 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. |
| `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://support.elastic.co/) 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](https://cloud.elastic.co/login?source=support&fromURI=https%3A%2F%2Fauth.elastic.co%2Fapp%2Felastic-customer_dreammachinecustomer_1%2Fexkgw653gkKlRTQXQ1t7%2Fsso%2Fsaml) 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://support.elastic.co/) 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. |
| `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. |
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Complete the steps in the following subsections to connect your cluster to AutoO
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).
* You have an [Enterprise self-managed license](https://www.elastic.co/subscriptions) or an active ECE, ECK, or self-managed [trial](https://cloud.elastic.co/registration).
* The agent you install for the connection is allowed to send metrics outside your organization to {{ecloud}}.

## Connect to AutoOps
Expand All @@ -28,6 +28,34 @@ Ensure your system meets the following requirements before proceeding:
:::
:::

The following steps describe how to connect to AutoOps during the private preview of AutoOps for self-managed clusters.

:::::{tab-set}
:group: existing-or-new-cloud-account

::::{tab-item} Existing account
:sync: existing

If you already have an {{ecloud}} account:
1. Go to the [Cloud Connected Services](https://cloud.elastic.co/connect-cluster-services) page for private preview.
2. Log in to your account.
3. On the **Cloud Connected Services** page, in the **AutoOps** section, select **Connect**.
4. Go through the installation wizard as detailed in the following sections.
::::

::::{tab-item} New account
:sync: new

If you don’t have an existing {{ecloud}} account:
1. Go to the [Cloud Connected Services sign up](https://cloud.elastic.co/registration?onboarding_service_type=ccm) page for private preview.
2. Follow the prompts on your screen to sign up for an account and create an organization.
3. Go through the installation wizard as detailed in the following sections.
::::

:::::

<!-- Not applicable for private preview. Unhide for GA.

:::::{tab-set}
:group: existing-or-new-cloud-account

Expand All @@ -37,23 +65,20 @@ Ensure your system meets the following requirements before proceeding:
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**.
3. 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.
<!--
Add cloud-connected marketing link to sign up when available
-->
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

Expand All @@ -63,8 +88,10 @@ Select one of the following methods to install {{agent}}:

* Kubernetes
* Docker
<!-- Not applicable for private preview
* 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.
Expand All @@ -82,12 +109,45 @@ Depending on your selected installation method, you may have to provide the foll
::::{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:
With this authentication method, you need to create an API key to grant access to your cluster. Complete the following steps:

| Setting | Privileges |
| --- | --- |
| Cluster privileges | `monitor`, `read_ilm`, and `read_slm` |
| Index privileges | Indices: `*` <br> `monitor`, `view_index_metadata`, `allow_restricted_indices: true` |
1. From your {{ecloud}} home page, select a deployment.
2. Go to **Stack management** > **API keys** and select **Create API key**.
4. In the flyout, enter a name for your key and select **User API key**.
5. Enable **Control security privileges** and enter the following script:
```json
{
"autoops": {
"cluster": [
"monitor",
"read_ilm",
"read_slm"
],
"indices": [
{
"names": [
"*"
],
"privileges": [
"monitor",
"view_index_metadata"
],
"allow_restricted_indices": true
}
],
"applications": [],
"run_as": [],
"metadata": {},
"transient_metadata": {
"enabled": true
}
}
}

```
5. Select **Create API key**.
6. When prompted to copy the key, select **Beats** from the dropdown.
7. Copy the key and save it for later. You will need it when you [install the agent](#install-agent).

::::

Expand Down Expand Up @@ -152,11 +212,13 @@ The wizard will generate an installation command based on your configuration. De
* Docker
* Docker
* Docker compose
<!-- Not applicable for private preview
* Linux
* Windows
-->

:::{tip}
We recommend installing the agent on a separate machine from the one where your self-managed cluster is running.
To ensure optimum resource usage, we recommend installing the agent on a different machine from the one where your self-managed cluster is running.
:::

Complete the following steps to run the command:
Expand All @@ -183,6 +245,8 @@ If the connection is unsuccessful, an error message will appear with a possible

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).

To uninstall the agent, refer to [](/solutions/security/configure-elastic-defend/uninstall-elastic-agent.md).

### 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.
Expand Down
Loading