Skip to content

Commit f4fc569

Browse files
wajihaparvezwajihaparvez
authored
[Private preview] Add docs for Cloud Connect + AutoOps for self-managed clusters (#2287)
The docs added in this PR are meant for **private preview**, so they are hidden from the ToC. I've added all the docs at the same level for now, because hidden files [can't have child pages](https://docs-v3-preview.elastic.dev/elastic/docs-builder/tree/main/configure/content-set/navigation#hidden-files). We can fix that and decide on exact positioning for GA. It doesn't matter right now because customers won't be able to _navigate_ to them from the ToC anyway. To avoid any confusion about the structure, I've added a section overview on the **AutoOps for self-managed clusters** page with links to all the other pages. Closes: elastic/docs-content-internal#16 and elastic/docs-content-internal#12
1 parent 89e9276 commit f4fc569

File tree

9 files changed

+487
-0
lines changed

9 files changed

+487
-0
lines changed

‎deploy-manage/cloud-connect.md‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
---
2+
applies_to:
3+
deployment:
4+
self:
5+
ece:
6+
eck:
7+
navigation_title: Cloud Connect
8+
---
9+
10+
# Cloud Connect
11+
12+
Cloud Connect enables you to use {{ecloud}} services in your self-managed cluster without having to install and maintain their infrastructure yourself. In this way, you can get faster access to new features while significantly reducing your operational overhead.
13+
14+
Cloud Connect is included with your [self-managed Enterprise license](https://www.elastic.co/subscriptions) and works with self-managed free trials for the duration of the trial period.
15+
16+
AutoOps is the first service available for use with Cloud Connect. More services are coming soon.
17+
18+
### AutoOps
19+
20+
[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.
21+
22+
Learn how to set up and use [](/deploy-manage/monitor/autoops/cc-autoops-as-cloud-connected.md).
23+
24+
## FAQs
25+
26+
Find answers to your questions about Cloud Connect.
27+
28+
:::{dropdown} Does using Cloud Connect require additional payment?
29+
30+
$$$cc-payment$$$
31+
32+
No. Cloud Connect is included with your [self-managed Enterprise license](https://www.elastic.co/subscriptions) and works with self-managed free trials for the duration of the trial period.
33+
34+
However, you may incur additional costs for specific functions within a cloud connected service. For example, when sending metrics data from your cluster in a CSP region to AutoOps in {{ecloud}}, shipping costs will be determined by your agreement with that CSP.
35+
:::
36+
37+
:::{dropdown} Does using Cloud Connect consume ECU?
38+
39+
$$$cc-ecu$$$
40+
41+
No. The currently available functionality does not consume ECU, but this may change when more features are introduced.
42+
:::
43+
44+
:::{dropdown} Will my data be safe when using Cloud Connect?
45+
46+
$$$cc-data$$$
47+
48+
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).
49+
:::
50+
51+
:::{dropdown} Are more services going to be available with Cloud Connect?
52+
53+
$$$cc-more-services$$$
54+
55+
Yes. AutoOps is the first of many cloud connected services to come. The next planned service is the Elastic Inference Service (EIS), which will provide GPU-powered inference for use cases like semantic search and text embeddings.
56+
:::
57+

‎deploy-manage/monitor/_snippets/disconnect-cluster.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
:::{warning}
2+
If you disconnect a cluster, its connection to your {{ecloud}} account will end and all metrics and AutoOps data will be permanently deleted.
3+
:::

‎deploy-manage/monitor/_snippets/single-cloud-org.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Users can only belong to one {{ecloud}} organization at a time. If you want to create or join another organization, you must [leave the previous one](/cloud-account/join-or-leave-an-organization.md#ec-leave-organization) or use a different email address.

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

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
applies_to:
3+
deployment:
4+
self:
5+
ece:
6+
eck:
7+
navigation_title: AutoOps for self-managed clusters
8+
---
9+
10+
# AutoOps for self-managed clusters
11+
12+
Use [AutoOps](/deploy-manage/monitor/autoops.md) with your self-managed cluster through [Cloud Connect](/deploy-manage/cloud-connect.md).
13+
14+
Cloud Connect enables users of 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.
15+
16+
## Section overview
17+
18+
In this section, you'll find the following information:
19+
20+
* How to [connect your self-managed cluster to AutoOps](/deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops.md)
21+
* How to [manage users of your connected clusters](/deploy-manage/monitor/autoops/cc-manage-users.md)
22+
* [FAQs](/deploy-manage/monitor/autoops/cc-cloud-connect-autoops-faq.md) about AutoOps for self-managed clusters
23+
* A [troubleshooting guide](/deploy-manage/monitor/autoops/cc-cloud-connect-autoops-troubleshooting.md) to help you with any issues you may encounter

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

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
---
2+
applies_to:
3+
deployment:
4+
self:
5+
ece:
6+
eck:
7+
navigation_title: FAQ
8+
---
9+
10+
# AutoOps for self-managed clusters FAQ
11+
12+
Find answers to your questions about AutoOps for self-managed clusters.
13+
14+
:::{dropdown} Why should I use AutoOps for my self-managed cluster?
15+
16+
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.
17+
18+
When you need support, AutoOps gives the Elastic team real-time visibility into your cluster, leading to faster resolutions.
19+
20+
Using AutoOps for your self-managed cluster lets you access all these features without the operational overhead of managing their infrastructure.
21+
:::
22+
23+
:::{dropdown} Which versions of {{es}} does AutoOps support?
24+
25+
AutoOps is compatible with all [supported {{es}} versions](https://www.elastic.co/support/eol).
26+
:::
27+
28+
:::{dropdown} Which deployment types can be connected to AutoOps?
29+
30+
You can connect to AutoOps on a standalone {{stack}}, ECE ({{ece}}), or ECK ({{eck}}) deployment.
31+
:::
32+
33+
:::{dropdown} Can I use AutoOps for self-managed clusters if my environment is air-gapped?
34+
35+
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.
36+
:::
37+
38+
:::{dropdown} Do I have to define an Elastic IP address to enable the agent to send data to {{ecloud}}?
39+
40+
You may need to define an IP address if your organization’s settings will block the agent from sending out data.
41+
42+
To enable IP ranges, {{ecloud}} offers a selection of static IP addresses. All traffic directed to {{ecloud}} deployments, whether originating from the public internet, your private cloud network through the public internet, or your on-premise network through the public internet utilizes Ingress Static IPs as the network destination.
43+
44+
For more information, refer to [](/deploy-manage/security/elastic-cloud-static-ips.md).
45+
:::
46+
47+
:::{dropdown} Where are AutoOps metrics stored, and does it cost extra to ship metrics to {{ecloud}}?
48+
49+
You can choose the CSP and region in which your cluster metrics will be stored from a list of [available regions](/deploy-manage/monitor/autoops/ec-autoops-regions.md).
50+
51+
Shipping metrics to {{ecloud}} may come at an additional cost. For example, when sending metrics data from your cluster in a CSP region to {{ecloud}}, shipping costs will be determined by your agreement with that CSP.
52+
:::
53+
54+
:::{dropdown} What information does {{agent}} extract from my cluster?
55+
56+
{{agent}} only extracts and sends cluster metrics to {{ecloud}}, not the underlying data within your cluster. The following metrics are collected:
57+
58+
| API | Description | Collected data |
59+
| --- | --- | --- |
60+
| [_cat/shards](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-shards) | Returns detailed information about the shards within the cluster | Shard states, node allocation, index names, sizes, and replica information |
61+
| [_nodes/stats](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-nodes-stats) | Retrieves statistics from cluster nodes including JVM, OS, process, and transport metrics | CPU usage, memory utilization, thread pools, file system stats |
62+
| [_cluster/settings](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-get-settings) | Returns the settings configured for the cluster | Persistent and transient settings such as cluster-wide configurations |
63+
| [_cluster/health](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-health) | Provides information about the overall health of the cluster | Status (green/yellow/red), number of nodes, number of shards |
64+
| [_cat/template](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-templates) | Lists all index templates in the cluster | Template names, patterns, and basic settings |
65+
| [_index_template](/manage-data/data-store/templates.md) | Retrieves composable index templates | Index settings, mappings, and aliases |
66+
| [_component_template](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-get-component-template) | Fetches component templates used for building index templates | Metadata for re-usable mappings and settings |
67+
| [_tasks](https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-tasks) | Displays information about currently running tasks on the cluster | Task descriptions, start times, running nodes, and execution details |
68+
| [_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 |
69+
| [_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 |
70+
:::
71+
72+

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

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
---
2+
applies_to:
3+
deployment:
4+
self:
5+
ece:
6+
eck:
7+
navigation_title: Troubleshooting
8+
---
9+
10+
# AutoOps for self-managed clusters troubleshooting
11+
12+
Learn about issues that might come up when using AutoOps with your self-managed cluster.
13+
14+
## Troubleshoot issues
15+
16+
Use this guide to troubleshoot any issues you may encounter.
17+
18+
:::{dropdown} I’m trying to create a Cloud organization, but I’m already part of a different one.
19+
20+
:::{include} /deploy-manage/monitor/_snippets/single-cloud-org.md
21+
:::
22+
23+
:::
24+
25+
:::{dropdown} I need to uninstall {{agent}}.
26+
27+
Refer to [](/solutions/security/configure-elastic-defend/uninstall-elastic-agent.md) for instructions.
28+
:::
29+
30+
:::{dropdown} My self-managed cluster was disconnected from {{ecloud}} and I want to reconnect it.
31+
32+
If the cluster was disconnected by one of the users in your Cloud organization, you can repeat the [installation process](/deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops.md) to reconnect. If not, explore [additional resources](/troubleshoot/index.md#troubleshoot-additional-resources) or [contact us](/troubleshoot/index.md#contact-us).
33+
34+
:::{include} /deploy-manage/monitor/_snippets/disconnect-cluster.md
35+
:::
36+
37+
:::
38+
39+
:::{dropdown} After running the installation command, I can't move on to the next steps.
40+
41+
If an error appears on the screen, follow the suggestion in the error message and try to run the command again. If the issue is not resolved, explore [additional resources](/troubleshoot/index.md#troubleshoot-additional-resources) or [contact us](/troubleshoot/index.md#contact-us).
42+
:::
43+
44+
## Potential errors
45+
46+
The following table shows the errors you might encounter if something goes wrong while you set up and use AutoOps for self-managed clusters.
47+
48+
| Error code | Error message | Description |
49+
| :--- | :--- | :--- |
50+
| `HTTP_401` | Authentication failed | Connection denied because of an authentication error. Verify that your API key and password are correct and all [necessary privileges](/deploy-manage/monitor/autoops/cc-connect-self-managed-to-autoops.md#configure-agent) have been granted. |
51+
| `HTTP_502` | Server error | Received an invalid response from the server. Verify the server status and network configuration. |
52+
| `HTTP_503` | Server unavailable | Invalid or corrupt response received from the server. The server acting as a proxy may be busy or undergoing scheduled maintenance. If the issue persists, check the cluster's health and resource usage. |
53+
| `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. |
54+
| `CLUSTER_ALREADY_CONNECTED` | Cluster connected to another account | This cluster is already connected to another {{ecloud}} organization. Disconnect it and then try again. |
55+
| `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. |
56+
| `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. |
57+
| `LICENSE_EXPIRED` | Elastic license is expired | Contact [sales](https://www.elastic.co/contact#sales) to renew your license. |
58+
| `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. |
59+
| `VERSION_MISMATCH` | {{es}} version is unsupported | Upgrade your cluster to a [supported version](https://www.elastic.co/support/eol). |
60+
| `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. |

0 commit comments

Comments
 (0)