From a9d48411e025af7e88268833a511153e156ad30f Mon Sep 17 00:00:00 2001 From: Laura Hinson Date: Fri, 10 Jul 2026 15:29:56 -0400 Subject: [PATCH] [OSDOCS-20645]: CQA: Importing a hosted cluster --- .../hcp-deploy/hcp-deploy-bm.adoc | 2 +- .../hcp-deploy/hcp-deploy-ibm-power.adoc | 2 +- .../hcp-deploy/hcp-deploy-ibmz.adoc | 2 +- hosted_control_planes/hcp-import.adoc | 7 +++--- modules/hcp-import-disable.adoc | 7 +++--- modules/hcp-import-limitations.adoc | 3 ++- modules/hcp-import-manual-aws.adoc | 23 ++++++++++--------- modules/hcp-import-manual.adoc | 6 ++--- 8 files changed, 27 insertions(+), 25 deletions(-) diff --git a/hosted_control_planes/hcp-deploy/hcp-deploy-bm.adoc b/hosted_control_planes/hcp-deploy/hcp-deploy-bm.adoc index 5e887b85ea4a..9ed71156decc 100644 --- a/hosted_control_planes/hcp-deploy/hcp-deploy-bm.adoc +++ b/hosted_control_planes/hcp-deploy/hcp-deploy-bm.adoc @@ -64,7 +64,7 @@ include::modules/hcp-bm-hc.adoc[leveloffset=+2] [role="_additional-resources"] .Additional resources -* xref:../../hosted_control_planes/hcp-import.adoc[Manually importing a hosted cluster] +* xref:../../hosted_control_planes/hcp-import.adoc#hcp-import[Manually importing a hosted cluster] * xref:../../hosted_control_planes/hcp-disconnected/hcp-deploy-dc-bm.adoc#hcp-dc-extract_hcp-deploy-dc-bm[Extracting the release image digest] * xref:../../hosted_control_planes/hcp-certificates.adoc#hcp-custom-cert_hcp-certificates[Configuring a custom API server certificate in a hosted cluster] * link:https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/latest/html/clusters/cluster_mce_overview#add-host-host-inventory[Adding hosts to the host inventory by using the Discovery Image] diff --git a/hosted_control_planes/hcp-deploy/hcp-deploy-ibm-power.adoc b/hosted_control_planes/hcp-deploy/hcp-deploy-ibm-power.adoc index 274e3fc01c62..28a88e665949 100644 --- a/hosted_control_planes/hcp-deploy/hcp-deploy-ibm-power.adoc +++ b/hosted_control_planes/hcp-deploy/hcp-deploy-ibm-power.adoc @@ -51,7 +51,7 @@ include::modules/hcp-bm-hc.adoc[leveloffset=+1] * xref:../../hosted_control_planes/hcp-prepare/hcp-requirements.adoc#hcp-requirements[Requirements for hosted control planes] * xref:../../hosted_control_planes/hcp-deploy/hcp-deploy-bm.adoc#hcp-bm-dns_hcp-deploy-bm[DNS configurations on bare metal] -* xref:../../hosted_control_planes/hcp-import.adoc[Manually importing a hosted cluster] +* xref:../../hosted_control_planes/hcp-import.adoc#hcp-import[Manually importing a hosted cluster] * xref:../../hosted_control_planes/hcp-disconnected/hcp-deploy-dc-bm.adoc#hcp-dc-extract_hcp-deploy-dc-bm[Extracting the release image digest] // About creating heterogeneous node pools on agent hosted clusters diff --git a/hosted_control_planes/hcp-deploy/hcp-deploy-ibmz.adoc b/hosted_control_planes/hcp-deploy/hcp-deploy-ibmz.adoc index 24a3b1b05445..ed8faf837059 100644 --- a/hosted_control_planes/hcp-deploy/hcp-deploy-ibmz.adoc +++ b/hosted_control_planes/hcp-deploy/hcp-deploy-ibmz.adoc @@ -42,7 +42,7 @@ include::modules/hcp-ibmz-create-hc.adoc[leveloffset=+1] [role="_additional-resources"] .Additional resources -* xref:../../hosted_control_planes/hcp-import.adoc[Manually importing a hosted cluster] +* xref:../../hosted_control_planes/hcp-import.adoc#hcp-import[Manually importing a hosted cluster] * xref:../../hosted_control_planes/hcp-disconnected/hcp-deploy-dc-bm.adoc#hcp-dc-extract_hcp-deploy-dc-bm[Extracting the release image digest] * xref:../../hosted_control_planes/hcp-deploy/hcp-deploy-bm.adoc#hcp-bm-hc-console_hcp-deploy-bm[Creating a hosted cluster on bare metal by using the console] diff --git a/hosted_control_planes/hcp-import.adoc b/hosted_control_planes/hcp-import.adoc index 8b53437fe292..ab8f1368f519 100644 --- a/hosted_control_planes/hcp-import.adoc +++ b/hosted_control_planes/hcp-import.adoc @@ -1,17 +1,18 @@ :_mod-docs-content-type: ASSEMBLY -[id="hcp-import"] include::_attributes/common-attributes.adoc[] +[id="hcp-import"] = Manually importing a hosted cluster :context: hcp-import toc::[] +[role="_abstract"] Hosted clusters are automatically imported into {mce-short} after the hosted control plane becomes available. include::modules/hcp-import-limitations.adoc[leveloffset=+1] -[role="_additional-resources_{context}"] -== Additional resources +[role="_additional-resources"] +.Additional resources * xref:../hosted_control_planes/hcp-updating.adoc#hcp-update-node-pools_hcp-updating[Updating node pools in a hosted cluster] * xref:../hosted_control_planes/hcp-updating.adoc#hcp-update-ocp-hc_hcp-updating[Updating a control plane in a hosted cluster] diff --git a/modules/hcp-import-disable.adoc b/modules/hcp-import-disable.adoc index c7a5400a3d08..24a5c0c587f5 100644 --- a/modules/hcp-import-disable.adoc +++ b/modules/hcp-import-disable.adoc @@ -6,21 +6,20 @@ [id="hcp-import-disable_{context}"] = Disabling the automatic import of hosted clusters into {mce-short} +[role="_abstract"] Hosted clusters are automatically imported into {mce-short} after the control plane becomes available. If needed, you can disable the automatic import of hosted clusters. Any hosted clusters that were previously imported are not affected, even if you disable automatic import. When you upgrade to {mce-short} 2.5 and automatic import is enabled, all hosted clusters that are not imported are automatically imported if their control planes are available. [NOTE] ==== -If Red{nbsp}Hat Advanced Cluster Management is installed, all Red{nbsp}Hat Advanced Cluster Management add-ons are also enabled. +If {rh-rhacm-title} is installed, all {rh-rhacm-title} add-ons are also enabled. ==== When automatic import is disabled, only newly created hosted clusters are not automatically imported. Hosted clusters that were already imported are not affected. You can still manually import clusters by using the console or by creating the `ManagedCluster` and `KlusterletAddonConfig` custom resources. .Procedure -To disable the automatic import of hosted clusters, complete the following steps: - . On the hub cluster, open the `hypershift-addon-deploy-config` specification that is in the `AddonDeploymentConfig` resource in the namespace where {mce-short} is installed by entering the following command: + [source,terminal] @@ -48,4 +47,4 @@ spec: value: "true" ---- -. To re-enable automatic import, set the value of the `autoImportDisabled` variable to `"false"` or remove the variable from the `AddonDeploymentConfig` resource. \ No newline at end of file +. To re-enable automatic import, set the value of the `autoImportDisabled` variable to `"false"` or remove the variable from the `AddonDeploymentConfig` resource. diff --git a/modules/hcp-import-limitations.adoc b/modules/hcp-import-limitations.adoc index 45eba0d3e578..6696ffa61e66 100644 --- a/modules/hcp-import-limitations.adoc +++ b/modules/hcp-import-limitations.adoc @@ -6,7 +6,8 @@ [id="hcp-import-limitations_{context}"] = Limitations of managing imported hosted clusters -Hosted clusters are automatically imported into the local {mce}, unlike a standalone {product-title} or third party clusters. Hosted clusters run some of their agents in the _hosted mode_ so that the agents do not use the resources of your cluster. +[role="_abstract"] +Hosted clusters are automatically imported into the local {mce}, unlike a standalone {product-title} or third-party clusters. Hosted clusters run some of their agents in the _hosted mode_ so that the agents do not use the resources of your cluster. If you choose to automatically import hosted clusters, you can update node pools and the control plane in hosted clusters by using the `HostedCluster` resource on the management cluster. To update node pools and a control plane, see "Updating node pools in a hosted cluster" and "Updating a control plane in a hosted cluster". diff --git a/modules/hcp-import-manual-aws.adoc b/modules/hcp-import-manual-aws.adoc index a23474fe7670..58a5cc5dd9e6 100644 --- a/modules/hcp-import-manual-aws.adoc +++ b/modules/hcp-import-manual-aws.adoc @@ -6,7 +6,8 @@ [id="hcp-import-manual-aws_{context}"] = Manually importing a hosted cluster on {aws-short} -You can also import a hosted cluster on {aws-first} with the command-line interface. +[role="_abstract"] +You can import a hosted cluster on {aws-first} with the command-line interface. .Procedure @@ -24,7 +25,7 @@ metadata: labels: cloud: auto-detect cluster.open-cluster-management.io/clusterset: default - name: <1> + name: vendor: OpenShift name: spec: @@ -32,16 +33,16 @@ spec: leaseDurationSeconds: 60 ---- + -<1> Replace `` with the name of your hosted cluster. +Replace `` with the name of your hosted cluster. . Run the following command to apply the resource: + [source,terminal] ---- -$ oc apply -f <1> +$ oc apply -f ---- + -<1> Replace `` with the YAML file name you created in the previous step. +Replace `` with the YAML file name you created in the previous step. . If you have {rh-rhacm-title} installed, create your `KlusterletAddonConfig` resource by using the following sample YAML file. If you have installed {mce-short} only, skip this step: + @@ -50,8 +51,8 @@ $ oc apply -f <1> apiVersion: agent.open-cluster-management.io/v1 kind: KlusterletAddonConfig metadata: - name: <1> - namespace: <2> + name: + namespace: spec: clusterName: clusterNamespace: @@ -70,17 +71,17 @@ spec: enabled: false ---- + -<1> Replace `` with the name of your hosted cluster. -<2> Replace `` with the name of your hosted cluster namespace. +* Replace `` with the name of your hosted cluster. +* Replace `` with the name of your hosted cluster namespace. . Run the following command to apply the resource: + [source,terminal] ---- -$ oc apply -f <1> +$ oc apply -f ---- + -<1> Replace `` with the YAML file name you created in the previous step. +Replace `` with the YAML file name you created in the previous step. . After the import process is complete, your hosted cluster becomes visible in the console. You can also check the status of your hosted cluster by running the following command: + diff --git a/modules/hcp-import-manual.adoc b/modules/hcp-import-manual.adoc index 37e8587b7762..51bab1d092bc 100644 --- a/modules/hcp-import-manual.adoc +++ b/modules/hcp-import-manual.adoc @@ -6,16 +6,16 @@ [id="hcp-import-manual_{context}"] = Manually importing hosted clusters -If you want to import hosted clusters manually, complete the following steps. +[role="_abstract"] +Typically, hosted clusters are automatically imported to {mce-short} after the hosted control plane becomes available. However, if needed, you can import hosted clusters manually. .Procedure . In the console, click *Infrastructure* -> *Clusters* and select the hosted cluster that you want to import. . Click *Import hosted cluster*. - + [NOTE] ==== -For your _discovered_ hosted cluster, you can also import from the console, but the cluster must be in an upgradable state. Import on your cluster is disabled if the hosted cluster is not in an upgradable state because the hosted control plane is not available. Click *Import* to begin the process. The status is `Importing` while the cluster receives updates and then changes to `Ready`. +For your _discovered_ hosted cluster, you can also import from the console, but the cluster must be in an upgradeable state. Import on your cluster is disabled if the hosted cluster is not in an upgradeable state because the hosted control plane is not available. Click *Import* to begin the process. The status is `Importing` while the cluster receives updates and then changes to `Ready`. ====