Skip to content

Commit 4c3eac2

Browse files
authored
Merge pull request #98323 from dfitzmau/OCPBUGS-58134
OCPBUGS-58134: Added datastore to table 2.4 in vSphere docs
2 parents 9d824f8 + 5683938 commit 4c3eac2

File tree

1 file changed

+44
-42
lines changed

1 file changed

+44
-42
lines changed

modules/installation-vsphere-installer-infra-requirements.adoc

Lines changed: 44 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ endif::[]
1616
= vCenter requirements
1717

1818
ifndef::upi[]
19-
Before you install an {product-title} cluster on your vCenter that uses infrastructure that the installer provisions, you must prepare your environment.
19+
Before you install an {product-title} cluster on your vCenter that uses infrastructure that the installation program provisions, you must prepare your environment.
2020
endif::upi[]
2121

2222
ifdef::upi[]
@@ -30,9 +30,9 @@ endif::upi[]
3030
ifndef::upi[]
3131
To install an {product-title} cluster in a vCenter, the installation program requires access to an account with privileges to read and create the required resources. Using an account that has global administrative privileges is the simplest way to access all of the necessary permissions.
3232

33-
If you cannot use an account with global administrative privileges, you must create roles to grant the privileges necessary for {product-title} cluster installation. While most of the privileges are always required, some are required only if you plan for the installation program to provision a folder to contain the {product-title} cluster on your vCenter instance, which is the default behavior. You must create or amend vSphere roles for the specified objects to grant the required privileges.
33+
If you cannot use an account with global administrative privileges, you must create roles to grant the privileges necessary for {product-title} cluster installation. Most of the privileges are always required. Some privileges are required only if you plan for the installation program to provision a folder to contain the {product-title} cluster on your vCenter instance, which is the default behavior. You must create or change vSphere roles for the specified objects to grant the required privileges.
3434

35-
An additional role is required if the installation program is to create a vSphere virtual machine folder.
35+
The installation program requires an additional role to create a vSphere virtual machine folder.
3636
endif::upi[]
3737

3838
ifdef::upi[]
@@ -66,7 +66,7 @@ endif::upi[]
6666
`StorageProfile.View`
6767
6868
|vSphere vCenter Cluster
69-
|If VMs will be created in the cluster root
69+
|If VMs need creation in the cluster root
7070
|
7171
[%hardbreaks]
7272
`Host.Config.Storage`
@@ -76,15 +76,15 @@ endif::upi[]
7676
`VirtualMachine.Config.AddNewDisk`
7777
7878
|vSphere vCenter Resource Pool
79-
|If an existing resource pool is provided
79+
|For a provided existing resource pool
8080
|
8181
[%hardbreaks]
8282
`Resource.AssignVMToPool`
8383
`VApp.AssignResourcePool`
8484
`VApp.Import`
8585
`VirtualMachine.Config.AddNewDisk`
8686
87-
|vSphere datastore
87+
|vSphere Datastore
8888
|Always
8989
|
9090
[%hardbreaks]
@@ -201,7 +201,7 @@ endif::upi[]
201201
`"Profile-driven storage"."Profile-driven storage view"`
202202
203203
|vSphere vCenter Cluster
204-
|If VMs will be created in the cluster root
204+
|For VMs creation in the cluster root
205205
|
206206
[%hardbreaks]
207207
`Host.Configuration."Storage partition configuration"`
@@ -211,7 +211,7 @@ endif::upi[]
211211
`"Virtual machine"."Change Configuration"."Add new disk"`
212212
213213
|vSphere vCenter Resource Pool
214-
|If an existing resource pool is provided
214+
|If providing an existing resource pool
215215
|
216216
[%hardbreaks]
217217
`Host.Configuration."Storage partition configuration"`
@@ -220,7 +220,7 @@ endif::upi[]
220220
`VApp.Import`
221221
`"Virtual machine"."Change Configuration"."Add new disk"`
222222
223-
|vSphere datastore
223+
|vSphere Datastore
224224
|Always
225225
|
226226
[%hardbreaks]
@@ -355,7 +355,7 @@ endif::ipi[]
355355
|True
356356
|Listed required privileges
357357
358-
|vSphere vCenter datastore
358+
|vSphere vCenter Datastore
359359
|Always
360360
|False
361361
|Listed required privileges
@@ -388,9 +388,9 @@ For more information about creating an account with only the required privileges
388388
[id="installation-vsphere-installer-infra-minimum-requirements_{context}"]
389389
== Minimum required vCenter account privileges
390390

391-
After you create a custom role and assign privileges to it, you can create permissions by selecting specific vSphere objects and then assigning the custom role to a user or group for each object.
391+
After you create a custom role and assign privileges to the role, you can create permissions by selecting specific vSphere objects. You can then assign the custom role to a user or group for each object.
392392

393-
Before you create permissions or request for the creation of permissions for a vSphere object, determine what minimum permissions apply to the vSphere object. By doing this task, you can ensure a basic interaction exists between a vSphere object and {product-title} architecture.
393+
Before you create permissions or request for the creation of permissions for a vSphere object, decide what minimum permissions apply to the vSphere object. By doing this task, you can ensure a basic interaction exists between a vSphere object and {product-title} architecture.
394394

395395
[IMPORTANT]
396396
====
@@ -401,7 +401,7 @@ Consider creating a custom role when an account with global administrative privi
401401

402402
[IMPORTANT]
403403
====
404-
Accounts that are not configured with the required privileges are unsupported. Installing an {product-title} cluster in a vCenter is tested against a full list of privileges as described in the "Required vCenter account privileges" section. By adhering to the full list of privileges, you can reduce the possibility of unexpected behaviors that might occur when creating a custom role with a restricted set of privileges.
404+
Red{nbsp}Hat does not support configuring an account without including the required privileges. Installing an {product-title} cluster in a vCenter is tested against a full list of privileges as described in the "Required vCenter account privileges" section. By adhering to the full list of privileges, you can reduce the possibility of unexpected behaviors that might occur when creating a custom role with a restricted set of privileges.
405405
====
406406

407407
The following tables specify how the required vCenter account privileges provided earlier in this document are relevant to different aspects of {product-title} architecture.
@@ -444,17 +444,23 @@ ifndef::upi[]
444444
`VirtualMachine.Config.AddNewDisk`
445445
446446
|vSphere vCenter Resource Pool
447-
|If you provide an existing resource pool in the `install-config.yaml` file
447+
|If you included an existing resource pool in the `install-config.yaml` file
448448
|
449449
[%hardbreaks]
450-
`Datastore.Browse`
451-
`Datastore.FileManagement`
450+
452451
`Host.Config.Storage`
453-
`InventoryService.Tagging.ObjectAttachable`
454452
`Resource.AssignVMToPool`
455453
`VApp.AssignResourcePool`
456454
`VApp.Import`minimum`
457455
456+
|vSphere Datastore
457+
|If you referenced a datastore in the `install-config.yaml` file
458+
|
459+
[%hardbreaks]
460+
461+
`Datastore.Browse`
462+
`Datastore.FileManagement`
463+
`InventoryService.Tagging.ObjectAttachable`
458464
459465
|vSphere Port Group
460466
|Always
@@ -536,7 +542,7 @@ ifndef::upi[]
536542
endif::upi[]
537543

538544
[id="post-installation-vsphere-minimum-permissions_{context}"]
539-
.Minimum permissions for post-installation management of components
545+
.Minimum permissions for postinstallation management of components
540546
[%collapsible]
541547
====
542548
[cols="4a,4a,3a",options="header"]
@@ -569,12 +575,12 @@ endif::upi[]
569575
`Resource.AssignVMToPool`
570576
571577
|vSphere vCenter Resource Pool
572-
|If you provide an existing resource pool in the `install-config.yaml` file
578+
|If you included an existing resource pool in the `install-config.yaml` file
573579
|
574580
[%hardbreaks]
575581
`Host.Config.Storage`
576582
577-
|vSphere datastore
583+
|vSphere Datastore
578584
|Always
579585
|
580586
[%hardbreaks]
@@ -655,12 +661,12 @@ endif::upi[]
655661
`Host.Config.Storage`
656662
657663
|vSphere vCenter Resource Pool
658-
|If you provide an existing resource pool in the `install-config.yaml` file
664+
|If you included an existing resource pool in the `install-config.yaml` file
659665
|
660666
[%hardbreaks]
661667
`Host.Config.Storage`
662668
663-
|vSphere datastore
669+
|vSphere Datastore
664670
|Always
665671
|
666672
[%hardbreaks]
@@ -727,12 +733,12 @@ endif::upi[]
727733
`Resource.AssignVMToPool`
728734
729735
|vSphere vCenter Resource Pool
730-
|If you provide an existing resource pool in the `install-config.yaml` file
736+
|If you included an existing resource pool in the `install-config.yaml` file
731737
|
732738
[%hardbreaks]
733739
`Read Only`
734740
735-
|vSphere datastore
741+
|vSphere Datastore
736742
|Always
737743
|
738744
[%hardbreaks]
@@ -785,21 +791,22 @@ endif::upi[]
785791

786792
If you intend on using vMotion in your vSphere environment, consider the following before installing an {product-title} cluster.
787793

788-
* {product-title} generally supports compute-only vMotion, where _generally_ implies that you meet all VMware best practices for vMotion.
794+
* Using Storage vMotion can cause issues and is not supported.
795+
* Using VMware compute vMotion to migrate the workloads for both {product-title} compute machines and control plane machines is generally supported, where _generally_ implies that you meet all VMware best practices for vMotion.
789796
+
790797
--
791798
To help ensure the uptime of your compute and control plane nodes, ensure that you follow the VMware best practices for vMotion, and use VMware anti-affinity rules to improve the availability of {product-title} during maintenance or hardware issues.
792799

793800
For more information about vMotion and anti-affinity rules, see the VMware vSphere documentation for link:https://docs.vmware.com/en/VMware-vSphere/7.0/com.vmware.vsphere.vcenterhost.doc/GUID-3B41119A-1276-404B-8BFB-A32409052449.html[vMotion networking requirements] and link:https://docs.vmware.com/en/VMware-vSphere/7.0/com.vmware.vsphere.resmgmt.doc/GUID-FBE46165-065C-48C2-B775-7ADA87FF9A20.html[VM anti-affinity rules].
794801
--
795-
* Using Storage vMotion can cause issues and is not supported. If you are using vSphere volumes in your pods, migrating a VM across datastores, either manually or through Storage vMotion, causes invalid references within {product-title} persistent volume (PV) objects that can result in data loss.
796-
* {product-title} does not support selective migration of VMDKs across datastores, using datastore clusters for VM provisioning or for dynamic or static provisioning of PVs, or using a datastore that is part of a datastore cluster for dynamic or static provisioning of PVs.
802+
* If you are using {vmw-full} volumes in your pods, migrating a VM across datastores, either manually or through Storage vMotion, causes invalid references within {product-title} persistent volume (PV) objects that can result in data loss.
803+
* {product-title} does not support selective migration of virtual machine disks (VMDKs) across datastores, using datastore clusters for VM provisioning or for dynamic or static provisioning of PVs, or using a datastore that is part of a datastore cluster for dynamic or static provisioning of PVs.
797804
+
798805
[IMPORTANT]
799806
====
800-
You can specify the path of any datastore that exists in a datastore cluster. By default, Storage Distributed Resource Scheduler (SDRS), which uses Storage vMotion, is automatically enabled for a datastore cluster. Red Hat does not support Storage vMotion, so you must disable Storage DRS to avoid data loss issues for your {product-title} cluster.
807+
You can specify the path of any datastore that exists in a datastore cluster. By default, Storage Distributed Resource Scheduler (SDRS), which uses Storage vMotion, is automatically enabled for a datastore cluster. Red Hat does not support Storage vMotion, so you must disable SDRS to avoid data loss issues for your {product-title} cluster.
801808
802-
If you must specify VMs across multiple datastores, use a `datastore` object to specify a failure domain in your cluster's `install-config.yaml` configuration file. For more information, see "VMware vSphere region and zone enablement".
809+
If you must specify VMs across many datastores, use a `datastore` object to specify a failure domain in your cluster's `install-config.yaml` configuration file. For more information, see "VMware vSphere region and zone enablement".
803810
====
804811

805812
[discrete]
@@ -825,15 +832,15 @@ endif::upi[]
825832
** 3 control plane nodes
826833
** 3 compute machines
827834

828-
Although these resources use 856 GB of storage, the bootstrap node is destroyed during the cluster installation process. A minimum of 800 GB of storage is required to use a standard cluster.
835+
Although these resources use 856 GB of storage, the bootstrap node gets deleted during the cluster installation process. At a minimum , a standard cluster requires 800 GB of storage.
829836

830837
If you deploy more compute machines, the {product-title} cluster will use more storage.
831838

832839
[discrete]
833840
[id="installation-vsphere-installer-infra-requirements-limits_{context}"]
834841
== Cluster limits
835842

836-
Available resources vary between clusters. The number of possible clusters within a vCenter is limited primarily by available storage space and any limitations on the number of required resources. Be sure to consider both limitations to the vCenter resources that the cluster creates and the resources that you require to deploy a cluster, such as IP addresses and networks.
843+
Available resources vary between clusters. A limit exists for the number of possible clusters within vCenter, primarily by available storage space and any limitations on the number of required resources. Be sure to consider both limitations to the vCenter resources that the cluster creates and the resources that you require to deploy a cluster, such as IP addresses and networks.
837844

838845
[discrete]
839846
[id="installation-vsphere-installer-infra-requirements-networking_{context}"]
@@ -862,13 +869,13 @@ Additionally, you must create the following networking resources before you inst
862869
ifndef::upi[]
863870
[discrete]
864871
[id="installation-vsphere-installer-infra-requirements-_{context}"]
865-
=== Required IP Addresses
872+
=== Required IP addresses
866873
For a network that uses DHCP, an installer-provisioned vSphere installation requires two static IP addresses:
867874

868-
* The **API** address is used to access the cluster API.
869-
* The **Ingress** address is used for cluster ingress traffic.
875+
* The **API** address for accessing the cluster API.
876+
* The **Ingress** address for cluster ingress traffic.
870877

871-
You must provide these IP addresses to the installation program when you install the {product-title} cluster.
878+
You must give these IP addresses to the installation program when you install the {product-title} cluster.
872879
endif::upi[]
873880

874881
[discrete]
@@ -886,16 +893,11 @@ You must create DNS records for two static IP addresses in the appropriate DNS s
886893

887894
|API VIP
888895
|`api.<cluster_name>.<base_domain>.`
889-
|This DNS A/AAAA or CNAME (Canonical Name) record must point to the load balancer
890-
for the control plane machines. This record must be resolvable by both clients
891-
external to the cluster and from all the nodes within the cluster.
896+
|This DNS A/AAAA or CNAME (Canonical Name) record must point to the load balancer for the control plane machines. This record must be resolvable by both clients external to the cluster and from all the nodes within the cluster.
892897

893898
|Ingress VIP
894899
|`*.apps.<cluster_name>.<base_domain>.`
895-
|A wildcard DNS A/AAAA or CNAME record that points to the load balancer that targets the
896-
machines that run the Ingress router pods, which are the worker nodes by
897-
default. This record must be resolvable by both clients external to the cluster
898-
and from all the nodes within the cluster.
900+
|A wildcard DNS A/AAAA or CNAME record that points to the load balancer that targets the machines that run the Ingress router pods, which are the worker nodes by default. This record must be resolvable by both clients external to the cluster and from all the nodes within the cluster.
899901
|===
900902

901903
ifeval::["{context}" == "ipi-vsphere-installation-reqs"]

0 commit comments

Comments
 (0)