diff --git a/_attributes/common-attributes.adoc b/_attributes/common-attributes.adoc index b3e1bd22de..03686de5a0 100644 --- a/_attributes/common-attributes.adoc +++ b/_attributes/common-attributes.adoc @@ -322,7 +322,5 @@ endif::[] :cap-vsphere-short: Cluster API Provider vSphere // Hosted control planes related attributes -:mce-first: multicluster engine for Kubernetes operator (MCE) -:mce-short: MCE :hcp-capital: Hosted control planes :hcp: hosted control planes diff --git a/architecture/control-plane.adoc b/architecture/control-plane.adoc index 3e95b836eb..3ff9282c08 100644 --- a/architecture/control-plane.adoc +++ b/architecture/control-plane.adoc @@ -78,7 +78,7 @@ include::modules/hosted-control-planes-overview.adoc[leveloffset=+1] [role="_additional-resources"] .Additional resources -* link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.9/html/clusters/cluster_mce_overview#hosted-control-planes-intro[Hosted control planes] +* link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.9/html/clusters/cluster_mce_overview#hosted-control-planes-intro[{hcp-capital}] include::modules/hosted-control-planes-concepts-personas.adoc[leveloffset=+2] include::modules/hosted-control-planes-version-support.adoc[leveloffset=+2] diff --git a/architecture/mce-overview-ocp.adoc b/architecture/mce-overview-ocp.adoc index bc5981d09f..1e1cfc68ca 100644 --- a/architecture/mce-overview-ocp.adoc +++ b/architecture/mce-overview-ocp.adoc @@ -1,12 +1,12 @@ :_mod-docs-content-type: ASSEMBLY [id="mce-overview-ocp"] -= About multicluster engine for Kubernetes operator include::_attributes/common-attributes.adoc[] += About multicluster engine for Kubernetes operator :context: mce-overview-ocp toc::[] -One of the challenges of scaling Kubernetes environments is managing the lifecycle of a growing fleet. To meet that challenge, you can use multicluster engine for Kubernetes operator (MCE). The operator delivers full lifecycle capabilities for managed {product-title} clusters and partial lifecycle management for other Kubernetes distributions. It is available in two ways: +One of the challenges of scaling Kubernetes environments is managing the lifecycle of a growing fleet. To meet that challenge, you can use the multicluster engine for Kubernetes operator. The operator delivers full lifecycle capabilities for managed {product-title} clusters and partial lifecycle management for other Kubernetes distributions. It is available in two ways: * As a standalone operator that you install as part of your {product-title} or {oke} subscription * As part of link:https://access.redhat.com/products/red-hat-advanced-cluster-management-for-kubernetes[Red Hat Advanced Cluster Management for Kubernetes] @@ -16,7 +16,7 @@ One of the challenges of scaling Kubernetes environments is managing the lifecyc When you enable multicluster engine on {product-title}, you gain the following capabilities: -* xref:../architecture/control-plane.adoc#hosted-control-planes-overview_control-plane[Hosted control planes], which is a feature that is based on the HyperShift project. With a centralized hosted control plane, you can operate {product-title} clusters in a hyperscale manner. +* xref:../architecture/control-plane.adoc#hosted-control-planes-overview_control-plane[{hcp-capital}], which is a feature that is based on the HyperShift project. With a centralized hosted control plane, you can operate {product-title} clusters in a hyperscale manner. * Hive, which provisions self-managed {product-title} clusters to the hub and completes the initial configurations for those clusters. * klusterlet agent, which registers managed clusters to the hub. * Infrastructure Operator, which manages the deployment of the Assisted Service to orchestrate on-premise bare metal and vSphere installations of {product-title}, such as {sno} on bare metal. The Infrastructure Operator includes xref:../edge_computing/ztp-deploying-far-edge-clusters-at-scale.adoc#ztp-challenges-of-far-edge-deployments_ztp-deploying-far-edge-clusters-at-scale[{ztp-first}], which fully automates cluster creation on bare metal and vSphere provisioning with GitOps workflows to manage deployments and configuration changes. diff --git a/hosted_control_planes/hcp-authentication-authorization.adoc b/hosted_control_planes/hcp-authentication-authorization.adoc index 89419807b2..1ce7666ddb 100644 --- a/hosted_control_planes/hcp-authentication-authorization.adoc +++ b/hosted_control_planes/hcp-authentication-authorization.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: ASSEMBLY [id="hcp-authentication-authorization"] -= Authentication and authorization for hosted control planes include::_attributes/common-attributes.adoc[] += Authentication and authorization for {hcp} :context: hcp-authentication-authorization toc::[] diff --git a/hosted_control_planes/hcp-backup-restore-dr.adoc b/hosted_control_planes/hcp-backup-restore-dr.adoc index 824ef38320..15ef802cf8 100644 --- a/hosted_control_planes/hcp-backup-restore-dr.adoc +++ b/hosted_control_planes/hcp-backup-restore-dr.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: ASSEMBLY [id="hcp-backup-restore-dr"] -= Backup, restore, and disaster recovery for hosted control planes include::_attributes/common-attributes.adoc[] += Backup, restore, and disaster recovery for {hcp} :context: hcp-backup-restore-dr toc::[] @@ -19,11 +19,11 @@ include::modules/hosted-cluster-single-node-recovery.adoc[leveloffset=+2] [id="hcp-backup-restore"] == Backing up and restoring etcd on a hosted cluster on {aws-short} -If you use hosted control planes for {product-title}, the process to back up and restore etcd is different from xref:../backup_and_restore/control_plane_backup_and_restore/backing-up-etcd.adoc#backing-up-etcd-data_backup-etcd[the usual etcd backup process]. +If you use {hcp} for {product-title}, the process to back up and restore etcd is different from xref:../backup_and_restore/control_plane_backup_and_restore/backing-up-etcd.adoc#backing-up-etcd-data_backup-etcd[the usual etcd backup process]. -The following procedures are specific to hosted control planes on {aws-short}. +The following procedures are specific to {hcp} on {aws-short}. -:FeatureName: Hosted control planes on the {aws-short} platform +:FeatureName: {hcp-capital} on the {aws-short} platform include::snippets/technology-preview.adoc[] // Backing up etcd on a hosted cluster @@ -40,7 +40,7 @@ include::modules/hosted-cluster-etcd-backup-restore-on-prem.adoc[leveloffset=+1] In a situation where you need disaster recovery (DR) for a hosted cluster, you can recover a hosted cluster to the same region within {aws-short}. For example, you need DR when the upgrade of a management cluster fails and the hosted cluster is in a read-only state. -:FeatureName: Hosted control planes +:FeatureName: {hcp-capital} include::snippets/technology-preview.adoc[] The DR process involves three main steps: diff --git a/hosted_control_planes/hcp-getting-started.adoc b/hosted_control_planes/hcp-getting-started.adoc index a6e2b0b870..8a0e513a33 100644 --- a/hosted_control_planes/hcp-getting-started.adoc +++ b/hosted_control_planes/hcp-getting-started.adoc @@ -1,12 +1,12 @@ :_mod-docs-content-type: ASSEMBLY [id="hcp-getting-started"] -= Getting started with hosted control planes include::_attributes/common-attributes.adoc[] += Getting started with {hcp} :context: hcp-getting-started toc::[] -To get started with hosted control planes for {product-title}, you first configure your hosted cluster on the provider that you want to use. Then, you complete a few management tasks. +To get started with {hcp} for {product-title}, you first configure your hosted cluster on the provider that you want to use. Then, you complete a few management tasks. You can view the procedures by selecting from one of the following providers: @@ -24,7 +24,7 @@ You can view the procedures by selecting from one of the following providers: ** Scale the `NodePool` object for the hosted cluster ** Handle ingress traffic for the hosted cluster ** Enable node auto-scaling for the hosted cluster -* link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.10/html/clusters/cluster_mce_overview#configure-hosted-disconnected[Configuring hosted control planes in a disconnected environment] +* link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.10/html/clusters/cluster_mce_overview#configure-hosted-disconnected[Configuring {hcp} in a disconnected environment] * To destroy a hosted cluster on bare metal, follow the instructions in link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.10/html/clusters/cluster_mce_overview#hypershift-cluster-destroy-bm[Destroying a hosted cluster on bare metal]. * If you want to disable the hosted control plane feature, see link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.10/html/clusters/cluster_mce_overview#disable-hosted-control-planes[Disabling the hosted control plane feature]. @@ -36,7 +36,7 @@ You can view the procedures by selecting from one of the following providers: * link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.10/html/clusters/cluster_mce_overview#hosted-install-cli[Installing the hosted control plane command line interface] * link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.10/html/clusters/cluster_mce_overview#hosted-cluster-workload-distributing[Distributing hosted cluster workloads] * link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.10/html/clusters/cluster_mce_overview#hosted-control-planes-manage-kubevirt[Managing hosted control plane clusters on OpenShift Virtualization]: Create {product-title} clusters with worker nodes that are hosted by KubeVirt virtual machines. -* link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.10/html/clusters/cluster_mce_overview#configure-hosted-disconnected[Configuring hosted control planes in a disconnected environment] +* link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.10/html/clusters/cluster_mce_overview#configure-hosted-disconnected[Configuring {hcp} in a disconnected environment] * To destroy a hosted cluster is on {VirtProductName}, follow the instructions in link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.10/html/clusters/cluster_mce_overview#hypershift-cluster-destroy-kubevirt[Destroying a hosted cluster on OpenShift Virtualization]. * If you want to disable the hosted control plane feature, see link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.10/html/clusters/cluster_mce_overview#disable-hosted-control-planes[Disabling the hosted control plane feature]. @@ -44,12 +44,12 @@ You can view the procedures by selecting from one of the following providers: [id="hcp-getting-started-aws"] == {aws-first} -:FeatureName: Hosted control planes on the {aws-short} platform +:FeatureName: {hcp-capital} on the {aws-short} platform include::snippets/technology-preview.adoc[] * link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.10/html/clusters/cluster_mce_overview#hosting-cluster-aws-infra-reqs[AWS infrastructure requirements]: Review the infrastructure requirements to create a hosted cluster on {aws-short}. * link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.10/html/clusters/cluster_mce_overview#hosting-service-cluster-configure-aws[Configuring hosted control plane clusters on AWS (Technology Preview)]: The tasks to configure hosted control plane clusters on {aws-short} include creating the {aws-short} S3 OIDC secret, creating a routable public zone, enabling external DNS, enabling {aws-short} PrivateLink, and deploying a hosted cluster. -* xref:../networking/hardware_networks/configuring-sriov-operator.adoc#sriov-operator-hosted-control-planes_configuring-sriov-operator[Deploying the SR-IOV Operator for hosted control planes]: After you configure and deploy your hosting service cluster, you can create a subscription to the Single Root I/O Virtualization (SR-IOV) Operator on a hosted cluster. The SR-IOV pod runs on worker machines rather than the control plane. +* xref:../networking/hardware_networks/configuring-sriov-operator.adoc#sriov-operator-hosted-control-planes_configuring-sriov-operator[Deploying the SR-IOV Operator for {hcp}]: After you configure and deploy your hosting service cluster, you can create a subscription to the Single Root I/O Virtualization (SR-IOV) Operator on a hosted cluster. The SR-IOV pod runs on worker machines rather than the control plane. * To destroy a hosted cluster on AWS, follow the instructions in link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.10/html/clusters/cluster_mce_overview#hypershift-cluster-destroy-aws[Destroying a hosted cluster on AWS]. * If you want to disable the hosted control plane feature, see link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.10/html/clusters/cluster_mce_overview#disable-hosted-control-planes[Disabling the hosted control plane feature]. @@ -57,7 +57,7 @@ include::snippets/technology-preview.adoc[] [id="hcp-getting-started-ibmz"] == {ibm-z-title} -:FeatureName: Hosted control planes on the {ibm-z-title} platform +:FeatureName: {hcp-capital} on the {ibm-z-title} platform include::snippets/technology-preview.adoc[] * link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.10/html/clusters/cluster_mce_overview#hosted-install-cli[Installing the hosted control plane command line interface] @@ -66,16 +66,16 @@ include::snippets/technology-preview.adoc[] [id="hcp-getting-started-ibmpower"] == {ibm-power-title} -:FeatureName: Hosted control planes on the {ibm-power-title} platform +:FeatureName: {hcp-capital} on the {ibm-power-title} platform include::snippets/technology-preview.adoc[] * link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.10/html/clusters/cluster_mce_overview#hosted-install-cli[Installing the hosted control plane command line interface] -* link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.10/html/clusters/cluster_mce_overview#config-hosted-service-ibmpower[Configuring the hosting cluster on a 64-bit x86 OpenShift Container Platform cluster to create hosted control planes for IBM Power compute nodes (Technology Preview)] +* link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.10/html/clusters/cluster_mce_overview#config-hosted-service-ibmpower[Configuring the hosting cluster on a 64-bit x86 OpenShift Container Platform cluster to create {hcp} for IBM Power compute nodes (Technology Preview)] [id="hcp-getting-started-non-bm-agent"] == Non bare metal agent machines -:FeatureName: Hosted control planes clusters using non bare metal agent machines +:FeatureName: {hcp-capital} clusters using non bare metal agent machines include::snippets/technology-preview.adoc[] * link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.10/html/clusters/cluster_mce_overview#hosted-install-cli[Installing the hosted control plane command line interface] diff --git a/hosted_control_planes/hcp-observability.adoc b/hosted_control_planes/hcp-observability.adoc index a2c498d5a6..2d51b05550 100644 --- a/hosted_control_planes/hcp-observability.adoc +++ b/hosted_control_planes/hcp-observability.adoc @@ -1,12 +1,12 @@ :_mod-docs-content-type: ASSEMBLY [id="hcp-observability"] -= Hosted control planes Observability include::_attributes/common-attributes.adoc[] += {hcp-capital} Observability :context: hcp-observability toc::[] -You can gather metrics for hosted control planes by configuring metrics sets. The HyperShift Operator can create or delete monitoring dashboards in the management cluster for each hosted cluster that it manages. +You can gather metrics for {hcp} by configuring metrics sets. The HyperShift Operator can create or delete monitoring dashboards in the management cluster for each hosted cluster that it manages. //using service-level DNS for control plane services include::modules/hosted-control-planes-metrics-sets.adoc[leveloffset=+1] diff --git a/hosted_control_planes/hcp-troubleshooting.adoc b/hosted_control_planes/hcp-troubleshooting.adoc index 9a7421326a..51d2b7d826 100644 --- a/hosted_control_planes/hcp-troubleshooting.adoc +++ b/hosted_control_planes/hcp-troubleshooting.adoc @@ -1,12 +1,12 @@ :_mod-docs-content-type: ASSEMBLY [id="hcp-troubleshooting"] -= Troubleshooting hosted control planes include::_attributes/common-attributes.adoc[] += Troubleshooting {hcp} :context: hcp-troubleshooting toc::[] -If you encounter issues with hosted control planes, see the following information to guide you through troubleshooting. +If you encounter issues with {hcp}, see the following information to guide you through troubleshooting. include::modules/hosted-control-planes-troubleshooting.adoc[leveloffset=+1] diff --git a/hosted_control_planes/hcp-updating.adoc b/hosted_control_planes/hcp-updating.adoc index bb60f57947..98dfc03ff0 100644 --- a/hosted_control_planes/hcp-updating.adoc +++ b/hosted_control_planes/hcp-updating.adoc @@ -1,12 +1,12 @@ :_mod-docs-content-type: ASSEMBLY [id="hcp-updating"] -= Updating hosted control planes include::_attributes/common-attributes.adoc[] += Updating {hcp} :context: hcp-updating toc::[] -Updates for hosted control planes involve updating the hosted cluster and the node pools. For a cluster to remain fully operational during an update process, you must meet the requirements of the link:https://kubernetes.io/releases/version-skew-policy/[Kubernetes version skew policy] while completing the control plane and node updates. +Updates for {hcp} involve updating the hosted cluster and the node pools. For a cluster to remain fully operational during an update process, you must meet the requirements of the link:https://kubernetes.io/releases/version-skew-policy/[Kubernetes version skew policy] while completing the control plane and node updates. // Updates for the hosted cluster include::modules/hcp-updates-hosted-cluster.adoc[leveloffset=+1] diff --git a/hosted_control_planes/index.adoc b/hosted_control_planes/index.adoc index 1acb0b0319..46d37429bc 100644 --- a/hosted_control_planes/index.adoc +++ b/hosted_control_planes/index.adoc @@ -1,10 +1,10 @@ :_mod-docs-content-type: ASSEMBLY [id="hcp-overview"] -= Hosted control planes overview include::_attributes/common-attributes.adoc[] += {hcp-capital} overview :context: hcp-overview -You can deploy {product-title} clusters by using two different control plane configurations: standalone or hosted control planes. The standalone configuration uses dedicated virtual machines or physical machines to host the control plane. With hosted control planes for {product-title}, you create control planes as pods on a hosting cluster without the need for dedicated virtual or physical machines for each control plane. +You can deploy {product-title} clusters by using two different control plane configurations: standalone or {hcp}. The standalone configuration uses dedicated virtual machines or physical machines to host the control plane. With {hcp} for {product-title}, you create control planes as pods on a hosting cluster without the need for dedicated virtual or physical machines for each control plane. toc::[] @@ -13,7 +13,7 @@ include::modules/hosted-control-planes-overview.adoc[leveloffset=+1] [role="_additional-resources"] .Additional resources -* link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.9/html/clusters/cluster_mce_overview#hosted-control-planes-intro[Hosted control planes] +* link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.9/html/clusters/cluster_mce_overview#hosted-control-planes-intro[{hcp-capital}] include::modules/hosted-control-planes-concepts-personas.adoc[leveloffset=+1] include::modules/hosted-control-planes-version-support.adoc[leveloffset=+1] diff --git a/installing/installing_with_agent_based_installer/preparing-an-agent-based-installed-cluster-for-mce.adoc b/installing/installing_with_agent_based_installer/preparing-an-agent-based-installed-cluster-for-mce.adoc index 91a3480db3..6d3a9aeac8 100644 --- a/installing/installing_with_agent_based_installer/preparing-an-agent-based-installed-cluster-for-mce.adoc +++ b/installing/installing_with_agent_based_installer/preparing-an-agent-based-installed-cluster-for-mce.adoc @@ -1,12 +1,12 @@ :_mod-docs-content-type: ASSEMBLY [id="preparing-an-agent-based-installed-cluster-for-mce"] -= Preparing an Agent-based installed cluster for the multicluster engine for Kubernetes Operator include::_attributes/common-attributes.adoc[] += Preparing an Agent-based installed cluster for the multicluster engine for Kubernetes operator :context: preparing-an-agent-based-installed-cluster-for-mce toc::[] -You can install the multicluster engine for Kubernetes Operator and deploy a hub cluster with the Agent-based {product-title} Installer. +You can install the multicluster engine for Kubernetes operator and deploy a hub cluster with the Agent-based {product-title} Installer. The following procedure is partially automated and requires manual steps after the initial cluster is deployed. == Prerequisites @@ -20,10 +20,10 @@ The following procedure is partially automated and requires manual steps after t * You have installed the OpenShift CLI (`oc`). * If you are installing in a disconnected environment, you must have a configured local mirror registry for disconnected installation mirroring. -// Preparing an Agent-based cluster deployment for the multicluster engine for Kubernetes Operator while disconnected +// Preparing an Agent-based cluster deployment for the multicluster engine for Kubernetes operator while disconnected include::modules/preparing-an-initial-cluster-deployment-for-mce-disconnected.adoc[leveloffset=+1] -// Preparing an Agent-based cluster deployment for the multicluster engine for Kubernetes Operator while connected +// Preparing an Agent-based cluster deployment for the multicluster engine for Kubernetes operator while connected include::modules/preparing-an-initial-cluster-deployment-for-mce-connected.adoc[leveloffset=+1] [role="_additional-resources"] diff --git a/modules/advanced-node-tuning-hosted-cluster.adoc b/modules/advanced-node-tuning-hosted-cluster.adoc index cf99ac0978..b437f82818 100644 --- a/modules/advanced-node-tuning-hosted-cluster.adoc +++ b/modules/advanced-node-tuning-hosted-cluster.adoc @@ -7,7 +7,7 @@ [id="advanced-node-tuning-hosted-cluster_{context}"] = Advanced node tuning for hosted clusters by setting kernel boot parameters -For more advanced tuning in hosted control planes, which requires setting kernel boot parameters, you can also use the Node Tuning Operator. The following example shows how you can create a node pool with huge pages reserved. +For more advanced tuning in {hcp}, which requires setting kernel boot parameters, you can also use the Node Tuning Operator. The following example shows how you can create a node pool with huge pages reserved. .Procedure @@ -150,4 +150,4 @@ $ oc --kubeconfig="$HC_KUBECONFIG" debug node/nodepool-1-worker-1 -- chroot /hos [source,terminal] ---- BOOT_IMAGE=(hd0,gpt3)/ostree/rhcos-... hugepagesz=2M hugepages=50 ----- \ No newline at end of file +---- diff --git a/modules/compliance-operator-hcp-install.adoc b/modules/compliance-operator-hcp-install.adoc index f4ccfb97f5..d45b440248 100644 --- a/modules/compliance-operator-hcp-install.adoc +++ b/modules/compliance-operator-hcp-install.adoc @@ -4,11 +4,11 @@ :_mod-docs-content-type: PROCEDURE [id="installing-compliance-operator-hcp_{context}"] -= Installing the Compliance Operator on Hosted control planes += Installing the Compliance Operator on {hcp} -The Compliance Operator can be installed in Hosted control planes using the OperatorHub by creating a `Subscription` file. +The Compliance Operator can be installed in {hcp} using the OperatorHub by creating a `Subscription` file. -:FeatureName: Hosted control planes +:FeatureName: {hcp-capital} include::snippets/technology-preview.adoc[] .Prerequisites @@ -106,4 +106,4 @@ $ oc get csv -n openshift-compliance [source,terminal] ---- $ oc get deploy -n openshift-compliance ----- \ No newline at end of file +---- diff --git a/modules/compliance-operator-hcp-mgmt-config.adoc b/modules/compliance-operator-hcp-mgmt-config.adoc index 7d28ef894b..7da372d388 100644 --- a/modules/compliance-operator-hcp-mgmt-config.adoc +++ b/modules/compliance-operator-hcp-mgmt-config.adoc @@ -4,18 +4,18 @@ :_mod-docs-content-type: PROCEDURE [id="co-hcp-mgmt-config_{context}"] -= Configuring the Hosted control planes management cluster += Configuring the {hcp} management cluster If you are hosting your own Hosted control plane or Hypershift environment and want to scan a Hosted Cluster from the management cluster, you will need to set the name and prefix namespace for the target Hosted Cluster. You can achieve this by creating a `TailoredProfile`. [IMPORTANT] ==== -This procedure only applies to users managing their own Hosted control planes environment. +This procedure only applies to users managing their own {hcp} environment. ==== [NOTE] ==== -Only `ocp4-cis` and `ocp4-pci-dss` profiles are supported in Hosted control planes management clusters. +Only `ocp4-cis` and `ocp4-pci-dss` profiles are supported in {hcp} management clusters. ==== .Prerequisites @@ -60,7 +60,7 @@ spec: rationale: This value is used for HyperShift control plane namespace detection value: local-cluster <3> ---- -<1> Variable. Only `ocp4-cis` and `ocp4-pci-dss` profiles are supported in Hosted control planes management clusters. +<1> Variable. Only `ocp4-cis` and `ocp4-pci-dss` profiles are supported in {hcp} management clusters. <2> The `value` is the `NAME` from the output in the previous step. <3> The `value` is the `NAMESPACE` from the output in the previous step. @@ -69,4 +69,4 @@ spec: [source,terminal] ---- $ oc create -n openshift-compliance -f mgmt-tp.yaml ----- \ No newline at end of file +---- diff --git a/modules/configuring-node-pools-for-hcp.adoc b/modules/configuring-node-pools-for-hcp.adoc index 8ba5188d63..9f89bfc38b 100644 --- a/modules/configuring-node-pools-for-hcp.adoc +++ b/modules/configuring-node-pools-for-hcp.adoc @@ -4,9 +4,9 @@ :_mod-docs-content-type: PROCEDURE [id="configuring-node-pools-for-hcp_{context}"] -= Configuring node pools for hosted control planes += Configuring node pools for {hcp} -On hosted control planes, you can configure node pools by creating a `MachineConfig` object inside of a config map in the management cluster. +On {hcp}, you can configure node pools by creating a `MachineConfig` object inside of a config map in the management cluster. //.Prerequisites diff --git a/modules/debug-nodes-hcp.adoc b/modules/debug-nodes-hcp.adoc index 468bcb3532..9d70a5bc91 100644 --- a/modules/debug-nodes-hcp.adoc +++ b/modules/debug-nodes-hcp.adoc @@ -1,4 +1,4 @@ -// Module included in the following assemblies: +{hcp-capital}// Module included in the following assemblies: // // * hosted_control_planes/hcp-troubleshooting.adoc @@ -8,7 +8,7 @@ If your control plane API endpoint is available, but worker nodes did not join the hosted cluster on AWS, you can debug worker node issues. To troubleshoot why worker nodes did not join the hosted cluster on AWS, you can check the following information. -:FeatureName: Hosted control planes on AWS +:FeatureName: {hcp-capital} on AWS include::snippets/technology-preview.adoc[] .Prerequisites @@ -106,4 +106,4 @@ $ SSH_PRIVATE_KEY=/tmp/ssh/id_rsa $ ./test/e2e/util/dump/copy-machine-journals.sh /tmp/journals ---- + -You must place journal logs in the `/tmp/journals` directory in a compressed format. Check for the error that indicates why kubelet did not join the cluster. \ No newline at end of file +You must place journal logs in the `/tmp/journals` directory in a compressed format. Check for the error that indicates why kubelet did not join the cluster. diff --git a/modules/hcp-updating-requirements.adoc b/modules/hcp-updating-requirements.adoc new file mode 100644 index 0000000000..7c426dfb5f --- /dev/null +++ b/modules/hcp-updating-requirements.adoc @@ -0,0 +1,21 @@ +// Module included in the following assemblies: +// +// * hosted-control-planes/hcp-updating.adoc + +:_mod-docs-content-type: CONCEPT +[id="hosted-control-planes-upgrading-requirements_{context}"] += Requirements to upgrade {hcp} + +The multicluster engine for Kubernetes operator can manage one or more {product-title} clusters. After you create a hosted cluster on {product-title}, you must import your hosted cluster in the multicluster engine for Kubernetes operator as a managed cluster. Then, you can use the {product-title} cluster as a management cluster. + +Consider the following requirements before you start updating {hcp}: + +* You must use the bare metal platform for an {product-title} cluster when using {VirtProductName} as a provider. + +* You must use bare metal or {VirtProductName} as the cloud platform for the hosted cluster. You can find the platform type of your hosted cluster in the `spec.Platform.type` specification of the `HostedCluster` custom resource(CR). + +You must upgrade the {product-title} cluster, multicluster engine for Kubernetes operator, hosted cluster, and node pools by completing the following tasks: + +. Upgrade an {product-title} cluster to the latest version. For more information, see "Updating a cluster using the web console" or "Updating a cluster using the CLI". +. Upgrade the multicluster engine for Kubernetes operator to the latest version. For more information, see "Updating installed Operators". +. Upgrade the hosted cluster and node pools from the previous {product-title} version to the latest version. For more information, see "Updating the hosted cluster for {hcp}" and "Updating node pools for {hcp}". diff --git a/modules/hosted-control-planes-concepts-personas.adoc b/modules/hosted-control-planes-concepts-personas.adoc index 6a6bdc092f..1f06b791c7 100644 --- a/modules/hosted-control-planes-concepts-personas.adoc +++ b/modules/hosted-control-planes-concepts-personas.adoc @@ -6,9 +6,9 @@ :_mod-docs-content-type: CONCEPT [id="hosted-control-planes-concepts-personas_{context}"] -= Glossary of common concepts and personas for hosted control planes += Glossary of common concepts and personas for {hcp} -When you use hosted control planes for {product-title}, it is important to understand its key concepts and the personas that are involved. +When you use {hcp} for {product-title}, it is important to understand its key concepts and the personas that are involved. [id="hosted-control-planes-concepts_{context}"] == Concepts @@ -21,7 +21,7 @@ hosted control plane:: An {product-title} control plane that runs on the managem hosting cluster:: See _management cluster_. -managed cluster:: A cluster that the hub cluster manages. This term is specific to the cluster lifecycle that the multicluster engine for Kubernetes Operator manages in Red Hat Advanced Cluster Management. A managed cluster is not the same thing as a _management cluster_. For more information, see link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.9/html/about/welcome-to-red-hat-advanced-cluster-management-for-kubernetes#managed-cluster[Managed cluster]. +managed cluster:: A cluster that the hub cluster manages. This term is specific to the cluster lifecycle that the multicluster engine for Kubernetes operator manages in Red Hat Advanced Cluster Management. A managed cluster is not the same thing as a _management cluster_. For more information, see link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.9/html/about/welcome-to-red-hat-advanced-cluster-management-for-kubernetes#managed-cluster[Managed cluster]. management cluster:: An {product-title} cluster where the HyperShift Operator is deployed and where the control planes for hosted clusters are hosted. The management cluster is synonymous with the _hosting cluster_. @@ -40,6 +40,3 @@ cluster service provider:: Users who assume this role typically have the `cluste ** Owning service-level objects for control plane availability, uptime, and stability ** Configuring the cloud account for the management cluster to host control planes ** Configuring the user-provisioned infrastructure, which includes the host awareness of available compute resources - - - diff --git a/modules/hosted-control-planes-metrics-sets.adoc b/modules/hosted-control-planes-metrics-sets.adoc index 19be12e092..649a11c4db 100644 --- a/modules/hosted-control-planes-metrics-sets.adoc +++ b/modules/hosted-control-planes-metrics-sets.adoc @@ -4,9 +4,9 @@ :_mod-docs-content-type: PROCEDURE [id="hosted-control-planes-metrics-sets_{context}"] -= Configuring metrics sets for hosted control planes += Configuring metrics sets for {hcp} -Hosted control planes for Red Hat {product-title} creates `ServiceMonitor` resources in each control plane namespace that allow a Prometheus stack to gather metrics from the control planes. The `ServiceMonitor` resources use metrics relabelings to define which metrics are included or excluded from a particular component, such as etcd or the Kubernetes API server. The number of metrics that are produced by control planes directly impacts the resource requirements of the monitoring stack that gathers them. +{hcp-capital} for Red Hat {product-title} creates `ServiceMonitor` resources in each control plane namespace that allow a Prometheus stack to gather metrics from the control planes. The `ServiceMonitor` resources use metrics relabelings to define which metrics are included or excluded from a particular component, such as etcd or the Kubernetes API server. The number of metrics that are produced by control planes directly impacts the resource requirements of the monitoring stack that gathers them. Instead of producing a fixed number of metrics that apply to all situations, you can configure a metrics set that identifies a set of metrics to produce for each control plane. The following metrics sets are supported: diff --git a/modules/hosted-control-planes-overview.adoc b/modules/hosted-control-planes-overview.adoc index 98c062acb9..0df0becfa3 100644 --- a/modules/hosted-control-planes-overview.adoc +++ b/modules/hosted-control-planes-overview.adoc @@ -6,11 +6,11 @@ :_mod-docs-content-type: CONCEPT [id="hosted-control-planes-overview_{context}"] -= Introduction to hosted control planes += Introduction to {hcp} -You can use hosted control planes for Red Hat {product-title} to reduce management costs, optimize cluster deployment time, and separate management and workload concerns so that you can focus on your applications. +You can use {hcp} for Red Hat {product-title} to reduce management costs, optimize cluster deployment time, and separate management and workload concerns so that you can focus on your applications. -Hosted control planes is available by using the link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.9/html/clusters/cluster_mce_overview#cluster_mce_overview[multicluster engine for Kubernetes operator version 2.0 or later] on the following platforms: +{hcp-capital} is available by using the link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.9/html/clusters/cluster_mce_overview#cluster_mce_overview[multicluster engine for Kubernetes operator version 2.0 or later] on the following platforms: * Bare metal by using the Agent provider * {VirtProductName} @@ -19,7 +19,7 @@ Hosted control planes is available by using the link:https://access.redhat.com/d * {ibm-power-title}, as a Technology Preview feature [id="hosted-control-planes-architecture_{context}"] -== Architecture of hosted control planes +== Architecture of {hcp} {product-title} is often deployed in a coupled, or standalone, model, where a cluster consists of a control plane and a data plane. The control plane includes an API endpoint, a storage endpoint, a workload scheduler, and an actuator that ensures state. The data plane includes compute, storage, and networking where workloads and applications run. @@ -30,16 +30,16 @@ Although the standalone model works well, some situations require an architectur image::hosted-control-planes-diagram.png[Diagram that compares the hosted control plane model against OpenShift with a coupled control plane and workers] [id="hosted-control-planes-benefits_{context}"] -== Benefits of hosted control planes +== Benefits of {hcp} -With hosted control planes for {product-title}, you can pave the way for a true hybrid-cloud approach and enjoy several other benefits. +With {hcp} for {product-title}, you can pave the way for a true hybrid-cloud approach and enjoy several other benefits. * The security boundaries between management and workloads are stronger because the control plane is decoupled and hosted on a dedicated hosting service cluster. As a result, you are less likely to leak credentials for clusters to other users. Because infrastructure secret account management is also decoupled, cluster infrastructure administrators cannot accidentally delete control plane infrastructure. -* With hosted control planes, you can run many control planes on fewer nodes. As a result, clusters are more affordable. +* With {hcp}, you can run many control planes on fewer nodes. As a result, clusters are more affordable. * Because the control planes consist of pods that are launched on {product-title}, control planes start quickly. The same principles apply to control planes and workloads, such as monitoring, logging, and auto-scaling. * From an infrastructure perspective, you can push registries, HAProxy, cluster monitoring, storage nodes, and other infrastructure components to the tenant's cloud provider account, isolating usage to the tenant. -* From an operational perspective, multicluster management is more centralized, which results in fewer external factors that affect the cluster status and consistency. Site reliability engineers have a central place to debug issues and navigate to the cluster data plane, which can lead to shorter Time to Resolution (TTR) and greater productivity. \ No newline at end of file +* From an operational perspective, multicluster management is more centralized, which results in fewer external factors that affect the cluster status and consistency. Site reliability engineers have a central place to debug issues and navigate to the cluster data plane, which can lead to shorter Time to Resolution (TTR) and greater productivity. diff --git a/modules/hosted-control-planes-support-matrix.adoc b/modules/hosted-control-planes-support-matrix.adoc index ecf3bdd508..6acf07155e 100644 --- a/modules/hosted-control-planes-support-matrix.adoc +++ b/modules/hosted-control-planes-support-matrix.adoc @@ -5,7 +5,7 @@ :_mod-docs-content-type: CONCEPT [id="hosted-control-planes-upgrading-scenarios_{context}"] -= Upgrading scenarios for hosted control planes += Upgrading scenarios for {hcp} Consider the following information before you upgrade: diff --git a/modules/hosted-control-planes-troubleshooting.adoc b/modules/hosted-control-planes-troubleshooting.adoc index 02700bff4f..b5d5473270 100644 --- a/modules/hosted-control-planes-troubleshooting.adoc +++ b/modules/hosted-control-planes-troubleshooting.adoc @@ -4,7 +4,7 @@ :_mod-docs-content-type: PROCEDURE [id="hosted-control-planes-troubleshooting_{context}"] -= Gathering information to troubleshoot hosted control planes += Gathering information to troubleshoot {hcp} When you need to troubleshoot an issue with hosted control plane clusters, you can gather information by running the `hypershift dump cluster` command. The command generates output for the management cluster and the hosted cluster. @@ -29,7 +29,7 @@ Although the output does not contain any secret objects from the cluster, it can * You need the `name` value for the `HostedCluster` resource and the namespace where the CR is deployed. -* You must have the `hcp` command line interface installed. For more information, see link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.9/html/clusters/cluster_mce_overview#hosted-install-cli[Installing the hosted control planes command line interface]. +* You must have the `hcp` command line interface installed. For more information, see link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.9/html/clusters/cluster_mce_overview#hosted-install-cli[Installing the {hcp} command line interface]. * You must have the OpenShift CLI (`oc`) installed. diff --git a/modules/hosted-control-planes-version-support.adoc b/modules/hosted-control-planes-version-support.adoc index 80cd261f31..23aa8e73c9 100644 --- a/modules/hosted-control-planes-version-support.adoc +++ b/modules/hosted-control-planes-version-support.adoc @@ -6,9 +6,9 @@ :_mod-docs-content-type: CONCEPT [id="hosted-control-planes-version-support_{context}"] -= Versioning for hosted control planes += Versioning for {hcp} -With each major, minor, or patch version release of {product-title}, two components of hosted control planes are released: +With each major, minor, or patch version release of {product-title}, two components of {hcp} are released: * HyperShift Operator * Command-line interface (CLI) @@ -33,6 +33,3 @@ The CLI is a helper utility for development purposes. The CLI is released as par The API, `hypershift.openshift.io`, provides a way to create and manage lightweight, flexible, heterogeneous {product-title} clusters at scale. The API exposes two user-facing resources: `HostedCluster` and `NodePool`. A `HostedCluster` resource encapsulates the control plane and common data plane configuration. When you create a `HostedCluster` resource, you have a fully functional control plane with no attached nodes. A `NodePool` resource is a scalable set of worker nodes that is attached to a `HostedCluster` resource. The API version policy generally aligns with the policy for link:https://kubernetes.io/docs/reference/using-api/#api-versioning[Kubernetes API versioning]. - - - diff --git a/modules/node-tuning-hosted-cluster.adoc b/modules/node-tuning-hosted-cluster.adoc index bbe5a2729e..b509da7524 100644 --- a/modules/node-tuning-hosted-cluster.adoc +++ b/modules/node-tuning-hosted-cluster.adoc @@ -8,7 +8,7 @@ //# Manage node-level tuning with the Node Tuning Operator -To set node-level tuning on the nodes in your hosted cluster, you can use the Node Tuning Operator. In hosted control planes, you can configure node tuning by creating config maps that contain `Tuned` objects and referencing those config maps in your node pools. +To set node-level tuning on the nodes in your hosted cluster, you can use the Node Tuning Operator. In {hcp}, you can configure node tuning by creating config maps that contain `Tuned` objects and referencing those config maps in your node pools. .Procedure @@ -75,7 +75,7 @@ $ oc --kubeconfig="$MGMT_KUBECONFIG" create -f tuned-1.yaml + [NOTE] ==== -You can reference the same config map in multiple node pools. In hosted control planes, the Node Tuning Operator appends a hash of the node pool name and namespace to the name of the Tuned CRs to distinguish them. Outside of this case, do not create multiple TuneD profiles of the same name in different Tuned CRs for the same hosted cluster. +You can reference the same config map in multiple node pools. In {hcp}, the Node Tuning Operator appends a hash of the node pool name and namespace to the name of the Tuned CRs to distinguish them. Outside of this case, do not create multiple TuneD profiles of the same name in different Tuned CRs for the same hosted cluster. ==== .Verification @@ -129,4 +129,4 @@ $ oc --kubeconfig="$HC_KUBECONFIG" debug node/nodepool-1-worker-1 -- chroot /hos [source,terminal] ---- vm.dirty_ratio = 55 ----- \ No newline at end of file +---- diff --git a/modules/nodes-descheduler-installing.adoc b/modules/nodes-descheduler-installing.adoc index b8ba56c96c..9459659407 100644 --- a/modules/nodes-descheduler-installing.adoc +++ b/modules/nodes-descheduler-installing.adoc @@ -20,7 +20,7 @@ By default, the descheduler runs in predictive mode, which means that it only si [IMPORTANT] ==== -If you have enabled hosted control planes in your cluster, set a custom priority threshold to lower the chance that pods in the hosted control plane namespaces are evicted. Set the priority threshold class name to `hypershift-control-plane`, because it has the lowest priority value (`100000000`) of the hosted control plane priority classes. +If you have enabled {hcp} in your cluster, set a custom priority threshold to lower the chance that pods in the hosted control plane namespaces are evicted. Set the priority threshold class name to `hypershift-control-plane`, because it has the lowest priority value (`100000000`) of the hosted control plane priority classes. ==== .Prerequisites diff --git a/modules/nw-ovn-ipsec-external.adoc b/modules/nw-ovn-ipsec-external.adoc index 364d1d4aca..592ba9b8b6 100644 --- a/modules/nw-ovn-ipsec-external.adoc +++ b/modules/nw-ovn-ipsec-external.adoc @@ -23,7 +23,7 @@ This feature is supported on the following platforms: If you have {op-system-base-full} worker nodes, these do not support IPsec encryption for external traffic. ==== -If your cluster uses hosted control planes for Red Hat {product-title}, configuring IPsec for encrypting traffic to external hosts is not supported. +If your cluster uses {hcp} for Red Hat {product-title}, configuring IPsec for encrypting traffic to external hosts is not supported. [id="ipsec-external-limitations_{context}"] == Limitations diff --git a/modules/preparing-an-initial-cluster-deployment-for-mce-connected.adoc b/modules/preparing-an-initial-cluster-deployment-for-mce-connected.adoc index 97ce9c03be..e73f3701cc 100644 --- a/modules/preparing-an-initial-cluster-deployment-for-mce-connected.adoc +++ b/modules/preparing-an-initial-cluster-deployment-for-mce-connected.adoc @@ -5,9 +5,9 @@ :_mod-docs-content-type: PROCEDURE [id="preparing-an-initial-cluster-deployment-for-mce-connected_{context}"] -= Preparing an Agent-based cluster deployment for the multicluster engine for Kubernetes Operator while connected += Preparing an Agent-based cluster deployment for the multicluster engine for Kubernetes operator while connected -Create the required manifests for the multicluster engine for Kubernetes Operator, the Local Storage Operator (LSO), and to deploy an agent-based {product-title} cluster as a hub cluster. +Create the required manifests for the multicluster engine for Kubernetes operator, the Local Storage Operator (LSO), and to deploy an agent-based {product-title} cluster as a hub cluster. .Procedure diff --git a/modules/preparing-an-initial-cluster-deployment-for-mce-disconnected.adoc b/modules/preparing-an-initial-cluster-deployment-for-mce-disconnected.adoc index 62f5974f48..73ac28955d 100644 --- a/modules/preparing-an-initial-cluster-deployment-for-mce-disconnected.adoc +++ b/modules/preparing-an-initial-cluster-deployment-for-mce-disconnected.adoc @@ -5,9 +5,9 @@ :_mod-docs-content-type: PROCEDURE [id="preparing-an-initial-cluster-deployment-for-mce-disconnected_{context}"] -= Preparing an Agent-based cluster deployment for the multicluster engine for Kubernetes Operator while disconnected += Preparing an Agent-based cluster deployment for the multicluster engine for Kubernetes operator while disconnected -You can mirror the required {product-title} container images, the multicluster engine for Kubernetes Operator, and the Local Storage Operator (LSO) into your local mirror registry in a disconnected environment. +You can mirror the required {product-title} container images, the multicluster engine for Kubernetes operator, and the Local Storage Operator (LSO) into your local mirror registry in a disconnected environment. Ensure that you note the local DNS hostname and port of your mirror registry. [NOTE] diff --git a/modules/sriov-operator-hosted-control-planes.adoc b/modules/sriov-operator-hosted-control-planes.adoc index a1bd916089..9044ff1170 100644 --- a/modules/sriov-operator-hosted-control-planes.adoc +++ b/modules/sriov-operator-hosted-control-planes.adoc @@ -5,9 +5,9 @@ :_mod-docs-content-type: PROCEDURE [id="sriov-operator-hosted-control-planes_{context}"] -= Deploying the SR-IOV Operator for hosted control planes += Deploying the SR-IOV Operator for {hcp} -:FeatureName: Hosted control planes on the AWS platform +:FeatureName: {hcp-capital} on the AWS platform include::snippets/technology-preview.adoc[] [role="_abstract"] @@ -78,4 +78,4 @@ sriov-network-operator.{product-version}.0-202211021237 SR-IOV Network Operato [source,terminal] ---- $ oc get pods -n openshift-sriov-network-operator ----- \ No newline at end of file +---- diff --git a/modules/updating-node-pools-for-hcp.adoc b/modules/updating-node-pools-for-hcp.adoc index d8c5b86225..60e6fbddde 100644 --- a/modules/updating-node-pools-for-hcp.adoc +++ b/modules/updating-node-pools-for-hcp.adoc @@ -5,9 +5,9 @@ :_mod-docs-content-type: PROCEDURE [id="updating-node-pools-for-hcp_{context}"] -= Updating node pools for hosted control planes += Updating node pools for {hcp} -On hosted control planes, you update your version of {product-title} by updating the node pools. The node pool version must not surpass the hosted control plane version. +On {hcp}, you update your version of {product-title} by updating the node pools. The node pool version must not surpass the hosted control plane version. .Procedure diff --git a/networking/openshift_network_security/configuring-ipsec-ovn.adoc b/networking/openshift_network_security/configuring-ipsec-ovn.adoc index 30365fa577..41f3275c93 100644 --- a/networking/openshift_network_security/configuring-ipsec-ovn.adoc +++ b/networking/openshift_network_security/configuring-ipsec-ovn.adoc @@ -12,7 +12,7 @@ IPsec is disabled by default. It can be enabled either during or after installin [IMPORTANT] ==== -If your cluster uses link:https://www.redhat.com/en/topics/containers/what-are-hosted-control-planes[hosted control planes] for Red Hat {product-title}, IPsec is not supported for IPsec encryption of either pod-to-pod or traffic to external hosts. +If your cluster uses link:https://www.redhat.com/en/topics/containers/what-are-hosted-control-planes[{hcp}] for Red Hat {product-title}, IPsec is not supported for IPsec encryption of either pod-to-pod or traffic to external hosts. ==== [NOTE] diff --git a/scalability_and_performance/using-node-tuning-operator.adoc b/scalability_and_performance/using-node-tuning-operator.adoc index 83ad562652..fe2b6b7bda 100644 --- a/scalability_and_performance/using-node-tuning-operator.adoc +++ b/scalability_and_performance/using-node-tuning-operator.adoc @@ -30,4 +30,4 @@ include::modules/advanced-node-tuning-hosted-cluster.adoc[leveloffset=+1] [role="_additional-resources"] .Additional resources -For more information about hosted control planes, see link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.9/html/clusters/cluster_mce_overview#hosted-control-planes-intro[Hosted control planes]. +For more information about {hcp}, see link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.9/html/clusters/cluster_mce_overview#hosted-control-planes-intro[{hcp-capital}]. diff --git a/security/compliance_operator/co-management/compliance-operator-installation.adoc b/security/compliance_operator/co-management/compliance-operator-installation.adoc index 95ec138ebc..97c53b9e46 100644 --- a/security/compliance_operator/co-management/compliance-operator-installation.adoc +++ b/security/compliance_operator/co-management/compliance-operator-installation.adoc @@ -38,10 +38,10 @@ include::modules/compliance-operator-hcp-install.adoc[leveloffset=+1] .Additional resources // 4.13+ -* xref:../../../hosted_control_planes/index.adoc#hcp-overview[Hosted control planes overview] +* xref:../../../hosted_control_planes/index.adoc#hcp-overview[{hcp-capital} overview] // // 4.11-4.12, commenting out of 4.13-main -//* xref:../../../architecture/control-plane.adoc#hosted-control-planes-overview_control-plane[Overview of hosted control planes (Technology Preview)] +//* xref:../../../architecture/control-plane.adoc#hosted-control-planes-overview_control-plane[Overview of {hcp} (Technology Preview)] [id="additional-resources-installing-the-compliance-operator"] [role="_additional-resources"] diff --git a/security/compliance_operator/compliance-operator-release-notes.adoc b/security/compliance_operator/compliance-operator-release-notes.adoc index c6a3c0e67b..e24965d0ce 100644 --- a/security/compliance_operator/compliance-operator-release-notes.adoc +++ b/security/compliance_operator/compliance-operator-release-notes.adoc @@ -159,7 +159,7 @@ The following advisory is available for the OpenShift Compliance Operator 1.1.0: * A start and end timestamp is now available in the `ComplianceScan` custom resource definition (CRD) status. -* The Compliance Operator can now be deployed on Hosted Control Planes using the OperatorHub by creating a `Subscription` file. For more information, see xref:../../security/compliance_operator/co-management/compliance-operator-installation.adoc#installing-compliance-operator-hcp_compliance-operator-installation[Installing the Compliance Operator on Hosted Control Planes]. +* The Compliance Operator can now be deployed on {hcp} using the OperatorHub by creating a `Subscription` file. For more information, see xref:../../security/compliance_operator/co-management/compliance-operator-installation.adoc#installing-compliance-operator-hcp_compliance-operator-installation[Installing the Compliance Operator on {hcp}]. [id="compliance-operator-1-1-0-bug-fixes"] === Bug fixes diff --git a/updating/index.adoc b/updating/index.adoc index 5ee4b0d6be..5cb265f460 100644 --- a/updating/index.adoc +++ b/updating/index.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: ASSEMBLY [id="updating-clusters-overview"] -= Updating clusters overview include::_attributes/common-attributes.adoc[] += Updating clusters overview :context: updating-clusters-overview toc::[] @@ -74,9 +74,9 @@ Version {product-version} of {product-title} requires VMware virtual hardware ve ==== [id="updating-clusters-overview-hosted-control-planes"] -== Updating hosted control planes +== Updating {hcp} -xref:../updating/updating_a_cluster/updating-hosted-control-planes.adoc#updating-hosted-control-planes[Updating hosted control planes]: On hosted control planes for {product-title}, updates are decoupled between the control plane and the nodes. Your service cluster provider, which is the user that hosts the cluster control planes, can manage the updates as needed. The hosted cluster handles control plane updates, and node pools handle node updates. For more information, see the following information: +xref:../updating/updating_a_cluster/updating-hosted-control-planes.adoc#updating-hosted-control-planes[Updating {hcp}]: On {hcp} for {product-title}, updates are decoupled between the control plane and the nodes. Your service cluster provider, which is the user that hosts the cluster control planes, can manage the updates as needed. The hosted cluster handles control plane updates, and node pools handle node updates. For more information, see the following information: -* xref:../updating/updating_a_cluster/updating-hosted-control-planes.adoc#updates-for-hosted-control-planes_updating-hosted-control-planes[Updates for hosted control planes] -* xref:../updating/updating_a_cluster/updating-hosted-control-planes.adoc#updating-node-pools-for-hcp_updating-hosted-control-planes[Updating node pools for hosted control planes] \ No newline at end of file +* xref:../updating/updating_a_cluster/updating-hosted-control-planes.adoc#updates-for-hosted-control-planes_updating-hosted-control-planes[Updates for {hcp}] +* xref:../updating/updating_a_cluster/updating-hosted-control-planes.adoc#updating-node-pools-for-hcp_updating-hosted-control-planes[Updating node pools for {hcp}] diff --git a/updating/updating_a_cluster/updating-hosted-control-planes.adoc b/updating/updating_a_cluster/updating-hosted-control-planes.adoc index 99f256b9e8..252821d001 100644 --- a/updating/updating_a_cluster/updating-hosted-control-planes.adoc +++ b/updating/updating_a_cluster/updating-hosted-control-planes.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: ASSEMBLY [id="updating-hosted-control-planes"] -= Updating hosted control planes include::_attributes/common-attributes.adoc[] += Updating {hcp} :context: updating-hosted-control-planes toc::[] @@ -12,7 +12,7 @@ WARNING: This assembly has been moved into a subdirectory for 4.14+. Changes to To do: Remove this comment once 4.13 docs are EOL. //// -On hosted control planes for {product-title}, updates are decoupled between the control plane and the nodes. Your service cluster provider, which is the user that hosts the cluster control planes, can manage the updates as needed. The hosted cluster handles control plane updates, and node pools handle node updates. +On {hcp} for {product-title}, updates are decoupled between the control plane and the nodes. Your service cluster provider, which is the user that hosts the cluster control planes, can manage the updates as needed. The hosted cluster handles control plane updates, and node pools handle node updates. include::modules/hcp-updates-hosted-cluster.adoc[leveloffset=+1] diff --git a/welcome/index.adoc b/welcome/index.adoc index 020a4667a4..29635c4804 100644 --- a/welcome/index.adoc +++ b/welcome/index.adoc @@ -323,15 +323,15 @@ endif::openshift-rosa[] ifdef::openshift-enterprise[] == Hosted control plane activities -* **Support for bare metal and {VirtProductName}**: Hosted control planes for {product-title} is now Generally Available on bare metal and {VirtProductName} platforms. For more information, see the following documentation: +* **Support for bare metal and {VirtProductName}**: {hcp-capital} for {product-title} is now Generally Available on bare metal and {VirtProductName} platforms. For more information, see the following documentation: ** link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.10/html/clusters/cluster_mce_overview#configuring-hosting-service-cluster-configure-bm[Configuring hosted control plane clusters on bare metal] ** link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.10/html/clusters/cluster_mce_overview#hosted-control-planes-manage-kubevirt[Managing hosted control plane clusters on OpenShift Virtualization] -* **Technology Preview features**: Hosted control planes remains available as a Technology Preview feature on the Amazon Web Services, {ibm-power-name}, and {ibm-z-name} platforms. You can now provision a hosted control plane cluster by using the non bare metal agent machines. For more information, see the following documentation: +* **Technology Preview features**: {hcp-capital} remains available as a Technology Preview feature on the Amazon Web Services, {ibm-power-name}, and {ibm-z-name} platforms. You can now provision a hosted control plane cluster by using the non bare metal agent machines. For more information, see the following documentation: ** link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.10/html/clusters/cluster_mce_overview#hosting-service-cluster-configure-aws[Configuring the hosting cluster on AWS (Technology Preview)] -** link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.10/html/clusters/cluster_mce_overview#config-hosted-service-ibmpower[Configuring the hosting cluster on a 64-bit x86 {product-title} cluster to create hosted control planes for {ibm-power-name} compute nodes (Technology Preview)] +** link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.10/html/clusters/cluster_mce_overview#config-hosted-service-ibmpower[Configuring the hosting cluster on a 64-bit x86 {product-title} cluster to create {hcp} for {ibm-power-name} compute nodes (Technology Preview)] ** link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.10/html/clusters/cluster_mce_overview#configuring-hosting-service-cluster-ibmz[Configuring the hosted cluster on 64-bit x86 bare metal for {ibm-z-name} compute nodes (Technology Preview)] ** link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.10/html/clusters/cluster_mce_overview#configuring-hosting-service-cluster-configure-agent-non-bm[Configuring hosted control plane clusters using non bare metal agent machines (Technology Preview)]