Skip to content

Commit d48bd50

Browse files
xenolinuxxenolinux
committed
OSDOCS#11568: Migrating Configuring HCP using non bare metal agent machines from ACM to OCP
1 parent 0c75505 commit d48bd50

19 files changed

+490
-18
lines changed

‎hosted_control_planes/hcp-deploy/hcp-deploy-non-bm.adoc

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,71 @@ include::_attributes/common-attributes.adoc[]
66

77
toc::[]
88

9+
You can deploy {hcp} by configuring a cluster to function as a hosting cluster. The hosting cluster is an {product-title} cluster where the control planes are hosted. The hosting cluster is also known as the management cluster.
910

11+
[NOTE]
12+
====
13+
The management cluster is not the same thing as the _managed_ cluster. A managed cluster is a cluster that the hub cluster manages.
14+
====
15+
16+
The {hcp} feature is enabled by default.
17+
18+
The {mce-short} supports only the default `local-cluster` managed hub cluster. On {rh-rhacm-first} 2.10, you can use the `local-cluster` managed hub cluster as the hosting cluster.
19+
20+
A _hosted cluster_ is an {product-title} cluster with its API endpoint and control plane that are hosted on the hosting cluster. The hosted cluster includes the control plane and its corresponding data plane. You can use the {mce-short} console or the `hcp` command-line interface (CLI) to create a hosted cluster.
21+
22+
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 {mce-short}".
23+
24+
include::modules/hcp-non-bm-prepare.adoc[leveloffset=+1]
25+
include::modules/hcp-non-bm-prereqs.adoc[leveloffset=+2]
26+
27+
[role="_additional-resources"]
28+
.Additional resources
29+
30+
* link:https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.11/html/clusters/cluster_mce_overview#advanced-config-engine[Advanced configuration]
31+
32+
* link:https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.11/html/clusters/cluster_mce_overview#enable-cim[Enabling the central infrastructure management service]
33+
34+
include::modules/hcp-non-bm-firewall-port-svc-reqs.adoc[leveloffset=+2]
35+
include::modules/hcp-non-bm-infra-reqs.adoc[leveloffset=+2]
36+
37+
[role="_additional-resources"]
38+
.Additional resources
39+
40+
* xref:../../scalability_and_performance/recommended-performance-scale-practices/recommended-etcd-practices.adoc#recommended-etcd-practices[Recommended etcd practices]
41+
42+
* xref:../../storage/persistent_storage/persistent_storage_local/persistent-storage-using-lvms.adoc#persistent-storage-using-lvms_logical-volume-manager-storage[Persistent storage using logical volume manager storage]
43+
44+
* xref:../../hosted_control_planes/hcp-import.adoc#hcp-import-disable_hcp-import[Disabling the automatic import of hosted clusters into {mce-short}]
45+
46+
* xref:../../hosted_control_planes/hcp-prepare/hcp-enable-disable.adoc[Enabling or disabling the {hcp} feature]
47+
48+
* link:https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.11/html/clusters/cluster_mce_overview#ansible-config-hosted-cluster[Configuring Ansible Automation Platform jobs to run on hosted clusters]
49+
50+
include::modules/hcp-non-bm-dns.adoc[leveloffset=+1]
51+
include::modules/hcp-non-bm-hc.adoc[leveloffset=+1]
52+
53+
[role="_additional-resources"]
54+
.Additional resources
55+
56+
* xref:../../hosted_control_planes/hcp-import.adoc[Manually importing a hosted control plane cluster]
57+
58+
include::modules/hcp-non-bm-hc-console.adoc[leveloffset=+2]
59+
60+
.Next steps
61+
62+
* To access the web console, see xref:../../web_console/web-console.adoc#web-console-overview[Accessing the web console].
63+
64+
include::modules/hcp-bm-hc-mirror.adoc[leveloffset=+2]
65+
66+
.Next steps
67+
68+
* To create credentials that you can reuse when you create a hosted cluster with the console, see link:https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.11/html/clusters/cluster_mce_overview#creating-a-credential-for-an-on-premises-environment[Creating a credential for an on-premises environment].
69+
70+
* To access a hosted cluster, see xref:../../hosted_control_planes/hcp-manage/hcp-manage-bm.adoc#hcp-bm-access_hcp-manage-bm[Accessing the hosted cluster].
71+
72+
* To add hosts to the host inventory by using the Discovery Image, see link:https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.11/html/clusters/cluster_mce_overview#add-host-host-inventory[Adding hosts to the host inventory by using the Discovery Image].
73+
74+
* To extract the {product-title} release image digest, see link:https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.11/html/clusters/cluster_mce_overview#configure-hosted-disconnected-digest-image[Extracting the {product-title} release image digest].
75+
76+
include::modules/hcp-non-bm-verify.adoc[leveloffset=+1]

‎hosted_control_planes/hcp-manage/hcp-manage-non-bm.adoc

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,30 @@ include::_attributes/common-attributes.adoc[]
66

77
toc::[]
88

9+
After you deploy {hcp} on non-bare metal agent machines, you can manage a hosted cluster by completing the following tasks.
910

11+
include::modules/hcp-bm-access.adoc[leveloffset=+1]
12+
include::modules/hcp-bm-scale-np.adoc[leveloffset=+1]
13+
include::modules/hcp-bm-add-np.adoc[leveloffset=+2]
14+
include::modules/hcp-bm-autoscale.adoc[leveloffset=+2]
15+
include::modules/hcp-bm-autoscale-disable.adoc[leveloffset=+2]
16+
17+
[role="_additional-resources"]
18+
.Additional resources
19+
20+
* xref:../../hosted_control_planes/hcp-troubleshooting.adoc#scale-down-data-plane_hcp-troubleshooting[Scaling down the data plane to zero]
21+
22+
include::modules/hcp-bm-ingress.adoc[leveloffset=+1]
23+
24+
[role="_additional-resources"]
25+
.Additional resources
26+
27+
* xref:../../networking/metallb/about-metallb.adoc#about-metallb[About MetalLB and the MetalLB Operator]
28+
29+
include::modules/hcp-bm-machine-health.adoc[leveloffset=+1]
30+
include::modules/hcp-bm-machine-health-disable.adoc[leveloffset=+1]
31+
32+
[role="_additional-resources"]
33+
.Additional resources
34+
35+
* xref:../../machine_management/deploying-machine-health-checks.adoc#deploying-machine-health-checks[Deploying machine health checks]

‎modules/hcp-bm-access.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
// Module included in the following assemblies:
22
//
33
// * hosted_control_planes/hcp-manage/hcp-manage-bm.adoc
4+
// * hosted_control_planes/hcp-manage/hcp-manage-non-bm.adoc
45

56
:_mod-docs-content-type: PROCEDURE
67
[id="hcp-bm-access_{context}"]
@@ -42,4 +43,4 @@ $ hcp create kubeconfig --namespace <hosted-cluster-namespace> --name <hosted-cl
4243
[source,terminal]
4344
----
4445
$ oc --kubeconfig <hosted-cluster-name>.kubeconfig get nodes
45-
----
46+
----

‎modules/hcp-bm-add-np.adoc

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
// Module included in the following assemblies:
22
//
33
// * hosted_control_planes/hcp-manage/hcp-manage-bm.adoc
4+
// * hosted_control_planes/hcp-manage/hcp-manage-non-bm.adoc
45

56
:_mod-docs-content-type: PROCEDURE
67
[id="hcp-bm-add-np_{context}"]
@@ -53,9 +54,11 @@ hostedcluster-secrets/kubeconfig
5354
$ oc --kubeconfig ./hostedcluster-secrets get nodes
5455
----
5556

56-
. Verify that the number of available node pools match the number of expected node pools by entering this command:
57+
.Verification
58+
59+
* Verify that the number of available node pools match the number of expected node pools by entering this command:
5760
+
5861
[source,terminal]
5962
----
6063
$ oc get nodepools --namespace clusters
61-
----
64+
----

‎modules/hcp-bm-autoscale-disable.adoc

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
// Module included in the following assemblies:
22
//
33
// * hosted_control_planes/hcp-manage/hcp-manage-bm.adoc
4+
// * hosted_control_planes/hcp-manage/hcp-manage-non-bm.adoc
45

56
:_mod-docs-content-type: PROCEDURE
67
[id="hcp-bm-autoscale-disable_{context}"]
@@ -10,11 +11,11 @@ To disable node auto-scaling, complete the following procedure.
1011

1112
.Procedure
1213

13-
* Enter the following command:
14+
* Enter the following command to disable node auto-scaling for the hosted cluster:
1415
+
1516
[source,terminal]
1617
----
17-
$ oc -n <hosted-cluster-namespace> patch nodepool <hosted-cluster-name> --type=json -p '[\{"op":"remove", "path": "/spec/autoScaling"}, \{"op": "add", "path": "/spec/replicas", "value": <specify-value-to-scale-replicas>]'
18+
$ oc -n <hosted_cluster_namespace> patch nodepool <hosted_cluster_name> --type=json -p '[\{"op":"remove", "path": "/spec/autoScaling"}, \{"op": "add", "path": "/spec/replicas", "value": <specify_value_to_scale_replicas>]'
1819
----
1920
+
20-
The command removes `"spec.autoScaling"` from the YAML file, adds `"spec.replicas"`, and sets `"spec.replicas"` to the integer value that you specify.
21+
The command removes `"spec.autoScaling"` from the YAML file, adds `"spec.replicas"`, and sets `"spec.replicas"` to the integer value that you specify.

‎modules/hcp-bm-autoscale.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
// Module included in the following assemblies:
22
//
33
// * hosted_control_planes/hcp-manage/hcp-manage-bm.adoc
4+
// * hosted_control_planes/hcp-manage/hcp-manage-non-bm.adoc
45

56
:_mod-docs-content-type: PROCEDURE
67
[id="hcp-bm-autoscale_{context}"]
@@ -97,4 +98,4 @@ $ oc --kubeconfig ./hostedcluster-secrets -n default delete deployment reversewo
9798
[source,terminal]
9899
----
99100
$ oc --kubeconfig ./hostedcluster-secrets get nodes
100-
----
101+
----

‎modules/hcp-bm-ingress.adoc

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
// Module included in the following assemblies:
22
//
33
// * hosted_control_planes/hcp-manage/hcp-manage-bm.adoc
4+
// * hosted_control_planes/hcp-manage/hcp-manage-non-bm.adoc
45

56
:_mod-docs-content-type: PROCEDURE
67
[id="hcp-bm-ingress_{context}"]
@@ -158,8 +159,12 @@ $ oc apply -f metallb-loadbalancer-service.yaml
158159
+
159160
[source,bash]
160161
----
161-
curl -kI https://console-openshift-console.apps.example.krnl.es
162-
162+
$ curl -kI https://console-openshift-console.apps.example.krnl.es
163+
----
164+
+
165+
.Example output
166+
[source,terminal]
167+
----
163168
HTTP/1.1 200 OK
164169
----
165170

@@ -174,11 +179,11 @@ $ oc --kubeconfig <hosted_cluster_name>.kubeconfig get clusterversion,co
174179
[source,terminal]
175180
----
176181
NAME VERSION AVAILABLE PROGRESSING SINCE STATUS
177-
clusterversion.config.openshift.io/version 4.x.y True False 3m32s Cluster version is 4.x.y
182+
clusterversion.config.openshift.io/version 4.x.y True False 3m32s Cluster version is 4.x.y
178183
179-
NAME VERSION AVAILABLE PROGRESSING DEGRADED SINCE MESSAGE
180-
clusteroperator.config.openshift.io/console 4.x.y True False False 3m50s
181-
clusteroperator.config.openshift.io/ingress 4.x.y True False False 53m
184+
NAME VERSION AVAILABLE PROGRESSING DEGRADED SINCE MESSAGE
185+
clusteroperator.config.openshift.io/console 4.x.y True False False 3m50s
186+
clusteroperator.config.openshift.io/ingress 4.x.y True False False 53m
182187
----
183188
+
184-
Replace `4.x.y` with the supported {product-title} version that you want to use, for example, `4.14.0-x86_64`.
189+
Replace `<4.x.y>` with the supported {product-title} version that you want to use, for example, `4.14.0-x86_64`.

‎modules/hcp-bm-machine-health-disable.adoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
// Module included in the following assemblies:
22
//
33
// * hosted_control_planes/hcp-manage/hcp-manage-bm.adoc
4+
// * hosted_control_planes/hcp-manage/hcp-manage-non-bm.adoc
45

56
:_mod-docs-content-type: PROCEDURE
67
[id="hcp-bm-machine-health-disable_{context}"]
78
= Disabling machine health checks on bare metal
89

9-
To disable machine health checks for the managed cluster nodes, modify the `NodePool` resource.
10+
To disable machine health checks for the managed cluster nodes, modify the `NodePool` resource.
1011

1112
.Procedure
1213

@@ -22,4 +23,4 @@ $ oc patch nodepool -n <hosted_cluster_namespace> <nodepool_name> -p '{"spec": {
2223
[source,terminal]
2324
----
2425
$ oc get nodepool -n <hosted_cluster_namespace> <nodepool_name> -o yaml | grep autoRepair
25-
----
26+
----

‎modules/hcp-bm-machine-health.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
// Module included in the following assemblies:
22
//
33
// * hosted_control_planes/hcp-manage/hcp-manage-bm.adoc
4+
// * hosted_control_planes/hcp-manage/hcp-manage-non-bm.adoc
45

56
:_mod-docs-content-type: PROCEDURE
67
[id="hcp-bm-machine-health_{context}"]
@@ -51,4 +52,4 @@ $ oc patch nodepool -n <hosted_cluster_namespace> <nodepool_name> -p '{"spec": {
5152
[source,terminal]
5253
----
5354
$ oc get nodepool -n <hosted_cluster_namespace> <nodepool_name> -o yaml | grep autoRepair
54-
----
55+
----

‎modules/hcp-bm-scale-np.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
// Module included in the following assemblies:
22
//
33
// * hosted_control_planes/hcp-manage/hcp-manage-bm.adoc
4+
// * hosted_control_planes/hcp-manage/hcp-manage-non-bm.adoc
45

56
:_mod-docs-content-type: PROCEDURE
67
[id="hcp-bm-scale-np_{context}"]
@@ -119,4 +120,4 @@ NAME V
119120
clusteroperator.config.openshift.io/console 4.12z False False False 11m RouteHealthAvailable: failed to GET route (https://console-openshift-console.apps.hypercluster1.domain.com): Get "https://console-openshift-console.apps.hypercluster1.domain.com": dial tcp 10.19.3.29:443: connect: connection refused
120121
clusteroperator.config.openshift.io/csi-snapshot-controller 4.12z True False False 10m
121122
clusteroperator.config.openshift.io/dns 4.12z True False False 9m16s
122-
----
123+
----

0 commit comments

Comments
 (0)