Skip to content

Commit 56647b2

Browse files
authored
[Cloud UI] [AutoOps for self-managed] Document how to add or edit cluster display name (#4138)
## Summary Adds a section to the Connect your SM cluster to AutoOps page. Closes: #4137 Rel: elastic/cloud-ui#533
1 parent a32eda3 commit 56647b2

File tree

1 file changed

+22
-10
lines changed

1 file changed

+22
-10
lines changed

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

Lines changed: 22 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ products:
1212

1313
# Connect your self-managed cluster to AutoOps
1414

15-
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}}.
15+
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 then guides you through the steps of installing {{agent}} to send metrics from your cluster to AutoOps in {{ecloud}}.
1616

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

@@ -222,7 +222,7 @@ If you manually assign privileges, you won't be able to allow {{agent}} to acces
222222

223223
### Install agent
224224

225-
The wizard will generate an installation command based on your configuration. Depending on your installation method, the following command formats are available:
225+
The wizard generates an installation command based on your configuration. Depending on your installation method, the following command formats are available:
226226

227227
* Kubernetes
228228
* YAML
@@ -260,43 +260,55 @@ Complete the following steps to run the command:
260260

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

263-
If the connection is unsuccessful, an error message will appear with a possible reason for the failure and recommended next steps. For a list of these errors, refer to [Potential errors](/deploy-manage/monitor/autoops/cc-cloud-connect-autoops-troubleshooting.md#potential-errors).
263+
If the connection is unsuccessful, an error message is displayed with a possible reason for the failure and recommended next steps. For a list of these errors, refer to [Potential errors](/deploy-manage/monitor/autoops/cc-cloud-connect-autoops-troubleshooting.md#potential-errors).
264264

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

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

269269
### Launch AutoOps
270270

271-
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.
271+
If the connection is successful, AutoOps starts analyzing your metrics and reporting on any issues found. Depending on the size of your cluster, this process can take up to 30 minutes.
272272

273-
After the account is ready, the **Open AutoOps** button will appear in the wizard. Select it to launch AutoOps.
273+
After the account is ready, the **Open AutoOps** button is displayed in the wizard. Select it to launch AutoOps.
274274

275275
Learn more about [AutoOps](/deploy-manage/monitor/autoops.md).
276276

277277
## Access AutoOps
278278

279-
After you've completed the setup, you can access AutoOps for your cluster at any time.
279+
After completing the setup, you can access AutoOps for your cluster at any time.
280280

281281
1. Log in to [{{ecloud}}](https://cloud.elastic.co/home).
282282
2. In the **Connected clusters** section, locate the cluster you want to work on.
283283
3. In the **Services** column, select **AutoOps**.
284284

285-
## Connect additional clusters
285+
## Manage connected clusters
286286

287-
To connect more clusters, we recommend repeating the steps to [connect to AutoOps](#connect-to-autoops).
287+
Perform the actions described in the following sections to manage your connected cluster(s).
288+
289+
### Add an alias to a cluster
290+
291+
By default, each cluster has a name made up of a string of characters, but you can add a human-readable alias by completing the following steps. You need admin privileges to perform this action.
292+
293+
1. From the [{{ecloud}} home page](https://cloud.elastic.co/home), go to the **Connected clusters** section and select the cluster you want to work on.
294+
2. On the cluster details page, select **Edit** in the **Cluster display name** field.
295+
3. Enter the alias in the field that is displayed and then select the checkmark icon.
296+
297+
### Connect additional clusters
298+
299+
To connect more clusters, repeat the steps to [connect to AutoOps](#connect-to-autoops).
288300

289301
You can use the same installation command to connect multiple clusters, but each cluster needs a separate, dedicated {{agent}}.
290302

291-
## Disconnect a cluster
303+
### Disconnect a cluster
292304

293305
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.
294306

295307
1. Based on your [installation method](#select-installation-method), complete the steps to stop {{agent}} from shipping metrics to {{ecloud}}.
296308
2. Log in to [{{ecloud}}](https://cloud.elastic.co/home).
297309
3. On the **Connected clusters** page or the **Connected clusters** section of the home page, locate the cluster you want to disconnect.
298310
4. From that cluster’s actions menu, select **Disconnect cluster**.
299-
5. Enter the cluster’s name in the field that appears and then select **Disconnect cluster**.
311+
5. Enter the cluster’s name in the field that is displayed and then select **Disconnect cluster**.
300312

301313
:::{include} /deploy-manage/monitor/_snippets/disconnect-cluster.md
302314
:::

0 commit comments

Comments
 (0)