Skip to content

Commit b6e5639

Browse files
committed
ODOCS-5864: Refined datastore cluster capability in vSphere docs
1 parent 643d46a commit b6e5639

4 files changed

+80
-50
lines changed

modules/installation-initializing.adoc

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -326,6 +326,13 @@ After you create the installation configuration file, you can modify the file to
326326
====
327327

328328
... Select the default vCenter datastore to use.
329+
+
330+
[WARNING]
331+
====
332+
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.
333+
334+
You cannot specify more than one datastore path. 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".
335+
====
329336
... Select the vCenter cluster to install the {product-title} cluster in. The installation program uses the root resource pool of the vSphere cluster as the default resource pool.
330337
... Select the network in the vCenter instance that contains the virtual IP addresses and DNS records that you configured.
331338
... Enter the virtual IP address that you configured for control plane API access.

modules/installation-installer-provisioned-vsphere-config-yaml.adoc

Lines changed: 24 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ networking:
4444
hostPrefix: 23
4545
machineNetwork:
4646
- cidr: 10.0.0.0/16
47-
networkType: OVNKubernetes <9>
47+
networkType: OVNKubernetes <10>
4848
serviceNetwork:
4949
- 172.30.0.0/16
5050
endif::network[]
@@ -59,10 +59,10 @@ platform:
5959
topology:
6060
computeCluster: "/<datacenter>/host/<cluster>"
6161
datacenter: <datacenter>
62-
datastore: "/<datacenter>/datastore/<datastore>"
62+
datastore: "/<datacenter>/datastore/<datastore>" <7>
6363
networks:
6464
- <VM_Network_name>
65-
resourcePool: "/<datacenter>/host/<cluster>/Resources/<resourcePool>" <7>
65+
resourcePool: "/<datacenter>/host/<cluster>/Resources/<resourcePool>" <8>
6666
folder: "/<datacenter_name>/vm/<folder_name>/<subfolder_name>"
6767
zone: <default_zone_name>
6868
ingressVIPs:
@@ -74,9 +74,9 @@ platform:
7474
port: 443
7575
server: <fully_qualified_domain_name>
7676
77-
diskType: thin <8>
77+
diskType: thin <9>
7878
ifdef::restricted[]
79-
clusterOSImage: http://mirror.example.com/images/rhcos-47.83.202103221318-0-vmware.x86_64.ova <9>
79+
clusterOSImage: http://mirror.example.com/images/rhcos-47.83.202103221318-0-vmware.x86_64.ova <10>
8080
endif::restricted[]
8181
ifndef::openshift-origin[]
8282
fips: false
@@ -85,15 +85,15 @@ ifndef::restricted[]
8585
pullSecret: '{"auths": ...}'
8686
endif::restricted[]
8787
ifdef::restricted[]
88-
pullSecret: '{"auths":{"<local_registry>": {"auth": "<credentials>","email": "[email protected]"}}}' <10>
88+
pullSecret: '{"auths":{"<local_registry>": {"auth": "<credentials>","email": "[email protected]"}}}' <11>
8989
endif::restricted[]
9090
sshKey: 'ssh-ed25519 AAAA...'
9191
ifdef::restricted[]
92-
additionalTrustBundle: | <11>
92+
additionalTrustBundle: | <12>
9393
-----BEGIN CERTIFICATE-----
9494
ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
9595
-----END CERTIFICATE-----
96-
imageContentSources: <12>
96+
imageContentSources: <13>
9797
- mirrors:
9898
- <local_registry>/<local_repository_name>/release
9999
source: quay.io/openshift-release-dev/ocp-release
@@ -112,21 +112,29 @@ to increase the performance of your machines' cores. You can disable it by setti
112112
If you disable simultaneous multithreading, ensure that your capacity planning accounts for the dramatically decreased machine performance. Your machines must use at least 8 CPUs and 32 GB of RAM if you disable simultaneous multithreading.
113113
====
114114
<4> The cluster name that you specified in your DNS records.
115-
<5> Optional parameter for providing additional configuration for the machine pool parameters for the compute and control plane machines.
115+
<5> Optional: Provides additional configuration for the machine pool parameters for the compute and control plane machines.
116116
<6> Establishes the relationships between a region and zone. You define a failure domain by using vCenter objects, such as a `datastore` object. A failure domain defines the vCenter location for {product-title} cluster nodes.
117-
<7> Optional parameter for providing an existing resource pool for machine creation. If you do not specify a value, the installation program uses the root resource pool of the vSphere cluster.
118-
<8> The vSphere disk provisioning method.
117+
<7> The path to the vSphere datastore that holds virtual machine files, templates, and ISO images.
118+
+
119+
[IMPORTANT]
120+
====
121+
You can specify the path of any datastore that exists in a datastore cluster. By default, Storage vMotion is automatically enabled for a datastore cluster. Red Hat does not support Storage vMotion, so you must disable Storage vMotion to avoid data loss issues for your {product-title} cluster.
122+
123+
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".
124+
====
125+
<8> Optional: Provides an existing resource pool for machine creation. If you do not specify a value, the installation program uses the root resource pool of the vSphere cluster.
126+
<9> The vSphere disk provisioning method.
119127
ifdef::network[]
120-
<9> The cluster network plugin to install. The supported values are `OVNKubernetes` and `OpenShiftSDN`. The default value is `OVNKubernetes`.
128+
<10> The cluster network plugin to install. The supported values are `OVNKubernetes` and `OpenShiftSDN`. The default value is `OVNKubernetes`.
121129
endif::network[]
122130
ifdef::restricted[]
123-
<9> The location of the {op-system-first} image that is accessible from the bastion server.
124-
<10> For `<local_registry>`, specify the registry domain name, and optionally the
131+
<10> The location of the {op-system-first} image that is accessible from the bastion server.
132+
<11> For `<local_registry>`, specify the registry domain name, and optionally the
125133
port, that your mirror registry uses to serve content. For example
126134
`registry.example.com` or `registry.example.com:5000`. For `<credentials>`,
127135
specify the base64-encoded user name and password for your mirror registry.
128-
<11> Provide the contents of the certificate file that you used for your mirror registry.
129-
<12> Provide the `imageContentSources` section from the output of the command to mirror the repository.
136+
<12> Provide the contents of the certificate file that you used for your mirror registry.
137+
<13> Provide the `imageContentSources` section from the output of the command to mirror the repository.
130138
endif::restricted[]
131139

132140
[NOTE]

modules/installation-vsphere-config-yaml.adoc

Lines changed: 42 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -51,11 +51,11 @@ platform:
5151
topology:
5252
computeCluster: "/<datacenter>/host/<cluster>"
5353
datacenter: <datacenter> <8>
54-
datastore: "/<datacenter>/datastore/<datastore>"
54+
datastore: "/<datacenter>/datastore/<datastore>" <9>
5555
networks:
5656
- <VM_Network_name>
57-
resourcePool: "/<datacenter>/host/<cluster>/Resources/<resourcePool>" <9>
58-
folder: "/<datacenter_name>/vm/<folder_name>/<subfolder_name>" <10>
57+
resourcePool: "/<datacenter>/host/<cluster>/Resources/<resourcePool>" <10>
58+
folder: "/<datacenter_name>/vm/<folder_name>/<subfolder_name>" <11>
5959
zone: <default_zone_name>
6060
ingressVIPs:
6161
- 10.0.0.2
@@ -64,42 +64,42 @@ platform:
6464
- <datacenter>
6565
password: <password> <12>
6666
port: 443
67-
server: <fully_qualified_domain_name> <11>
67+
server: <fully_qualified_domain_name> <13>
6868
69-
diskType: thin <13>
69+
diskType: thin <14>
7070
ifndef::restricted[]
7171
ifndef::openshift-origin[]
72-
fips: false <14>
72+
fips: false <15>
7373
endif::openshift-origin[]
7474
ifndef::openshift-origin[]
75-
pullSecret: '{"auths": ...}' <15>
75+
pullSecret: '{"auths": ...}' <16>
7676
endif::openshift-origin[]
7777
ifdef::openshift-origin[]
78-
pullSecret: '{"auths": ...}' <14>
78+
pullSecret: '{"auths": ...}' <15>
7979
endif::openshift-origin[]
8080
endif::restricted[]
8181
ifdef::restricted[]
8282
ifndef::openshift-origin[]
83-
fips: false <14>
84-
pullSecret: '{"auths":{"<local_registry>": {"auth": "<credentials>","email": "[email protected]"}}}' <15>
83+
fips: false <15>
84+
pullSecret: '{"auths":{"<local_registry>": {"auth": "<credentials>","email": "[email protected]"}}}' <16>
8585
endif::openshift-origin[]
8686
ifdef::openshift-origin[]
87-
pullSecret: '{"auths":{"<local_registry>": {"auth": "<credentials>","email": "[email protected]"}}}' <14>
87+
pullSecret: '{"auths":{"<local_registry>": {"auth": "<credentials>","email": "[email protected]"}}}' <15>
8888
endif::openshift-origin[]
8989
endif::restricted[]
9090
ifndef::openshift-origin[]
91-
sshKey: 'ssh-ed25519 AAAA...' <16>
91+
sshKey: 'ssh-ed25519 AAAA...' <17>
9292
endif::openshift-origin[]
9393
ifdef::openshift-origin[]
94-
sshKey: 'ssh-ed25519 AAAA...' <15>
94+
sshKey: 'ssh-ed25519 AAAA...' <16>
9595
endif::openshift-origin[]
9696
ifdef::restricted[]
9797
ifndef::openshift-origin[]
98-
additionalTrustBundle: | <17>
98+
additionalTrustBundle: | <18>
9999
-----BEGIN CERTIFICATE-----
100100
ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
101101
-----END CERTIFICATE-----
102-
imageContentSources: <18>
102+
imageContentSources: <19>
103103
- mirrors:
104104
- <local_registry>/<local_repository_name>/release
105105
source: quay.io/openshift-release-dev/ocp-release
@@ -108,11 +108,11 @@ imageContentSources: <18>
108108
source: quay.io/openshift-release-dev/ocp-v4.0-art-dev
109109
endif::openshift-origin[]
110110
ifdef::openshift-origin[]
111-
additionalTrustBundle: | <16>
111+
additionalTrustBundle: | <17>
112112
-----BEGIN CERTIFICATE-----
113113
ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
114114
-----END CERTIFICATE-----
115-
imageContentSources: <17>
115+
imageContentSources: <18>
116116
- mirrors:
117117
- <local_registry>/<local_repository_name>/release
118118
source: quay.io/openshift-release-dev/ocp-release
@@ -153,13 +153,21 @@ value must match the number of control plane machines that you deploy.
153153
<6> The cluster name that you specified in your DNS records.
154154
<7> Establishes the relationships between a region and zone. You define a failure domain by using vCenter objects, such as a `datastore` object. A failure domain defines the vCenter location for {product-title} cluster nodes.
155155
<8> The vSphere datacenter.
156-
<9> Optional parameter. For installer-provisioned infrastructure, the absolute path of an existing resource pool where the installation program creates the virtual machines, for example, `/<datacenter_name>/host/<cluster_name>/Resources/<resource_pool_name>/<optional_nested_resource_pool_name>`. If you do not specify a value, resources are installed in the root of the cluster `/example_datacenter/host/example_cluster/Resources`.
157-
<10> Optional parameter For installer-provisioned infrastructure, the absolute path of an existing folder where the installation program creates the virtual machines, for example, `/<datacenter_name>/vm/<folder_name>/<subfolder_name>`. If you do not provide this value, the installation program creates a top-level folder in the datacenter virtual machine folder that is named with the infrastructure ID. If you are providing the infrastructure for the cluster and you do not want to use the default `StorageClass` object, named `thin`, you can omit the `folder` parameter from the `install-config.yaml` file.
158-
<11> The fully-qualified hostname or IP address of the vCenter server.
156+
<9> The path to the vSphere datastore that holds virtual machine files, templates, and ISO images.
157+
+
158+
[IMPORTANT]
159+
====
160+
You can specify the path of any datastore that exists in a datastore cluster. By default, Storage vMotion is automatically enabled for a datastore cluster. Red Hat does not support Storage vMotion, so you must disable Storage vMotion to avoid data loss issues for your {product-title} cluster.
161+
162+
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".
163+
====
164+
<10> Optional: For installer-provisioned infrastructure, the absolute path of an existing resource pool where the installation program creates the virtual machines, for example, `/<datacenter_name>/host/<cluster_name>/Resources/<resource_pool_name>/<optional_nested_resource_pool_name>`. If you do not specify a value, resources are installed in the root of the cluster `/example_datacenter/host/example_cluster/Resources`.
165+
<11> Optional: For installer-provisioned infrastructure, the absolute path of an existing folder where the installation program creates the virtual machines, for example, `/<datacenter_name>/vm/<folder_name>/<subfolder_name>`. If you do not provide this value, the installation program creates a top-level folder in the datacenter virtual machine folder that is named with the infrastructure ID. If you are providing the infrastructure for the cluster and you do not want to use the default `StorageClass` object, named `thin`, you can omit the `folder` parameter from the `install-config.yaml` file.
159166
<12> The password associated with the vSphere user.
160-
<13> The vSphere disk provisioning method.
167+
<13> The fully-qualified hostname or IP address of the vCenter server.
168+
<14> The vSphere disk provisioning method.
161169
ifndef::openshift-origin[]
162-
<14> Whether to enable or disable FIPS mode. By default, FIPS mode is not enabled. If FIPS mode is enabled, the {op-system-first} machines that {product-title} runs on bypass the default Kubernetes cryptography suite and use the cryptography modules that are provided with {op-system} instead.
170+
<15> Whether to enable or disable FIPS mode. By default, FIPS mode is not enabled. If FIPS mode is enabled, the {op-system-first} machines that {product-title} runs on bypass the default Kubernetes cryptography suite and use the cryptography modules that are provided with {op-system} instead.
163171
+
164172
[IMPORTANT]
165173
====
@@ -168,13 +176,13 @@ The use of FIPS Validated / Modules in Process cryptographic libraries is only s
168176
endif::openshift-origin[]
169177
ifndef::restricted[]
170178
ifndef::openshift-origin[]
171-
<15> The pull secret that you obtained from {cluster-manager-url}. This pull secret allows you to authenticate with the services that are provided by the included authorities, including Quay.io, which serves the container images for {product-title} components.
172-
<16> The public portion of the default SSH key for the `core` user in
179+
<16> The pull secret that you obtained from {cluster-manager-url}. This pull secret allows you to authenticate with the services that are provided by the included authorities, including Quay.io, which serves the container images for {product-title} components.
180+
<17> The public portion of the default SSH key for the `core` user in
173181
{op-system-first}.
174182
endif::openshift-origin[]
175183
ifdef::openshift-origin[]
176-
<15> You obtained the {cluster-manager-url-pull}. This pull secret allows you to authenticate with the services that are provided by the included authorities, including Quay.io, which serves the container images for {product-title} components.
177-
<16> The public portion of the default SSH key for the `core` user in
184+
<16> You obtained the {cluster-manager-url-pull}. This pull secret allows you to authenticate with the services that are provided by the included authorities, including Quay.io, which serves the container images for {product-title} components.
185+
<17> The public portion of the default SSH key for the `core` user in
178186
{op-system-first}.
179187
+
180188
[NOTE]
@@ -185,11 +193,11 @@ endif::openshift-origin[]
185193
endif::restricted[]
186194
ifdef::restricted[]
187195
ifndef::openshift-origin[]
188-
<15> For `<local_registry>`, specify the registry domain name, and optionally the
196+
<16> For `<local_registry>`, specify the registry domain name, and optionally the
189197
port, that your mirror registry uses to serve content. For example
190198
`registry.example.com` or `registry.example.com:5000`. For `<credentials>`,
191199
specify the base64-encoded user name and password for your mirror registry.
192-
<16> The public portion of the default SSH key for the `core` user in
200+
<17> The public portion of the default SSH key for the `core` user in
193201
{op-system-first}.
194202
+
195203
[NOTE]
@@ -198,11 +206,11 @@ For production {product-title} clusters on which you want to perform installatio
198206
====
199207
endif::openshift-origin[]
200208
ifdef::openshift-origin[]
201-
<14> For `<local_registry>`, specify the registry domain name, and optionally the
209+
<15> For `<local_registry>`, specify the registry domain name, and optionally the
202210
port, that your mirror registry uses to serve content. For example
203211
`registry.example.com` or `registry.example.com:5000`. For `<credentials>`,
204212
specify the base64-encoded user name and password for your mirror registry.
205-
<15> The public portion of the default SSH key for the `core` user in
213+
<16> The public portion of the default SSH key for the `core` user in
206214
{op-system-first}.
207215
+
208216
[NOTE]
@@ -213,15 +221,15 @@ endif::openshift-origin[]
213221
endif::restricted[]
214222
ifdef::restricted[]
215223
ifndef::openshift-origin[]
216-
<17> Provide the contents of the certificate file that you used for your mirror
224+
<18> Provide the contents of the certificate file that you used for your mirror
217225
registry.
218-
<18> Provide the `imageContentSources` section from the output of the command to
226+
<19> Provide the `imageContentSources` section from the output of the command to
219227
mirror the repository.
220228
endif::openshift-origin[]
221229
ifdef::openshift-origin[]
222-
<16> Provide the contents of the certificate file that you used for your mirror
230+
<17> Provide the contents of the certificate file that you used for your mirror
223231
registry.
224-
<17> Provide the `imageContentSources` section from the output of the command to
232+
<18> Provide the `imageContentSources` section from the output of the command to
225233
mirror the repository.
226234
endif::openshift-origin[]
227235
endif::restricted[]

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

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -393,6 +393,13 @@ For more information about vMotion and anti-affinity rules, see the VMware vSphe
393393
--
394394
* 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. These references prevent affected pods from starting up and can result in data loss.
395395
* Similarly, {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.
396+
+
397+
[IMPORTANT]
398+
====
399+
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.
400+
401+
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".
402+
====
396403

397404
[discrete]
398405
[id="installation-vsphere-installer-infra-requirements-resources_{context}"]

0 commit comments

Comments
 (0)