Skip to content

Commit 5075668

Browse files
authored
Merge pull request #46863 from apinnick/CNV17405-installation-requirements-reorg
CNV-17405: installation requirements reorganization
2 parents 3eed792 + dbed131 commit 5075668

File tree

5 files changed

+86
-78
lines changed

5 files changed

+86
-78
lines changed

_topic_maps/_topic_map.yml

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3071,18 +3071,12 @@ Topics:
30713071
- Name: Installing
30723072
Dir: install
30733073
Topics:
3074-
- Name: Preparing your OpenShift cluster for OpenShift Virtualization
3074+
- Name: Preparing your cluster for OpenShift Virtualization
30753075
File: preparing-cluster-for-virt
30763076
Distros: openshift-enterprise
30773077
- Name: Preparing your OKD cluster for OKD Virtualization
30783078
File: preparing-cluster-for-virt
30793079
Distros: openshift-origin
3080-
- Name: Planning your environment according to OpenShift Virtualization object maximums
3081-
File: virt-planning-environment-object-maximums
3082-
Distros: openshift-enterprise
3083-
- Name: Planning your environment according to OKD Virtualization object maximums
3084-
File: virt-planning-environment-object-maximums
3085-
Distros: openshift-origin
30863080
- Name: Specifying nodes for OpenShift Virtualization components
30873081
File: virt-specifying-nodes-for-virtualization-components
30883082
Distros: openshift-enterprise

modules/virt-cluster-resource-requirements.adoc

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
//
33
// * virt/install/preparing-cluster-for-virt.adoc
44

5+
:_content-type: REFERENCE
56
[id="virt-cluster-resource-requirements_{context}"]
6-
= Additional hardware requirements for {VirtProductName}
7-
7+
= Physical resource overhead requirements
88

99
{VirtProductName} is an add-on to {product-title} and imposes additional overhead that you must account for when planning a cluster. Each cluster machine must accommodate the following overhead requirements in addition to the {product-title} requirements. Oversubscribing the physical resources in a cluster can affect performance.
1010

@@ -30,7 +30,6 @@ Memory overhead per worker node ≈ 360 MiB
3030

3131
Additionally, {VirtProductName} environment resources require a total of 2179 MiB of RAM that is spread across all infrastructure nodes.
3232

33-
3433
.Virtual machine memory overhead
3534

3635
----
@@ -44,7 +43,6 @@ Memory overhead per virtual machine ≈ (1.002 * requested memory) + 146 MiB \
4443

4544
If your environment includes a Single Root I/O Virtualization (SR-IOV) network device or a Graphics Processing Unit (GPU), allocate 1 GiB additional memory overhead for each device.
4645

47-
4846
[id="CPU-overhead_{context}"]
4947
== CPU overhead
5048

@@ -64,12 +62,10 @@ CPU overhead for worker nodes ≈ 2 cores + CPU overhead per virtual machine
6462

6563
Each worker node that hosts virtual machines must have capacity for 2 additional cores (2000 millicores) for {VirtProductName} management workloads in addition to the CPUs required for virtual machine workloads.
6664

67-
6865
.Virtual machine CPU overhead
6966

7067
If dedicated CPUs are requested, there is a 1:1 impact on the cluster CPU overhead requirement. Otherwise, there are no specific rules about how many CPUs a virtual machine requires.
7168

72-
7369
[id="storage-overhead_{context}"]
7470
== Storage overhead
7571

@@ -87,7 +83,6 @@ Aggregated storage overhead per node ≈ 10 GiB
8783

8884
Storage overhead per virtual machine depends on specific requests for resource allocation within the virtual machine. The request could be for ephemeral storage on the node or storage resources hosted elsewhere in the cluster. {VirtProductName} does not currently allocate any additional ephemeral storage for the running container itself.
8985

90-
9186
[id="example-scenario_{context}"]
9287
== Example
9388

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * virt/install/preparing-cluster-for-virt.adoc
4+
5+
:_content-type: REFERENCE
6+
[id="virt-platform-node-storage-requirements_{context}"]
7+
= Platform, node, and storage requirements
8+
9+
You can install {VirtProductName} on a cluster that complies with the following platform, node, and storage requirements:
10+
11+
* Platforms:
12+
13+
** On-premise bare metal.
14+
** Amazon Web Services bare metal instance. Bare metal instances offered by other cloud providers are not supported.
15+
16+
ifdef::openshift-enterprise[]
17+
:FeatureName: Installing OpenShift Virtualization on an AWS bare metal instance
18+
include::snippets/technology-preview.adoc[]
19+
:!FeatureName:
20+
endif::[]
21+
22+
* Worker nodes: Red Hat Enterprise Linux CoreOS (RHCOS). RHEL worker nodes are not supported.
23+
24+
* CPUs:
25+
26+
** Supported by RHEL 8
27+
** Support for Intel 64 or AMD64 CPU extensions
28+
** Intel VT or AMD-V hardware virtualization extensions enabled
29+
** NX (no execute) flag enabled
30+
31+
* Storage supported by {product-title}.

virt/install/preparing-cluster-for-virt.adoc

Lines changed: 52 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,71 +1,84 @@
11
:_content-type: ASSEMBLY
22
include::_attributes/common-attributes.adoc[]
33
[id="preparing-cluster-for-virt"]
4-
= Configuring your cluster for {VirtProductName}
5-
:context: preparing-cluster-for-virt
4+
= Preparing your cluster for {VirtProductName}
5+
:context: virt-installation-requirements
66

77
toc::[]
88

9-
Before you install {VirtProductName}, ensure that your {product-title} cluster meets the following requirements:
9+
Review this section before you install {VirtProductName} to ensure that your cluster meets the requirements.
1010

11-
* Your cluster must be installed on
12-
xref:../../installing/installing_bare_metal/preparing-to-install-on-bare-metal.adoc#installing-bare-metal[on-premise bare metal] infrastructure with {op-system-first} workers. You can use any installation method including user-provisioned, installer-provisioned, or assisted installer to deploy your cluster.
13-
+
14-
[NOTE]
11+
[IMPORTANT]
1512
====
16-
{VirtProductName} only supports {op-system} worker nodes. RHEL 7 or RHEL 8 nodes are not supported.
13+
You can use any installation method, including user-provisioned, installer-provisioned, or assisted installer, to deploy {product-title}. However, the installation method and the cluster topology might affect {VirtProductName} functionality, such as snapshots or live migration.
1714
====
1815

19-
* You can install {VirtProductName} on Amazon Web Services (AWS) bare metal instances. Bare metal instances offered by other cloud providers are not supported.
20-
+
21-
--
22-
ifdef::openshift-enterprise[]
23-
:FeatureName: Installing OpenShift Virtualization on AWS bare metal instances
24-
include::snippets/technology-preview.adoc[leveloffset=+2]
25-
:!FeatureName:
26-
endif::[]
27-
--
16+
.Single Node OpenShift behavior
17+
18+
You can install {VirtProductName} on a single node cluster, also known as xref:../../installing/installing_sno/install-sno-preparing-to-install-sno.adoc#install-sno-about-installing-on-a-single-node_install-sno-preparing[Single Node OpenShift] (SNO). SNO does not support high availability, which results in the following differences:
2819

29-
* Shared storage is required to enable live migration.
20+
* xref:../../nodes/pods/nodes-pods-priority.adoc#priority-preemption-other_nodes-pods-priority[Pod disruption budgets] are not supported.
21+
* xref:../../virt/live_migration/virt-live-migration.adoc#virt-live-migration[Live migration] is not supported.
22+
* Templates or virtual machines that use data volumes or storage profiles must not have the xref:../../virt/live_migration/virt-configuring-vmi-eviction-strategy.adoc#virt-configuring-vmi-eviction-strategy[`evictionStrategy`] set.
3023
31-
* You must manage your Compute nodes according to the number and size of the virtual machines that you want to host in the cluster.
24+
.FIPS mode
3225

33-
* If you have limited internet connectivity, you can xref:../../operators/admin/olm-configuring-proxy-support.adoc#olm-configuring-proxy-support[configure proxy support in Operator Lifecycle Manager] to access the Red Hat-provided OperatorHub. If you are using a restricted network with no internet connectivity, you must xref:../../operators/admin/olm-restricted-networks.adoc#olm-restricted-networks[configure Operator Lifecycle Manager for restricted networks].
26+
If you install your cluster in xref:../../installing/installing-fips.adoc#installing-fips-mode_installing-fips[FIPS mode], no additional setup is required for {VirtProductName}.
3427

35-
* If your cluster uses worker nodes with different CPUs, live migration failures can occur because different CPUs have different capacities. To avoid such failures, use CPUs with appropriate capacity for each node and set node affinity on your virtual machines to ensure successful migration. See xref:../../nodes/scheduling/nodes-scheduler-node-affinity.adoc#nodes-scheduler-node-affinity-configuring-required_nodes-scheduler-node-affinity[Configuring a required node affinity rule] for more information.
28+
include::modules/virt-platform-node-storage-requirements.adoc[leveloffset=+1]
3629

37-
* All CPUs must be supported by Red Hat Enterprise Linux 8 and meet the following requirements:
30+
[role="_additional-resources"]
31+
.Additional resources
3832

39-
** Intel 64 or AMD64 CPU extensions are supported
40-
** Intel VT or AMD-V hardware virtualization extensions are enabled
41-
** The no-execute (NX) flag is enabled
33+
* xref:../../architecture/architecture-rhcos.adoc#rhcos-about_architecture-rhcos[About RHCOS]
34+
* link:https://catalog.redhat.com[Red Hat Ecosystem Catalog] for supported CPUs
35+
* xref:../../storage/index.adoc#storage-overview[Supported storage]
4236
43-
* If FIPS mode is xref:../../installing/installing-fips.adoc#installing-fips[enabled for your cluster], no additional setup is needed for {VirtProductName}. Support for FIPS cryptography must be enabled before the operating system that your cluster uses boots for the first time.
37+
include::modules/virt-cluster-resource-requirements.adoc[leveloffset=+1]
4438

45-
{VirtProductName} works with {product-title} by default, but the following installation configurations are recommended:
39+
[id="object-maximums_{context}"]
40+
== Object maximums
4641

47-
* Configure xref:../../monitoring/monitoring-overview.adoc#monitoring-overview[monitoring] in the cluster.
42+
You must consider the following tested object maximums when planning your cluster:
4843

49-
[NOTE]
50-
====
51-
To obtain an evaluation version of {product-title}, download a trial
52-
from the {product-title} home page.
53-
====
44+
* xref:../../scalability_and_performance/planning-your-environment-according-to-object-maximums.html#planning-your-environment-according-to-object-maximums[{product-title} object maximums]
45+
* link:https://access.redhat.com/articles/6571671[{VirtProductName} object maximums]
5446

55-
[id="virt-maintain-high-availability_preparing-cluster-for-virt"]
56-
== How to maintain high availability of virtual machines
47+
[id="restricted-networks-environments_{context}"]
48+
== Restricted network environments
5749

58-
There are three options to maintain high availability (HA) of virtual machines:
50+
If you install {VirtProductName} in a restricted environment with no internet connectivity, you must xref:../../operators/admin/olm-restricted-networks.adoc#olm-restricted-networks[configure Operator Lifecycle Manager for restricted networks].
51+
52+
If you have limited internet connectivity, you can xref:../../operators/admin/olm-configuring-proxy-support.adoc#olm-configuring-proxy-support[configure proxy support in Operator Lifecycle Manager] to access the Red Hat-provided OperatorHub.
53+
54+
[id="live-migration_{context}"]
55+
== Live migration
56+
57+
Live migration has the following requirements:
58+
59+
* Shared storage with `ReadWriteMany` (RWX) access mode
60+
* Sufficient RAM and network bandwidth
61+
* Appropriate CPUs with sufficent capacity on the worker nodes. If the CPUs have different capacities, live migration might be very slow or fail.
62+
63+
[id="snapshots-and-cloning_{context}"]
64+
== Snapshots and cloning
65+
66+
See xref:../../virt/virtual_machines/virtual_disks/virt-features-for-storage.adoc#virt-features-for-storage[{VirtProductName} storage features] for snapshot and cloning requirements.
67+
68+
// The HA section actually belongs to OpenShift, not Virt
69+
[id="cluster-high-availability-options_{context}"]
70+
== Cluster high-availability options
71+
72+
You can configure one of the following high-availability (HA) options for your cluster:
5973

6074
* Automatic high availability for xref:../../installing/installing_bare_metal_ipi/ipi-install-overview.adoc#ipi-install-overview[installer-provisioned infrastructure] (IPI) is available by deploying xref:../../machine_management/deploying-machine-health-checks.adoc#machine-health-checks-about_deploying-machine-health-checks[machine health checks].
6175
+
6276
[NOTE]
6377
====
64-
In {VirtProductName} clusters installed using installer-provisioned infrastructure and with MachineHealthCheck properly configured, if a node fails the MachineHealthCheck and becomes unavailable to the cluster, it is recycled. What happens next with VMs that ran on the failed node depends on a series of conditions. See xref:../../virt/virtual_machines/virt-create-vms.adoc#virt-about-runstrategies-vms_virt-create-vms[About RunStrategies for virtual machines] for more detailed information about the potential outcomes and how RunStrategies affect those outcomes.
78+
In {product-title} clusters installed using installer-provisioned infrastructure and with MachineHealthCheck properly configured, if a node fails the MachineHealthCheck and becomes unavailable to the cluster, it is recycled. What happens next with VMs that ran on the failed node depends on a series of conditions. See xref:../../virt/virtual_machines/virt-create-vms.adoc#virt-about-runstrategies-vms_virt-create-vms[About RunStrategies for virtual machines] for more detailed information about the potential outcomes and how RunStrategies affect those outcomes.
6579
====
6680

67-
68-
* Automatic high availability for both IPI and non-IPI is available by using the xref:../../nodes/nodes/eco-node-health-check-operator.adoc#node-health-check-operator[Node Health Check Operator] on any {product-title} cluster to deploy the `NodeHealthCheck` controller. The controller identifies unhealthy nodes and uses the Self Node Remediation Operator to remediate the unhealthy nodes.
81+
* Automatic high availability for both IPI and non-IPI is available by using the xref:../../nodes/nodes/eco-node-health-check-operator.adoc#node-health-check-operator[Node Health Check Operator] on the {product-title} cluster to deploy the `NodeHealthCheck` controller. The controller identifies unhealthy nodes and uses the Self Node Remediation Operator to remediate the unhealthy nodes.
6982
+
7083
--
7184
ifdef::openshift-enterprise[]
@@ -81,11 +94,3 @@ endif::[]
8194
====
8295
Without an external monitoring system or a qualified human monitoring node health, virtual machines lose high availability.
8396
====
84-
85-
include::modules/virt-single-node-cluster.adoc[leveloffset=+1]
86-
87-
[role="_additional-resources"]
88-
.Additional resources
89-
* xref:../../operators/operator_sdk/osdk-ha-sno.adoc#osdk-ha-sno[High-availability or single node cluster detection and support]
90-
91-
include::modules/virt-cluster-resource-requirements.adoc[leveloffset=+1]

virt/install/virt-planning-environment-object-maximums.adoc

Lines changed: 0 additions & 17 deletions
This file was deleted.

0 commit comments

Comments
 (0)