Skip to content

Commit c81c7fb

Browse files
committed
DOCPLAN-211: vale and CQA updates
1 parent 42ec48d commit c81c7fb

File tree

1 file changed

+34
-44
lines changed

1 file changed

+34
-44
lines changed

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

Lines changed: 34 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,14 @@ include::_attributes/common-attributes.adoc[]
33
[id="preparing-cluster-for-virt"]
44
= Preparing your cluster for {VirtProductName}
55
:context: preparing-cluster-for-virt
6-
:toclevels: 3
76

87
toc::[]
98

9+
[role="_abstract"]
1010
Before you install {VirtProductName}, review this section to ensure that your cluster meets the requirements.
1111

12+
* You must consider the following tested object maximums when planning your cluster.
13+
1214
// Hiding compatible platforms list in ROSA/OSD
1315
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
1416

@@ -17,8 +19,7 @@ ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
1719

1820
You can use the following platforms with {VirtProductName}:
1921

20-
* On-premise bare metal servers. See xref:../../installing/installing_bare_metal/preparing-to-install-on-bare-metal.adoc#virt-planning-bare-metal-cluster-for-ocp-virt_preparing-to-install-on-bare-metal[Planning a bare metal cluster for {VirtProductName}].
21-
22+
* On-premise bare metal servers.
2223
* Bare metal clusters installed on ARM64-based (`arm64`, also known as `aarch64`) systems.
2324

2425
//* {ibm-cloud-name} Bare Metal Servers. See link:https://access.redhat.com/articles/6738731[Deploy {VirtProductName} on {ibm-cloud-name} Bare Metal nodes].
@@ -31,7 +32,7 @@ You can use the following platforms with {VirtProductName}:
3132
//endif::[]
3233
//--
3334
34-
* {ibm-z-name} or {ibm-linuxone-name} (s390x architecture) systems where an {product-title} cluster is installed in logical partitions (LPARs). See xref:../../installing/installing_ibm_z/preparing-to-install-on-ibm-z.adoc#preparing-to-install-on-ibm-z_preparing-to-install-on-ibm-z[Preparing to install on {ibm-z-title} and {ibm-linuxone-title}].
35+
* {ibm-z-name} or {ibm-linuxone-name} (s390x architecture) systems where an {product-title} cluster is installed in logical partitions (LPARs).
3536
3637
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
3738
@@ -55,35 +56,26 @@ endif::[]
5556
| Vendor
5657
| Status
5758
| Storage
58-
| Related links
5959
6060
| {aws-first}
6161
| GA
6262
| Elastic Block Store (EBS), {odf-first}, Portworx, FSx (NetApp)
63-
| * xref:../../installing/installing_aws/ipi/installing-aws-customizations.adoc#installing-aws-customizations[Installing a cluster on AWS with customizations]
6463
6564
| {product-rosa} (ROSA)
6665
| GA
6766
| EBS, Portworx, FSx (Q3), {odf-short}
68-
| * link:https://docs.redhat.com/en/documentation/red_hat_openshift_service_on_aws/4/html/virtualization/index[{VirtProductName}] in the {product-rosa} documentation
69-
* link:https://docs.aws.amazon.com/rosa/latest/userguide/what-is-rosa.html[What is {product-rosa}?] in the {aws-short} documentation
7067
7168
| {oci-first-no-rt}
7269
| GA
7370
| {oci} native storage
74-
| * link:https://access.redhat.com/articles/7118050[{VirtProductName} and Oracle Cloud Infrastructure known issues and limitations] in the Red{nbsp}Hat Knowledgebase
75-
* link:https://github.com/oracle-quickstart/oci-openshift/blob/main/docs/openshift-virtualization.md[Installing {VirtProductName} on OCI] in the `oracle-quickstart/oci-openshift` GitHub repository
7671
7772
| Azure Red{nbsp}Hat OpenShift (ARO)
7873
| GA
7974
| {odf-short}
80-
| * link:https://learn.microsoft.com/en-us/azure/openshift/howto-create-openshift-virtualization[{VirtProductName} for Azure Red Hat OpenShift (preview)] in the Microsoft documentation
8175
8276
| {gcp-first}
8377
| GA, as of {VirtProductName} 4.21.1
8478
| {gcp-short} native storage
85-
| * link:https://access.redhat.com/articles/7139046[Storage configuration for {VirtProductName} {product-version}.x on {gcp-full}] in the Red{nbsp}Hat Knowledgebase
86-
* link:https://access.redhat.com/articles/7139682[{VirtProductName} on {gcp-full}: Known issues and limitations] in the Red{nbsp}Hat Knowledgebase
8779
8880
// tracker: https://issues.redhat.com/browse/XCMSTRAT-1191
8981
// | {product-dedicated}
@@ -97,11 +89,6 @@ endif::[]
9789
// |
9890
|===
9991
100-
[TIP]
101-
====
102-
For platform-specific networking information, see the xref:../../virt/vm_networking/virt-networking-overview.adoc#virt-networking[networking overview].
103-
====
104-
10592
endif::[]
10693
10794
// Hiding in ROSA/OSD, as bare metal not supported
@@ -111,14 +98,6 @@ endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
11198
11299
include::modules/virt-aws-bm.adoc[leveloffset=+2]
113100
114-
115-
[role="_additional-resources"]
116-
.Additional resources
117-
ifndef::openshift-dedicated[]
118-
* xref:../../virt/vm_networking/virt-connecting-vm-to-ovn-secondary-network.adoc#virt-connecting-vm-to-ovn-secondary-network[Connecting a virtual machine to an OVN-Kubernetes secondary network]
119-
endif::openshift-dedicated[]
120-
* xref:../../virt/vm_networking/virt-exposing-vm-with-service.adoc#virt-exposing-vm-with-service[Exposing a virtual machine by using a service]
121-
122101
//Hiding in OSD as not supported
123102
ifndef::openshift-dedicated[]
124103
[id="arm-compatibility_{context}"]
@@ -130,7 +109,7 @@ Before using {VirtProductName} on an ARM64-based system, consider the following
130109
131110
Operating system::
132111
* Only Linux-based guest operating systems are supported.
133-
* All virtualization limitations for {op-system-base} also apply to {VirtProductName}. For more information, see link:https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html/configuring_and_managing_virtualization/assembly_feature-support-and-limitations-in-rhel-9-virtualization_configuring-and-managing-virtualization#how-virtualization-on-arm-64-differs-from-amd64-and-intel64_feature-support-and-limitations-in-rhel-9-virtualization[How virtualization on ARM64 differs from AMD64 and Intel 64] in the {op-system-base} documentation.
112+
* All virtualization limitations for {op-system-base} also apply to {VirtProductName}.
134113
135114
Live migration::
136115
* Live migration is *not supported* on ARM64-based {product-title} clusters.
@@ -176,8 +155,6 @@ The following features are not applicable on `s390x` architecture:
176155
* Creating and managing Windows VMs
177156
* Hyper-V
178157
179-
180-
[discrete]
181158
[id="functionality-differences_{context}"]
182159
==== Functionality differences
183160
@@ -324,27 +301,15 @@ ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
324301
include::modules/virt-sno-differences.adoc[leveloffset=+1]
325302
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
326303
327-
[role="_additional-resources"]
328-
.Additional resources
329-
330-
* xref:../../storage/index.adoc#openshift-storage-common-terms_storage-overview[Glossary of common terms for {product-title} storage]
331-
332304
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
333-
[id="object-maximums_preparing-cluster-for-virt"]
334-
== Object maximums
335-
336-
You must consider the following tested object maximums when planning your cluster:
337-
338-
* xref:../../scalability_and_performance/planning-your-environment-according-to-object-maximums.adoc#planning-your-environment-according-to-object-maximums[{product-title} object maximums]
339-
* xref:../../virt/about_virt/virt-supported-limits.adoc#virt-supported-limits[{VirtProductName} supported limits]
340305
341306
// The HA section actually belongs to OpenShift, not Virt
342307
[id="cluster-high-availability-options_preparing-cluster-for-virt"]
343308
== Cluster high-availability options
344309
345310
You can configure one of the following high-availability (HA) options for your cluster:
346311
347-
* 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].
312+
* Automatic high availability for installer-provisioned infrastructure (IPI) is available by deploying machine health checks.
348313
+
349314
[NOTE]
350315
====
@@ -353,11 +318,11 @@ In {product-title} clusters installed using installer-provisioned infrastructure
353318
Currently, IPI is not supported on {ibm-z-name}.
354319
====
355320
356-
* Automatic high availability for both IPI and non-IPI is available by using the *Node Health Check Operator* on the {product-title} cluster to deploy the `NodeHealthCheck` controller. The controller identifies unhealthy nodes and uses a remediation provider, such as the Self Node Remediation Operator or Fence Agents Remediation Operator, to remediate the unhealthy nodes. For more information on remediation, fencing, and maintaining nodes, see the link:https://access.redhat.com/documentation/en-us/workload_availability_for_red_hat_openshift[Workload Availability for Red Hat OpenShift] documentation.
321+
* Automatic high availability for both IPI and non-IPI is available by using the *Node Health Check Operator* on the {product-title} cluster to deploy the `NodeHealthCheck` controller. The controller identifies unhealthy nodes and uses a remediation provider, such as the Self Node Remediation Operator or Fence Agents Remediation Operator, to remediate the unhealthy nodes.
357322
+
358323
[NOTE]
359324
====
360-
Fence Agents Remediation uses supported fencing agents to reset failed nodes faster than the Self Node Remediation Operator. This improves overall virtual machine high availability. For more information, see the link:https://access.redhat.com/articles/7057929[OpenShift Virtualization - Fencing and VM High Availability Guide] knowledgebase article.
325+
Fence Agents Remediation uses supported fencing agents to reset failed nodes faster than the Self Node Remediation Operator. This improves overall virtual machine high availability.
361326
====
362327
363328
* High availability for any platform is available by using either a monitoring system or a qualified human to monitor node availability. When a node is lost, shut it down and run `oc delete node <lost_node>`.
@@ -371,4 +336,29 @@ endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
371336
[role="_additional-resources"]
372337
[id="additional-resources_preparing-cluster-for-virt"]
373338
== Additional resources
339+
* xref:../../installing/installing_bare_metal/preparing-to-install-on-bare-metal.adoc#virt-planning-bare-metal-cluster-for-ocp-virt_preparing-to-install-on-bare-metal[Preparing for bare metal cluster installation]
340+
* xref:../../installing/installing_ibm_z/preparing-to-install-on-ibm-z.adoc#preparing-to-install-on-ibm-z_preparing-to-install-on-ibm-z[Preparing to install on {ibm-z-title} and {ibm-linuxone-title}]
341+
* xref:../../installing/installing_aws/ipi/installing-aws-customizations.adoc#installing-aws-customizations[Installing a cluster on AWS with customizations]
342+
* link:https://docs.redhat.com/en/documentation/red_hat_openshift_service_on_aws/4/html/virtualization/index[{VirtProductName}]
343+
* link:https://docs.aws.amazon.com/rosa/latest/userguide/what-is-rosa.html[What is {product-rosa}?]
344+
* link:https://access.redhat.com/articles/7118050[{VirtProductName} and Oracle Cloud Infrastructure known issues and limitations]
345+
* link:https://github.com/oracle-quickstart/oci-openshift/blob/main/docs/openshift-virtualization.md[Installing {VirtProductName} on OCI]
346+
* link:https://learn.microsoft.com/en-us/azure/openshift/howto-create-openshift-virtualization[{VirtProductName} for Azure Red Hat OpenShift (preview)]
347+
* link:https://access.redhat.com/articles/7139046[Storage configuration for {VirtProductName} {product-version}.x on {gcp-full}]
348+
* link:https://access.redhat.com/articles/7139682[{VirtProductName} on {gcp-full}: Known issues and limitations]
349+
* xref:../../virt/vm_networking/virt-networking-overview.adoc#virt-networking[networking overview]
350+
ifndef::openshift-dedicated[]
351+
* xref:../../virt/vm_networking/virt-connecting-vm-to-ovn-secondary-network.adoc#virt-connecting-vm-to-ovn-secondary-network[Connecting a virtual machine to an OVN-Kubernetes secondary network]
352+
endif::openshift-dedicated[]
353+
* xref:../../virt/vm_networking/virt-exposing-vm-with-service.adoc#virt-exposing-vm-with-service[Exposing a virtual machine by using a service]
354+
* link:https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html/configuring_and_managing_virtualization/assembly_feature-support-and-limitations-in-rhel-9-virtualization_configuring-and-managing-virtualization#how-virtualization-on-arm-64-differs-from-amd64-and-intel64_feature-support-and-limitations-in-rhel-9-virtualization[How virtualization on ARM64 differs from AMD64 and Intel 64]
374355
* xref:../../virt/nodes/virt-eviction-strategies.adoc#virt-runstrategies-vms_virt-eviction-strategies[Run strategies]
356+
357+
358+
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
359+
* xref:../../scalability_and_performance/planning-your-environment-according-to-object-maximums.adoc#planning-your-environment-according-to-object-maximums[{product-title} object maximums]
360+
* xref:../../virt/about_virt/virt-supported-limits.adoc#virt-supported-limits[{VirtProductName} supported limits]
361+
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
362+
* xref:../../storage/index.adoc#openshift-storage-common-terms_storage-overview[Glossary of common terms for {product-title} storage]
363+
* link:https://access.redhat.com/documentation/en-us/workload_availability_for_red_hat_openshift[Workload Availability for Red Hat OpenShift]
364+
* link:https://access.redhat.com/articles/7057929[OpenShift Virtualization - Fencing and VM High Availability Guide]

0 commit comments

Comments
 (0)