Merge pull request #112761 from lahinson/osdocs-19995-cqa-hcp-deletion

lahinson · web-flow · commit adb0e5a95b8b · 2026-06-04T11:35:34.000-04:00
[OSDOCS-19995]: CQA: Deleting hosted clusters
diff --git a/hosted_control_planes/hcp-destroy/hcp-destroy-aws.adoc b/hosted_control_planes/hcp-destroy/hcp-destroy-aws.adoc
@@ -1,11 +1,12 @@
 :_mod-docs-content-type: ASSEMBLY
-[id="hcp-destroy-aws"]
 include::_attributes/common-attributes.adoc[]
+[id="hcp-destroy-aws"]
 = Destroying a hosted cluster on {aws-short}
 :context: hcp-destroy-aws
 
 toc::[]
 
-You can destroy a hosted cluster and its managed cluster resource on {aws-first} by using the command-line interface (CLI).
+[role="_abstract"]
+You might want to remove a hosted cluster if you are no longer using it, you are trying to reduce resources, or the hosted cluster is experiencing issues that are difficult to resolve.
 
 include::modules/hcp-destroy-aws-cli.adoc[leveloffset=+1]
diff --git a/hosted_control_planes/hcp-destroy/hcp-destroy-bm.adoc b/hosted_control_planes/hcp-destroy/hcp-destroy-bm.adoc
@@ -1,12 +1,13 @@
 :_mod-docs-content-type: ASSEMBLY
-[id="hcp-destroy-bm"]
 include::_attributes/common-attributes.adoc[]
+[id="hcp-destroy-bm"]
 = Destroying a hosted cluster on bare metal
 :context: hcp-destroy-bm
 
 toc::[]
 
-You can destroy hosted clusters on bare metal by using the command-line interface (CLI) or the {mce-short} web console.
+[role="_abstract"]
+You might want to remove a hosted cluster if you are no longer using it, you are trying to reduce resources, or the hosted cluster is experiencing issues that are difficult to resolve.
 
 include::modules/destroy-hc-bm-cli.adoc[leveloffset=+1]
 
diff --git a/hosted_control_planes/hcp-destroy/hcp-destroy-ibm-power.adoc b/hosted_control_planes/hcp-destroy/hcp-destroy-ibm-power.adoc
@@ -1,11 +1,12 @@
 :_mod-docs-content-type: ASSEMBLY
-[id="hcp-destroy-ibm-power"]
 include::_attributes/common-attributes.adoc[]
+[id="hcp-destroy-ibm-power"]
 = Destroying a hosted cluster on {ibm-power-title}
 :context: hcp-destroy-ibm-power
 
 toc::[]
 
-You can destroy a hosted cluster on {ibm-power-title} by using the command-line interface (CLI).
+[role="_abstract"]
+You might want to remove a hosted cluster if you are no longer using it, you are trying to reduce resources, or the hosted cluster is experiencing issues that are difficult to resolve.
 
 include::modules/destroy-hc-ibm-power-cli.adoc[leveloffset=+1]
diff --git a/hosted_control_planes/hcp-destroy/hcp-destroy-ibmz.adoc b/hosted_control_planes/hcp-destroy/hcp-destroy-ibmz.adoc
@@ -1,11 +1,12 @@
 :_mod-docs-content-type: ASSEMBLY
-[id="hcp-destroy-ibmz"]
 include::_attributes/common-attributes.adoc[]
+[id="hcp-destroy-ibmz"]
 = Destroying a hosted cluster on {ibm-z-title}
 :context: hcp-destroy-ibmz
 
 toc::[]
 
-You can destroy a hosted cluster on `x86` bare metal with {ibm-z-title} compute nodes and its managed cluster resource by using the command-line interface (CLI).
+[role="_abstract"]
+You might want to remove a hosted cluster if you are no longer using it, you are trying to reduce resources, or the hosted cluster is experiencing issues that are difficult to resolve.
 
 include::modules/destroy-hc-ibm-z-cli.adoc[leveloffset=+1]
diff --git a/hosted_control_planes/hcp-destroy/hcp-destroy-non-bm.adoc b/hosted_control_planes/hcp-destroy/hcp-destroy-non-bm.adoc
@@ -1,12 +1,13 @@
 :_mod-docs-content-type: ASSEMBLY
-[id="hcp-destroy-non-bm"]
 include::_attributes/common-attributes.adoc[]
+[id="hcp-destroy-non-bm"]
 = Destroying a hosted cluster on non-bare-metal agent machines
 :context: hcp-destroy-non-bm
 
 toc::[]
 
-You can destroy hosted clusters on non-bare-metal agent machines by using the command-line interface (CLI) or the {mce-short} web console.
+[role="_abstract"]
+You might want to remove a hosted cluster if you are no longer using it, you are trying to reduce resources, or the hosted cluster is experiencing issues that are difficult to resolve.
 
 include::modules/destroy-hc-non-bm-cli.adoc[leveloffset=+1]
 
diff --git a/hosted_control_planes/hcp-destroy/hcp-destroy-openstack.adoc b/hosted_control_planes/hcp-destroy/hcp-destroy-openstack.adoc
@@ -1,9 +1,12 @@
 :_mod-docs-content-type: ASSEMBLY
-[id="hcp-destroy-openstack"]
 include::_attributes/common-attributes.adoc[]
+[id="hcp-destroy-openstack"]
 = Destroying a hosted control plane on OpenStack
 :context: hcp-destroy-openstack
 
 toc::[]
 
+[role="_abstract"]
+You might want to remove a hosted cluster if you are no longer using it, you are trying to reduce resources, or the hosted cluster is experiencing issues that are difficult to resolve.
+
 include::modules/hosted-clusters-openstack-destroy.adoc[leveloffset=+1]
diff --git a/hosted_control_planes/hcp-destroy/hcp-destroy-virt.adoc b/hosted_control_planes/hcp-destroy/hcp-destroy-virt.adoc
@@ -1,11 +1,12 @@
 :_mod-docs-content-type: ASSEMBLY
-[id="hcp-destroy-virt"]
 include::_attributes/common-attributes.adoc[]
+[id="hcp-destroy-virt"]
 = Destroying a hosted cluster on {VirtProductName}
 :context: hcp-destroy-virt
 
 toc::[]
 
-You can destroy a hosted cluster and its managed cluster resource on {VirtProductName} by using the command-line interface (CLI).
+[role="_abstract"]
+You might want to remove a hosted cluster if you are no longer using it, you are trying to reduce resources, or the hosted cluster is experiencing issues that are difficult to resolve.
 
 include::modules/destroy-hc-virt-cli.adoc[leveloffset=+1]
diff --git a/modules/destroy-hc-bm-cli.adoc b/modules/destroy-hc-bm-cli.adoc
@@ -6,6 +6,7 @@
 [id="destroy-hc-bm-cli_{context}"]
 = Destroying a hosted cluster on bare metal by using the CLI
 
+[role="_abstract"]
 If you created a hosted cluster by using the command-line interface (CLI), you can destroy that hosted cluster and its back-end resources by running a command.
 
 .Procedure
@@ -14,10 +15,10 @@ If you created a hosted cluster by using the command-line interface (CLI), you c
 +
 [source,terminal]
 ----
-$ oc delete -f <hosted_cluster_config>.yaml <1>
+$ oc delete -f <hosted_cluster_config>.yaml
 ----
 +
-<1> Specify the name of the configuration YAML file that was rendered when you created the hosted cluster.
+Specify the name of the configuration YAML file that was rendered when you created the hosted cluster.
 +
 [NOTE]
 ====
diff --git a/modules/destroy-hc-bm-console.adoc b/modules/destroy-hc-bm-console.adoc
@@ -6,6 +6,7 @@
 [id="destroy-hc-bm-console_{context}"]
 = Destroying a hosted cluster on bare metal by using the web console
 
+[role="_abstract"]
 You can use the {mce-short} web console to destroy a hosted cluster on bare metal.
 
 .Procedure
diff --git a/modules/destroy-hc-ibm-power-cli.adoc b/modules/destroy-hc-ibm-power-cli.adoc
@@ -6,6 +6,7 @@
 [id="destroy-hc-ibm-power-cli_{context}"]
 = Destroying a hosted cluster on {ibm-power-title} by using the CLI
 
+[role="_abstract"]
 To destroy a hosted cluster on {ibm-power-title}, you can use the hcp command-line interface (CLI).
 
 .Procedure
@@ -15,10 +16,11 @@ To destroy a hosted cluster on {ibm-power-title}, you can use the hcp command-li
 [source,terminal]
 ----
 $ hcp destroy cluster agent
- --name=<hosted_cluster_name> \// <1>
- --namespace=<hosted_cluster_namespace> \// <2>
- --cluster-grace-period <duration> <3>
+ --name=<hosted_cluster_name> \
+ --namespace=<hosted_cluster_namespace> \
+ --cluster-grace-period <duration>
 ----
-<1> Replace `<hosted_cluster_name>` with the name of your hosted cluster.
-<2> Replace `<hosted_cluster_namespace>` with the name of your hosted cluster namespace.
-<3> Specifies the duration to destroy the hosted cluster completely, for example, `20m0s`.
++
+** `<hosted_cluster_name>` specifies the name of your hosted cluster.
+** `<hosted_cluster_namespace>` specifies the name of your hosted cluster namespace.
+** `<duration>` specifies the duration to destroy the hosted cluster completely, for example, `20m0s`.
diff --git a/modules/destroy-hc-ibm-z-cli.adoc b/modules/destroy-hc-ibm-z-cli.adoc
@@ -6,6 +6,7 @@
 [id="destroy-hc-ibmz-cli_{context}"]
 = Destroying a hosted cluster on x86 bare metal with {ibm-z-title} compute nodes
 
+[role="_abstract"]
 To destroy a hosted cluster and its managed cluster on `x86` bare metal with {ibm-z-name} compute nodes, you can use the command-line interface (CLI).
 
 .Procedure
diff --git a/modules/destroy-hc-non-bm-cli.adoc b/modules/destroy-hc-non-bm-cli.adoc
@@ -6,6 +6,7 @@
 [id="destroy-hc-non-bm-cli_{context}"]
 = Destroying a hosted cluster on non-bare-metal agent machines
 
+[role="_abstract"]
 You can use the `hcp` command-line interface (CLI) to destroy a hosted cluster on non-bare-metal agent machines.
 
 .Procedure
@@ -14,7 +15,7 @@ You can use the `hcp` command-line interface (CLI) to destroy a hosted cluster o
 +
 [source,terminal]
 ----
-$ hcp destroy cluster agent --name <hosted_cluster_name> <1>
+$ hcp destroy cluster agent --name <hosted_cluster_name>
 ----
 +
-<1> Replace `<hosted_cluster_name>` with the name of your hosted cluster.
+Replace `<hosted_cluster_name>` with the name of your hosted cluster.
diff --git a/modules/destroy-hc-non-bm-console.adoc b/modules/destroy-hc-non-bm-console.adoc
@@ -6,6 +6,7 @@
 [id="destroy-hc-non-bm-console_{context}"]
 = Destroying a hosted cluster on non-bare-metal agent machines by using the web console
 
+[role="_abstract"]
 You can use the {mce-short} web console to destroy a hosted cluster on non-bare-metal agent machines.
 
 .Procedure
diff --git a/modules/destroy-hc-virt-cli.adoc b/modules/destroy-hc-virt-cli.adoc
@@ -6,6 +6,7 @@
 [id="destroy-hc-virt-cli_{context}"]
 = Destroying a hosted cluster on {VirtProductName} by using the CLI
 
+[role="_abstract"]
 You can use the command-line interface (CLI) to destroy a hosted cluster and its managed cluster resource on {VirtProductName}.
 
 .Procedure
diff --git a/modules/hcp-destroy-aws-cli.adoc b/modules/hcp-destroy-aws-cli.adoc
@@ -6,35 +6,39 @@
 [id="hcp-destroy-aws-cli_{context}"]
 = Destroying a hosted cluster on {aws-short} by using the CLI
 
-You can use the command-line interface (CLI) to destroy a hosted cluster on {aws-first}.
+[role="_abstract"]
+To delete a hosted cluster and its managed cluster resource from {hcp} on {aws-first}, use the command-line interface (CLI).
 
 .Procedure
 
 . Delete the managed cluster resource on {mce-short} by running the following command:
 +
 [source,terminal]
 ----
-$ oc delete managedcluster <hosted_cluster_name> <1>
+$ oc delete managedcluster <hosted_cluster_name>
 ----
-<1> Replace `<hosted_cluster_name>` with the name of your cluster.
++
+Replace `<hosted_cluster_name>` with the name of your cluster.
 
 . Delete the hosted cluster and its backend resources by running the following command:
 +
 [source,terminal]
 ----
 $ hcp destroy cluster aws  \
-  --name <hosted_cluster_name> \// <1>
-  --infra-id <infra_id> \// <2>
-  --role-arn <arn_role> \// <3>
-  --sts-creds <path_to_sts_credential_file> \// <4>
-  --base-domain <basedomain> <5>
+  --name <hosted_cluster_name> \
+  --infra-id <infra_id> \
+  --role-arn <arn_role> \
+  --sts-creds <path_to_sts_credential_file> \
+  --base-domain <base_domain>
 ----
 +
-<1> Specify the name of your hosted cluster, for instance, `example`.
-<2> Specify the infrastructure name for your hosted cluster.
-<3> Specify the Amazon Resource Name (ARN), for example, `arn:aws:iam::820196288204:role/myrole`.
-<4> Specify the path to your {aws-short} Security Token Service (STS) credentials file, for example, `/home/user/sts-creds/sts-creds.json`.
-<5> Specify your base domain, for example, `example.com`.
+where:
++
+** `<hosted_cluster_name>` specifies the name of your hosted cluster, for example, `my-hosted-cluster`.
+** `<infra_id>` specifies the infrastructure name for your hosted cluster.
+** `<arn_role>` specifies the Amazon Resource Name (ARN), for example, `arn:aws:iam::820196288204:role/myrole`.
+** `<path_to_sts_credential_file>` specifies the path to your {aws-short} Security Token Service (STS) credentials file, for example, `/home/user/sts-creds/sts-creds.json`.
+** `<base_domain>` specifies your base domain, for example, `example.com`.
 +
 [IMPORTANT]
 ====
diff --git a/modules/hosted-clusters-openstack-destroy.adoc b/modules/hosted-clusters-openstack-destroy.adoc
@@ -6,6 +6,7 @@
 [id="hosted-clusters-openstack-destroy_{context}"]
 = Destroying a hosted cluster by using the CLI
 
+[role="_abstract"]
 You can destroy a hosted cluster and its associated resources on {rh-openstack-first} by using the `hcp` CLI tool.
 
 .Prerequisites
@@ -21,8 +22,6 @@ You can destroy a hosted cluster and its associated resources on {rh-openstack-f
 $ hcp destroy cluster openstack --name=<cluster_name>
 ----
 +
-where:
+Replace `<cluster_name>` with the name of the hosted cluster.
 +
-`<cluster_name>`:: is the name of the hosted cluster.
-
-After the process completes, all your cluster and all resources that are associated with it are destroyed.
+After the process completes, your cluster and all resources that are associated with it are destroyed.

Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,7 @@`
`6`	`6`	`[id="destroy-hc-bm-cli_{context}"]`
`7`	`7`	`= Destroying a hosted cluster on bare metal by using the CLI`
`8`	`8`
	`9`	`+[role="_abstract"]`
`9`	`10`	`If you created a hosted cluster by using the command-line interface (CLI), you can destroy that hosted cluster and its back-end resources by running a command.`
`10`	`11`
`11`	`12`	`.Procedure`
`@@ -14,10 +15,10 @@ If you created a hosted cluster by using the command-line interface (CLI), you c`
`14`	`15`	`+`
`15`	`16`	`[source,terminal]`
`16`	`17`	`----`
`17`		`-$ oc delete -f <hosted_cluster_config>.yaml <1>`
	`18`	`+$ oc delete -f <hosted_cluster_config>.yaml`
`18`	`19`	`----`
`19`	`20`	`+`
`20`		`-<1> Specify the name of the configuration YAML file that was rendered when you created the hosted cluster.`
	`21`	`+Specify the name of the configuration YAML file that was rendered when you created the hosted cluster.`
`21`	`22`	`+`
`22`	`23`	`[NOTE]`
`23`	`24`	`====`