Merge pull request #86276 from lahinson/ocpbugs-44709-hcp-platform

lahinson · web-flow · commit c03f7299045d · 2025-01-15T14:42:36.000-05:00
[OCPBUGS-44709]: Clarifying HCP requirement
diff --git a/hosted_control_planes/hcp-deploy/hcp-deploy-virt.adoc b/hosted_control_planes/hcp-deploy/hcp-deploy-virt.adoc
@@ -15,13 +15,13 @@ With {hcp} and {VirtProductName}, you can create {product-title} clusters with w
 
 The {hcp} feature is enabled by default.
 
-You can use the hosted control plane command line interface, `hcp`, to create an {product-title} hosted cluster. The hosted cluster is automatically imported as a managed cluster. If you want to disable this automatic import feature, see "Disabling the automatic import of hosted clusters into multicluster engine operator".
+You can use the hosted control plane command line interface, `hcp`, to create an {product-title} hosted cluster. The hosted cluster is automatically imported as a managed cluster. If you want to disable this automatic import feature, see "Disabling the automatic import of hosted clusters into multicluster engine Operator".
 
 [role="_additional-resources"]
 .Additional resources
+* xref:../../hosted_control_planes/hcp-import.adoc#hcp-import-disable_hcp-import[Disabling the automatic import of hosted clusters into {mce-short}]
 * xref:../../hosted_control_planes/hcp-prepare/hcp-enable-disable.adoc[Enabling or disabling the {hcp} feature]
 * link:https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.12/html/clusters/cluster_mce_overview#ansible-config-hosted-cluster[Configuring Ansible Automation Platform jobs to run on hosted clusters]
-* xref:../../hosted_control_planes/hcp-import.adoc#hcp-import-disable_hcp-import[Disabling the automatic import of hosted clusters into {mce-short}]
 
 include::modules/hcp-virt-reqs.adoc[leveloffset=+1]
 
diff --git a/hosted_control_planes/hcp-prepare/hcp-requirements.adoc b/hosted_control_planes/hcp-prepare/hcp-requirements.adoc
@@ -6,7 +6,9 @@ include::_attributes/common-attributes.adoc[]
 
 toc::[]
 
-In the context of {hcp}, a _management cluster_ is an {product-title} cluster where the HyperShift Operator is deployed and where the control planes for hosted clusters are hosted. The management cluster and workers must run on the same infrastructure. For example, you cannot run your management cluster on bare metal and your workers on the cloud. However, the management cluster and workers do not need to run on the same platform. For example, you might run your management cluster on bare metal and workers on {VirtProductName}.
+In the context of {hcp}, a _management cluster_ is an {product-title} cluster where the HyperShift Operator is deployed and where the control planes for hosted clusters are hosted. 
+
+The management cluster and worker nodes must run on the same type of infrastructure. For example, you can run both the management cluster and the worker nodes on-premise, such as on a bare-metal platform or on {VirtProductName}. In addition, you can run both the management cluster and the worker nodes on cloud infrastructure, such as {aws-first}. However, you cannot run your management cluster on the cloud and your worker nodes on-premise, or the other way around.
 
 The control plane is associated with a hosted cluster and runs as pods in a single namespace. When the cluster service consumer creates a hosted cluster, it creates a worker node that is independent of the control plane.
 
diff --git a/modules/hcp-aws-prepare.adoc b/modules/hcp-aws-prepare.adoc
@@ -12,6 +12,6 @@ As you prepare to deploy {hcp} on {aws-first}, consider the following informatio
 
 - Do not use `clusters` as a hosted cluster name.
 
-- Run the hub cluster and workers on the same platform for {hcp}.
+- Run the management cluster and workers on the same platform for {hcp}.
 
-- A hosted cluster cannot be created in the namespace of a {mce-short} managed cluster.
+- A hosted cluster cannot be created in the namespace of a {mce-short} managed cluster.
diff --git a/modules/hcp-bm-prepare.adoc b/modules/hcp-bm-prepare.adoc
@@ -8,8 +8,8 @@
 
 As you prepare to deploy {hcp} on bare metal, consider the following information:
 
-- Run the hub cluster and workers on the same platform for {hcp}.
+- Run the management cluster and workers on the same platform for {hcp}.
 
 - All bare metal hosts require a manual start with a Discovery Image ISO that the central infrastructure management provides. You can start the hosts manually or through automation by using `Cluster-Baremetal-Operator`. After each host starts, it runs an Agent process to discover the host details and complete the installation. An `Agent` custom resource represents each host.
 
-- When you configure storage for {hcp}, consider the recommended etcd practices. To ensure that you meet the latency requirements, dedicate a fast storage device to all hosted control plane etcd instances that run on each control-plane node. You can use LVM storage to configure a local storage class for hosted etcd pods. For more information, see _Recommended etcd practices_ and _Persistent storage using logical volume manager storage_.
+- When you configure storage for {hcp}, consider the recommended etcd practices. To ensure that you meet the latency requirements, dedicate a fast storage device to all hosted control plane etcd instances that run on each control-plane node. You can use LVM storage to configure a local storage class for hosted etcd pods. For more information, see "Recommended etcd practices" and "Persistent storage using logical volume manager storage".
diff --git a/modules/hcp-non-bm-prereqs.adoc b/modules/hcp-non-bm-prereqs.adoc
@@ -6,21 +6,21 @@
 [id="hcp-non-bm-prereqs_{context}"]
 = Prerequisites for deploying {hcp} on non-bare-metal agent machines
 
-You must review the following prerequisites before deploying {hcp} on non-bare-metal agent machines:
+Before you deploy {hcp} on non-bare-metal agent machines, ensure you meet the following prerequisites:
 
-* You need the {mce} 2.5 and later installed on an {product-title} cluster. The {mce-short} is automatically installed when you install {rh-rhacm-first}. You can also install the {mce-short} without {rh-rhacm} as an Operator from the {product-title} OperatorHub.
+* You must have {mce} 2.5 or later installed on an {product-title} cluster. You can install the {mce-short} as an Operator from the {product-title} OperatorHub.
 
-* You have at least one managed {product-title} cluster for the {mce-short}. The `local-cluster` managed hub cluster is automatically imported. See link:https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.12/html/clusters/cluster_mce_overview#advanced-config-engine[Advanced configuration] for more information about the local-cluster. You can check the status of your hub cluster by running the following command:
+* You must have at least one managed {product-title} cluster for the {mce-short}. The `local-cluster` management cluster is automatically imported. For more information about the `local-cluster`, see link:https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.12/html/clusters/cluster_mce_overview#advanced-config-engine[Advanced configuration] in the {rh-rhacm-title} documentation. You can check the status of your management cluster by running the following command:
 +
 [source,terminal]
 ----
 $ oc get managedclusters local-cluster
 ----
 
-* You enabled central infrastructure management. For more information, see link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.12/html/clusters/cluster_mce_overview#enable-cim[Enabling the central infrastructure management service].
+* You have enabled central infrastructure management. For more information, see link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.12/html/clusters/cluster_mce_overview#enable-cim[Enabling the central infrastructure management service] in the {rh-rhacm-title} documentation.
 
-* You installed the `hcp` command-line interface.
+* You have installed the `hcp` command-line interface.
 
-* Your hosted cluster has a cluster-wide unique name. A hosted cluster name cannot be the same as any existing managed cluster in order for the {mce-short} to manage it.
+* Your hosted cluster has a cluster-wide unique name.
 
-* You run the hub cluster and workers on the same platform for {hcp}.
+* You are running the management cluster and workers on the same infrastructure.
diff --git a/modules/hcp-virt-reqs.adoc b/modules/hcp-virt-reqs.adoc
@@ -8,8 +8,8 @@
 
 As you prepare to deploy {hcp} on {VirtProductName}, consider the following information:
 
-* Run the hub cluster and workers on the same platform for {hcp}.
-* Each hosted cluster must have a cluster-wide unique name. A hosted cluster name cannot be the same as any existing managed cluster in order for {mce-short} to manage it.
+* Run the management cluster on bare metal.
+* Each hosted cluster must have a cluster-wide unique name.
 * Do not use `clusters` as a hosted cluster name.
 * A hosted cluster cannot be created in the namespace of a {mce-short} managed cluster.
 * When you configure storage for {hcp}, consider the recommended etcd practices. To ensure that you meet the latency requirements, dedicate a fast storage device to all hosted control plane etcd instances that run on each control-plane node. You can use LVM storage to configure a local storage class for hosted etcd pods. For more information, see "Recommended etcd practices" and "Persistent storage using Logical Volume Manager storage".
