Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion hosted_control_planes/hcp-deploy/hcp-deploy-bm.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
2 changes: 1 addition & 1 deletion hosted_control_planes/hcp-deploy/hcp-deploy-ibm-power.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion hosted_control_planes/hcp-deploy/hcp-deploy-ibmz.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]

Expand Down
7 changes: 4 additions & 3 deletions hosted_control_planes/hcp-import.adoc
Original file line number Diff line number Diff line change
@@ -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]
Expand Down
7 changes: 3 additions & 4 deletions modules/hcp-import-disable.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down Expand Up @@ -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.
. To re-enable automatic import, set the value of the `autoImportDisabled` variable to `"false"` or remove the variable from the `AddonDeploymentConfig` resource.
3 changes: 2 additions & 1 deletion modules/hcp-import-limitations.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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".

Expand Down
23 changes: 12 additions & 11 deletions modules/hcp-import-manual-aws.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -24,24 +25,24 @@ metadata:
labels:
cloud: auto-detect
cluster.open-cluster-management.io/clusterset: default
name: <hosted_cluster_name> <1>
name: <hosted_cluster_name>
vendor: OpenShift
name: <hosted_cluster_name>
spec:
hubAcceptsClient: true
leaseDurationSeconds: 60
----
+
<1> Replace `<hosted_cluster_name>` with the name of your hosted cluster.
Replace `<hosted_cluster_name>` with the name of your hosted cluster.

. Run the following command to apply the resource:
+
[source,terminal]
----
$ oc apply -f <file_name> <1>
$ oc apply -f <file_name>
----
+
<1> Replace `<file_name>` with the YAML file name you created in the previous step.
Replace `<file_name>` 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:
+
Expand All @@ -50,8 +51,8 @@ $ oc apply -f <file_name> <1>
apiVersion: agent.open-cluster-management.io/v1
kind: KlusterletAddonConfig
metadata:
name: <hosted_cluster_name> <1>
namespace: <hosted_cluster_namespace> <2>
name: <hosted_cluster_name>
namespace: <hosted_cluster_namespace>
spec:
clusterName: <hosted_cluster_name>
clusterNamespace: <hosted_cluster_namespace>
Expand All @@ -70,17 +71,17 @@ spec:
enabled: false
----
+
<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.
* Replace `<hosted_cluster_name>` with the name of your hosted cluster.
* Replace `<hosted_cluster_namespace>` with the name of your hosted cluster namespace.

. Run the following command to apply the resource:
+
[source,terminal]
----
$ oc apply -f <file_name> <1>
$ oc apply -f <file_name>
----
+
<1> Replace `<file_name>` with the YAML file name you created in the previous step.
Replace `<file_name>` 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:
+
Expand Down
6 changes: 3 additions & 3 deletions modules/hcp-import-manual.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
====