openshift-docs/hosted_control_planes/hcp-deploy/hcp-deploy-virt.adoc

:_mod-docs-content-type: ASSEMBLY
[id="hcp-deploy-virt"]
include::_attributes/common-attributes.adoc[]
= Deploying {hcp} on {VirtProductName}
:context: hcp-deploy-virt

toc::[]

With {hcp} and {VirtProductName}, you can create {product-title} clusters with worker nodes that are hosted by KubeVirt virtual machines. {hcp-capital} on {VirtProductName} provides several benefits:

* Enhances resource usage by packing {hcp} and hosted clusters in the same underlying bare-metal infrastructure
* Separates {hcp} and hosted clusters to provide strong isolation
* Reduces cluster provision time by eliminating the bare-metal node bootstrapping process
* Manages many releases under the same base {product-title} cluster

The {hcp} feature is enabled by default.

You can use the hosted control plane command-line interface, `hcp`, to create an {product-title} 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 multicluster engine Operator".

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

* xref:../../hosted_control_planes/hcp-import.adoc#hcp-import-disable_hcp-import[Disabling the automatic import of hosted clusters into {mce-short}]
* xref:../../hosted_control_planes/hcp-prepare/hcp-enable-disable.adoc[Enabling or disabling the {hcp} feature]
* link:https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.14/html/clusters/cluster_mce_overview#ansible-config-hosted-cluster[Configuring Ansible Automation Platform jobs to run on hosted clusters]

include::modules/hcp-virt-reqs.adoc[leveloffset=+1]

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

* xref:../../etcd/etcd-practices.adoc#recommended-etcd-practices[Recommended etcd practices]
* xref:../../storage/persistent_storage_local/persistent-storage-using-lvms.adoc#persistent-storage-using-lvms[Persistent storage using Logical Volume Manager Storage]

include::modules/hcp-virt-prereqs.adoc[leveloffset=+2]

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

* xref:../../virt/install/installing-virt.adoc#installing-virt-web[Installing OpenShift Virtualization using the web console]
* xref:../../post_installation_configuration/post-install-storage-configuration.adoc#post-install-storage-configuration[Postinstallation storage configuration]
* link:https://console.redhat.com/openshift/install/platform-agnostic/user-provisioned[Install OpenShift on any x86_64 platform with user-provisioned infrastructure]
* xref:../../hosted_control_planes/hcp-deploy/hcp-deploy-virt.adoc#hcp-metallb_hcp-deploy-virt[Configuring MetalLB]
* link:https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.14/html/clusters/cluster_mce_overview#advanced-config-engine[Advanced configuration]

include::modules/hcp-virt-firewall-port.adoc[leveloffset=+2]

include::modules/hcp-virt-live-migration.adoc[leveloffset=+1]

[id="hcp-virt-create-hc"]
== Creating a hosted cluster with the KubeVirt platform

With {product-title} 4.14 and later, you can create a cluster with KubeVirt, to include creating with an external infrastructure.

include::modules/hcp-virt-create-hc-cli.adoc[leveloffset=+2]

include::modules/hcp-virt-create-hc-ext-infra.adoc[leveloffset=+2]

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

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

* link:https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.14/html/clusters/cluster_mce_overview#creating-a-credential-for-an-on-premises-environment[Creating a credential for an on-premises environment]

* xref:../../hosted_control_planes/hcp-manage/hcp-manage-virt.adoc#hcp-virt-access_hcp-manage-virt[Accessing the hosted cluster]

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

include::modules/hcp-custom-dns.adoc[leveloffset=+2]

[id="hcp-virt-ingress-dns-custom"]
== Customizing ingress and DNS behavior

If you do not want to use the default ingress and DNS behavior, you can configure a KubeVirt hosted cluster with a unique base domain at creation time. This option requires manual configuration steps during creation and involves three main steps: cluster creation, load balancer creation, and wildcard DNS configuration.

include::modules/hcp-virt-hc-base-domain.adoc[leveloffset=+2]

include::modules/hcp-virt-load-balancer.adoc[leveloffset=+2]

include::modules/hcp-virt-wildcard-dns.adoc[leveloffset=+2]

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

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

* xref:../../networking/networking_operators/metallb-operator/metallb-operator-install.adoc#metallb-operator-install_metallb-operator-install[Installing the MetalLB Operator]

[id="hcp-virt-addl-resources"]
== Configuring additional networks, guaranteed CPUs, and VM scheduling for node pools

If you need to configure additional networks for node pools, request a guaranteed CPU access for Virtual Machines (VMs), or manage scheduling of KubeVirt VMs, see the following procedures.

include::modules/hcp-virt-add-networks.adoc[leveloffset=+2]

include::modules/hcp-virt-addl-network.adoc[leveloffset=+3]

include::modules/hcp-virt-guaranteed-cpus.adoc[leveloffset=+2]

include::modules/hcp-virt-sched-vms.adoc[leveloffset=+2]

include::modules/hcp-virt-scale-nodepool.adoc[leveloffset=+1]

include::modules/hcp-virt-add-node.adoc[leveloffset=+2]

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

* link:https://access.redhat.com/documentation/en-us/openshift_container_platform/4.15/html/hosted_control_planes/troubleshooting-hosted-control-planes#scale-down-data-plane_hcp-troubleshooting[Scaling down the data plane to zero]

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

include::modules/hcp-custom-cert.adoc[leveloffset=+1]