Skip to content

[OSDOCS-15316]: Creating a hosted cluster on bare metal #96275

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
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
48 changes: 39 additions & 9 deletions hosted_control_planes/hcp-deploy/hcp-deploy-bm.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ The {mce-short} supports only the default `local-cluster`, which is a hub cluste

A _hosted cluster_ is an {product-title} cluster with its API endpoint and control plane that are hosted on the management cluster. The hosted cluster includes the control plane and its corresponding data plane. You can use the {mce-short} console or the hosted control plane command-line interface, `hcp`, to create a hosted cluster.

The hosted cluster is automatically imported as a managed cluster. If you want to disable this automatic import feature, see _Disabling the automatic import of hosted clusters into {mce-short}_.
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}".

include::modules/hcp-bm-prepare.adoc[leveloffset=+1]
include::modules/hcp-bm-prereqs.adoc[leveloffset=+2]
Expand Down Expand Up @@ -48,23 +48,53 @@ include::modules/hcp-bm-infra-reqs.adoc[leveloffset=+2]
include::modules/hcp-bm-dns.adoc[leveloffset=+1]
include::modules/hcp-custom-dns.adoc[leveloffset=+2]

include::modules/hcp-bm-hc.adoc[leveloffset=+1]
[id="hcp-bm-create-infra"]
== Creating an infrastructure environment

Before you can create a hosted cluster on bare metal, you need an infrastructure environment.

include::modules/hcp-bm-add-nodes-to-inventory.adoc[leveloffset=+2]
include::modules/hcp-bm-create-infra-console.adoc[leveloffset=+2]

[id="hcp-bm-create-hc"]
== Creating a hosted cluster on bare metal

When you create a hosted cluster with the Agent platform, the HyperShift Operator installs the Agent Cluster API provider in the hosted control plane namespace. You can create a hosted cluster on bare metal or you can import one.

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]
* link:https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.13/html/clusters/cluster_mce_overview#configure-hosted-disconnected-digest-image[Extracting the {product-title} release image digest]

include::modules/hcp-bm-hc-console.adoc[leveloffset=+2]

.Next steps
* To access the web console, see xref:../../web_console/web-console.adoc#web-console-overview[Accessing the web console].
[role="_additional-resources"]
.Additional resources
* xref:../../web_console/web-console.adoc#web-console-overview[Accessing the web console]

include::modules/hcp-bm-hc-mirror.adoc[leveloffset=+2]

.Next steps
* 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.13/html/clusters/cluster_mce_overview#creating-a-credential-for-an-on-premises-environment[Creating a credential for an on-premises environment].
* 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].
* 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.13/html/clusters/cluster_mce_overview#add-host-host-inventory[Adding hosts to the host inventory by using the Discovery Image].
* To extract the {product-title} release image digest, see link:https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.13/html/clusters/cluster_mce_overview#configure-hosted-disconnected-digest-image[Extracting the {product-title} release image digest].
[role="_additional-resources"]
.Additional resources
* link:https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.13/html/clusters/cluster_mce_overview#creating-a-credential-for-an-on-premises-environment[Creating a credential for an on-premises environment]
* link:https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.13/html/clusters/cluster_mce_overview#add-host-host-inventory[Adding hosts to the host inventory by using the Discovery Image]

include::modules/hcp-bm-verify.adoc[leveloffset=+1]

include::modules/hcp-bm-access.adoc[leveloffset=+1]
include::modules/hcp-bm-scale-np.adoc[leveloffset=+1]
include::modules/hcp-bm-add-np.adoc[leveloffset=+2]
include::modules/hcp-bm-autoscale.adoc[leveloffset=+2]
include::modules/hcp-bm-autoscale-disable.adoc[leveloffset=+2]

[role="_additional-resources"]
.Additional resources
* xref:../../hosted_control_planes/hcp-troubleshooting.adoc#scale-down-data-plane_hcp-troubleshooting[Scaling down the data plane to zero]

include::modules/hcp-bm-ingress.adoc[leveloffset=+1]

[role="_additional-resources"]
.Additional resources
* xref:../../networking/networking_operators/metallb-operator/about-metallb.adoc#about-metallb_about-metallb[About MetalLB and the MetalLB Operator]
12 changes: 11 additions & 1 deletion hosted_control_planes/hcp-deploy/hcp-deploy-ibm-power.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,17 @@ include::modules/hcp-ibm-power-infra-reqs.adoc[leveloffset=+1]
include::modules/hcp-ibm-power-dns.adoc[leveloffset=+1]
include::modules/hcp-custom-dns.adoc[leveloffset=+2]

include::modules/hcp-bm-hc.adoc[leveloffset=+1]
[id="hcp-bm-create-hc-ibm-power"]
== Creating a hosted cluster on bare metal

When you create a hosted cluster with the Agent platform, the HyperShift Operator installs the Agent Cluster API provider in the hosted control plane namespace. You can create a hosted cluster on bare metal or you can import one.

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]
* link:https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.13/html/clusters/cluster_mce_overview#configure-hosted-disconnected-digest-image[Extracting the {product-title} release image digest]

[id="hcp-ibm-power-heterogeneous-nodepools_{context}"]
== Creating heterogeneous node pools on agent hosted clusters
Expand Down
10 changes: 8 additions & 2 deletions hosted_control_planes/hcp-deploy/hcp-deploy-ibmz.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -43,11 +43,17 @@ include::modules/hcp-ibm-z-infra-reqs.adoc[leveloffset=+1]
include::modules/hcp-ibm-z-dns.adoc[leveloffset=+1]
include::modules/hcp-custom-dns.adoc[leveloffset=+2]

include::modules/hcp-bm-hc.adoc[leveloffset=+1]
[id="hcp-bm-create-hc-ibm-z"]
== Creating a hosted cluster on bare metal

When you create a hosted cluster with the Agent platform, the HyperShift Operator installs the Agent Cluster API provider in the hosted control plane namespace. You can create a hosted cluster on bare metal or you can import one.

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]
* link:https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.13/html/clusters/cluster_mce_overview#configure-hosted-disconnected-digest-image[Extracting the {product-title} 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]

include::modules/hcp-ibm-z-infraenv.adoc[leveloffset=+1]
Expand Down
2 changes: 1 addition & 1 deletion hosted_control_planes/hcp-deploy/hcp-deploy-non-bm.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ include::modules/hcp-bm-hc-mirror.adoc[leveloffset=+2]

* 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.13/html/clusters/cluster_mce_overview#creating-a-credential-for-an-on-premises-environment[Creating a credential for an on-premises environment].

* 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].
* To access a hosted cluster, see xref:../../hosted_control_planes/hcp-deploy/hcp-deploy-bm.adoc#hcp-bm-access_hcp-deploy-bm[Accessing the hosted cluster].

* 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.13/html/clusters/cluster_mce_overview#add-host-host-inventory[Adding hosts to the host inventory by using the Discovery Image].

Expand Down
19 changes: 0 additions & 19 deletions hosted_control_planes/hcp-manage/hcp-manage-bm.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,28 +8,9 @@ toc::[]

After you deploy {hcp} on bare metal, you can manage a hosted cluster by completing the following tasks.

include::modules/hcp-bm-access.adoc[leveloffset=+1]
include::modules/hcp-bm-scale-np.adoc[leveloffset=+1]
include::modules/hcp-bm-add-np.adoc[leveloffset=+2]
include::modules/hcp-bm-autoscale.adoc[leveloffset=+2]
include::modules/hcp-bm-autoscale-disable.adoc[leveloffset=+2]

[role="_additional-resources"]
.Additional resources

* xref:../../hosted_control_planes/hcp-troubleshooting.adoc#scale-down-data-plane_hcp-troubleshooting[Scaling down the data plane to zero]

include::modules/hcp-bm-ingress.adoc[leveloffset=+1]

[role="_additional-resources"]
.Additional resources

* xref:../../networking/networking_operators/metallb-operator/about-metallb.adoc#about-metallb_about-metallb[About MetalLB and the MetalLB Operator]

include::modules/hcp-bm-machine-health.adoc[leveloffset=+1]
include::modules/hcp-bm-machine-health-disable.adoc[leveloffset=+1]

[role="_additional-resources"]
.Additional resources

* xref:../../machine_management/deploying-machine-health-checks.adoc#deploying-machine-health-checks[Deploying machine health checks]
2 changes: 1 addition & 1 deletion modules/hcp-bm-access.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// Module included in the following assemblies:
//
// * hosted_control_planes/hcp-manage/hcp-manage-bm.adoc
// * hosted_control_planes/hcp-deploy/hcp-deploy-bm.adoc
// * hosted_control_planes/hcp-manage/hcp-manage-non-bm.adoc

:_mod-docs-content-type: PROCEDURE
Expand Down
Loading