Skip to content

Commit 06d331e

Browse files
authored
Merge pull request #68665 from bscott-rh/vsphere-config-params-reformat
Reformatting vsphere installation configuration parameters table
2 parents ae616f8 + 324e69b commit 06d331e

File tree

1 file changed

+90
-90
lines changed

1 file changed

+90
-90
lines changed

modules/installation-configuration-parameters.adoc

Lines changed: 90 additions & 90 deletions
Original file line numberDiff line numberDiff line change
@@ -2162,82 +2162,82 @@ ifdef::vsphere[]
21622162
Additional VMware vSphere configuration parameters are described in the following table:
21632163

21642164
.Additional VMware vSphere cluster parameters
2165-
[cols=".^2,.^4,.^2",options="header,word-wrap",subs="+quotes,+attributes"]
2165+
[cols=".^2l,.^4,.^2",options="header,word-wrap",subs="+quotes,+attributes"]
21662166
|====
21672167
|Parameter|Description|Values
21682168

2169-
l|platform:
2170-
vsphere
2171-
apiVIPs
2169+
|platform:
2170+
vsphere:
2171+
apiVIPs:
21722172
|Virtual IP (VIP) addresses that you configured for control plane API access.
21732173

21742174
*Note:* This parameter applies only to installer-provisioned infrastructure.
21752175
|Multiple IP addresses
21762176

2177-
l|platform
2178-
vsphere
2179-
diskType
2177+
|platform:
2178+
vsphere:
2179+
diskType:
21802180
|Optional. The disk provisioning method. This value defaults to the vSphere default storage policy if not set.
21812181
|Valid values are `thin`, `thick`, or `eagerZeroedThick`.
21822182

2183-
l|platform
2184-
vsphere
2185-
failureDomains
2183+
|platform:
2184+
vsphere:
2185+
failureDomains:
21862186
|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.
21872187
|String
21882188

2189-
l|platform
2190-
vsphere
2191-
failureDomains
2192-
topology
2193-
networks
2189+
|platform:
2190+
vsphere:
2191+
failureDomains:
2192+
topology:
2193+
networks:
21942194
|Lists any network in the vCenter instance that contains the virtual IP addresses and DNS records that you configured.
21952195
|String
21962196

2197-
l|platform
2198-
vsphere
2199-
failureDomains
2200-
region
2197+
|platform:
2198+
vsphere:
2199+
failureDomains:
2200+
region:
22012201
|If you define multiple failure domains for your cluster, you must attach the tag to each vCenter datacenter. To define a region, use a tag from the `openshift-region` tag category. For a single vSphere datacenter environment, you do not need to attach a tag, but you must enter an alphanumeric value, such as `datacenter`, for the parameter.
22022202
|String
22032203

2204-
l|platform
2205-
vsphere
2206-
failureDomains
2207-
zone
2204+
|platform:
2205+
vsphere:
2206+
failureDomains:
2207+
zone:
22082208
|If you define multiple failure domains for your cluster, you must attach the tag to each vCenter cluster. To define a zone, use a tag from the `openshift-zone` tag category. For a single vSphere datacenter environment, you do not need to attach a tag, but you must enter an alphanumeric value, such as `cluster`, for the parameter.
22092209
|String
22102210

2211-
l|platform
2212-
vsphere
2213-
failureDomains
2214-
template
2211+
|platform:
2212+
vsphere:
2213+
failureDomains:
2214+
template:
22152215
|Specify the absolute path to a pre-existing {op-system-first} image template or virtual machine. The installation program can use the image template or virtual machine to quickly install {op-system} on vSphere hosts. Consider using this parameter as an alternative to uploading an {op-system} image on vSphere hosts. The parameter is available for use only on installer-provisioned infrastructure.
22162216
|String
22172217

2218-
l|platform
2219-
vsphere
2220-
ingressVIPs
2218+
|platform:
2219+
vsphere:
2220+
ingressVIPs:
22212221
|Virtual IP (VIP) addresses that you configured for cluster Ingress.
22222222

22232223
*Note:* This parameter applies only to installer-provisioned infrastructure.
22242224
|Multiple IP addresses
22252225

2226-
l|platform
2227-
vsphere
2226+
|platform:
2227+
vsphere:
22282228
| Describes your account on the cloud platform that hosts your cluster. You can use the parameter to customize the platform. When providing additional configuration settings for compute and control plane machines in the machine pool, the parameter is optional. You can only specify one vCenter server for your {product-title} cluster.
22292229
|String
22302230

2231-
l|platform
2232-
vsphere
2233-
vcenters
2231+
|platform:
2232+
vsphere:
2233+
vcenters:
22342234
|Lists any fully-qualified hostname or IP address of a vCenter server.
22352235
|String
22362236

2237-
l|platform
2238-
vsphere
2239-
vcenters
2240-
datacenters
2237+
|platform:
2238+
vsphere:
2239+
vcenters:
2240+
datacenters:
22412241
|Lists and defines the datacenters where {product-title} virtual machines (VMs) operate. The list of datacenters must match the list of datacenters specified in the `failureDomains` field.
22422242
|String
22432243
|====
@@ -2250,80 +2250,80 @@ In {product-title} 4.13, the following vSphere configuration parameters are depr
22502250
The following table lists each deprecated vSphere configuration parameter:
22512251

22522252
.Deprecated VMware vSphere cluster parameters
2253-
[cols=".^2,.^4,.^2",options="header,word-wrap",subs="+quotes,+attributes"]
2253+
[cols=".^2l,.^4,.^2",options="header,word-wrap",subs="+quotes,+attributes"]
22542254
|====
22552255
|Parameter|Description|Values
22562256

2257-
l|platform
2258-
vsphere
2259-
apiVIP
2257+
|platform:
2258+
vsphere:
2259+
apiVIP:
22602260
|The virtual IP (VIP) address that you configured for control plane API access.
22612261

22622262
*Note:* In {product-title} 4.12 and later, the `apiVIP` configuration setting is deprecated. Instead, use a `List` format to enter a value in the `apiVIPs` configuration setting.
22632263
a|An IP address, for example `128.0.0.1`.
22642264

2265-
l|platform
2266-
vsphere
2267-
cluster
2265+
|platform:
2266+
vsphere:
2267+
cluster:
22682268
|The vCenter cluster to install the {product-title} cluster in.
22692269
|String
22702270

2271-
l|platform
2272-
vsphere
2273-
datacenter
2271+
|platform:
2272+
vsphere:
2273+
datacenter:
22742274
|Defines the datacenter where {product-title} virtual machines (VMs) operate.
22752275
|String
22762276

2277-
l|platform
2278-
vsphere
2279-
defaultDatastore
2277+
|platform:
2278+
vsphere:
2279+
defaultDatastore:
22802280
|The name of the default datastore to use for provisioning volumes.
22812281
|String
22822282

2283-
l|platform
2284-
vsphere
2285-
folder
2283+
|platform:
2284+
vsphere:
2285+
folder:
22862286
|Optional. The absolute path of an existing folder where the installation program creates the virtual machines. If you do not provide this value, the installation program creates a folder that is named with the infrastructure ID in the data center virtual machine folder.
22872287
|String, for example, `/<datacenter_name>/vm/<folder_name>/<subfolder_name>`.
22882288

2289-
l|platform
2290-
vsphere
2291-
ingressVIP
2289+
|platform:
2290+
vsphere:
2291+
ingressVIP:
22922292
|Virtual IP (VIP) addresses that you configured for cluster Ingress.
22932293

22942294
*Note:* In {product-title} 4.12 and later, the `ingressVIP` configuration setting is deprecated. Instead, use a `List` format to enter a value in the `ingressVIPs` configuration setting.
22952295
a|An IP address, for example `128.0.0.1`.
22962296

2297-
l|platform
2298-
vsphere
2299-
network
2297+
|platform:
2298+
vsphere:
2299+
network:
23002300
|The network in the vCenter instance that contains the virtual IP addresses and DNS records that you configured.
23012301
|String
23022302

2303-
l|platform
2304-
vsphere
2305-
password
2303+
|platform:
2304+
vsphere:
2305+
password:
23062306
|The password for the vCenter user name.
23072307
|String
23082308

2309-
l|platform
2310-
vsphere
2311-
resourcePool
2309+
|platform:
2310+
vsphere:
2311+
resourcePool:
23122312
|Optional. The absolute path of an existing resource pool where the installation program creates the virtual machines. If you do not specify a value, the installation program installs the resources in the root of the cluster under `/<datacenter_name>/host/<cluster_name>/Resources`.
23132313
a|String, for example, `/<datacenter_name>/host/<cluster_name>/Resources/<resource_pool_name>/<optional_nested_resource_pool_name>`.
23142314

2315-
l|platform
2316-
vsphere
2317-
username
2315+
|platform:
2316+
vsphere:
2317+
username:
23182318
|The user name to use to connect to the vCenter instance with. This user must have at least
23192319
the roles and privileges that are required for
23202320
link:https://github.com/vmware-archive/vsphere-storage-for-kubernetes/blob/master/documentation/vcp-roles.md[static or dynamic persistent volume provisioning]
23212321
in vSphere.
23222322
|String
23232323

2324-
l|platform
2325-
vsphere
2326-
vCenter
2324+
|platform:
2325+
vsphere:
2326+
vCenter:
23272327
|The fully-qualified hostname or IP address of a vCenter server.
23282328
|String
23292329
|====
@@ -2334,38 +2334,38 @@ l|platform
23342334
Optional VMware vSphere machine pool configuration parameters are described in the following table:
23352335

23362336
.Optional VMware vSphere machine pool parameters
2337-
[cols=".^2a,.^3a,.^3a",options="header"]
2337+
[cols=".^2l,.^3a,.^3a",options="header"]
23382338
|====
23392339
|Parameter|Description|Values
23402340

2341-
l|platform
2342-
vsphere
2343-
clusterOSImage
2341+
|platform:
2342+
vsphere:
2343+
clusterOSImage:
23442344
|The location from which the installation program downloads the {op-system-first} image. Before setting a path value for this parameter, ensure that the default {op-system} boot image in the {product-title} release matches the {op-system} image template or virtual machine version; otherwise, cluster installation might fail.
23452345
|An HTTP or HTTPS URL, optionally with a SHA-256 checksum. For example, `\https://mirror.openshift.com/images/rhcos-<version>-vmware.<architecture>.ova`.
23462346

2347-
l|platform
2348-
vsphere
2349-
osDisk
2350-
diskSizeGB
2347+
|platform:
2348+
vsphere:
2349+
osDisk:
2350+
diskSizeGB:
23512351
|The size of the disk in gigabytes.
23522352
|Integer
23532353

2354-
l|platform
2355-
vsphere
2356-
cpus
2354+
|platform:
2355+
vsphere:
2356+
cpus:
23572357
|The total number of virtual processor cores to assign a virtual machine. The value of `platform.vsphere.cpus` must be a multiple of `platform.vsphere.coresPerSocket` value.
23582358
|Integer
23592359

2360-
l|platform
2361-
vsphere
2362-
coresPerSocket
2360+
|platform:
2361+
vsphere:
2362+
coresPerSocket:
23632363
|The number of cores per socket in a virtual machine. The number of virtual sockets on the virtual machine is `platform.vsphere.cpus`/`platform.vsphere.coresPerSocket`. The default value for control plane nodes and worker nodes is `4` and `2`, respectively.
23642364
|Integer
23652365

2366-
l|platform
2367-
vsphere
2368-
memoryMB
2366+
|platform:
2367+
vsphere:
2368+
memoryMB:
23692369
|The size of a virtual machine's memory in megabytes.
23702370
|Integer
23712371
|====

0 commit comments

Comments
 (0)