Skip to content

Commit 324e69b

Browse files
committed
Reformatting vsphere installation configuration parameters table
1 parent 77277e9 commit 324e69b

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
@@ -1881,82 +1881,82 @@ ifdef::vsphere[]
18811881
Additional VMware vSphere configuration parameters are described in the following table:
18821882

18831883
.Additional VMware vSphere cluster parameters
1884-
[cols=".^2,.^4,.^2",options="header,word-wrap",subs="+quotes,+attributes"]
1884+
[cols=".^2l,.^4,.^2",options="header,word-wrap",subs="+quotes,+attributes"]
18851885
|====
18861886
|Parameter|Description|Values
18871887

1888-
l|platform:
1889-
vsphere
1890-
apiVIPs
1888+
|platform:
1889+
vsphere:
1890+
apiVIPs:
18911891
|Virtual IP (VIP) addresses that you configured for control plane API access.
18921892

18931893
*Note:* This parameter applies only to installer-provisioned infrastructure.
18941894
|Multiple IP addresses
18951895

1896-
l|platform
1897-
vsphere
1898-
diskType
1896+
|platform:
1897+
vsphere:
1898+
diskType:
18991899
|Optional. The disk provisioning method. This value defaults to the vSphere default storage policy if not set.
19001900
|Valid values are `thin`, `thick`, or `eagerZeroedThick`.
19011901

1902-
l|platform
1903-
vsphere
1904-
failureDomains
1902+
|platform:
1903+
vsphere:
1904+
failureDomains:
19051905
|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.
19061906
|String
19071907

1908-
l|platform
1909-
vsphere
1910-
failureDomains
1911-
topology
1912-
networks
1908+
|platform:
1909+
vsphere:
1910+
failureDomains:
1911+
topology:
1912+
networks:
19131913
|Lists any network in the vCenter instance that contains the virtual IP addresses and DNS records that you configured.
19141914
|String
19151915

1916-
l|platform
1917-
vsphere
1918-
failureDomains
1919-
region
1916+
|platform:
1917+
vsphere:
1918+
failureDomains:
1919+
region:
19201920
|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.
19211921
|String
19221922

1923-
l|platform
1924-
vsphere
1925-
failureDomains
1926-
zone
1923+
|platform:
1924+
vsphere:
1925+
failureDomains:
1926+
zone:
19271927
|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.
19281928
|String
19291929

1930-
l|platform
1931-
vsphere
1932-
failureDomains
1933-
template
1930+
|platform:
1931+
vsphere:
1932+
failureDomains:
1933+
template:
19341934
|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.
19351935
|String
19361936

1937-
l|platform
1938-
vsphere
1939-
ingressVIPs
1937+
|platform:
1938+
vsphere:
1939+
ingressVIPs:
19401940
|Virtual IP (VIP) addresses that you configured for cluster Ingress.
19411941

19421942
*Note:* This parameter applies only to installer-provisioned infrastructure.
19431943
|Multiple IP addresses
19441944

1945-
l|platform
1946-
vsphere
1945+
|platform:
1946+
vsphere:
19471947
| 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.
19481948
|String
19491949

1950-
l|platform
1951-
vsphere
1952-
vcenters
1950+
|platform:
1951+
vsphere:
1952+
vcenters:
19531953
|Lists any fully-qualified hostname or IP address of a vCenter server.
19541954
|String
19551955

1956-
l|platform
1957-
vsphere
1958-
vcenters
1959-
datacenters
1956+
|platform:
1957+
vsphere:
1958+
vcenters:
1959+
datacenters:
19601960
|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.
19611961
|String
19621962
|====
@@ -1969,80 +1969,80 @@ In {product-title} 4.13, the following vSphere configuration parameters are depr
19691969
The following table lists each deprecated vSphere configuration parameter:
19701970

19711971
.Deprecated VMware vSphere cluster parameters
1972-
[cols=".^2,.^4,.^2",options="header,word-wrap",subs="+quotes,+attributes"]
1972+
[cols=".^2l,.^4,.^2",options="header,word-wrap",subs="+quotes,+attributes"]
19731973
|====
19741974
|Parameter|Description|Values
19751975

1976-
l|platform
1977-
vsphere
1978-
apiVIP
1976+
|platform:
1977+
vsphere:
1978+
apiVIP:
19791979
|The virtual IP (VIP) address that you configured for control plane API access.
19801980

19811981
*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.
19821982
a|An IP address, for example `128.0.0.1`.
19831983

1984-
l|platform
1985-
vsphere
1986-
cluster
1984+
|platform:
1985+
vsphere:
1986+
cluster:
19871987
|The vCenter cluster to install the {product-title} cluster in.
19881988
|String
19891989

1990-
l|platform
1991-
vsphere
1992-
datacenter
1990+
|platform:
1991+
vsphere:
1992+
datacenter:
19931993
|Defines the datacenter where {product-title} virtual machines (VMs) operate.
19941994
|String
19951995

1996-
l|platform
1997-
vsphere
1998-
defaultDatastore
1996+
|platform:
1997+
vsphere:
1998+
defaultDatastore:
19991999
|The name of the default datastore to use for provisioning volumes.
20002000
|String
20012001

2002-
l|platform
2003-
vsphere
2004-
folder
2002+
|platform:
2003+
vsphere:
2004+
folder:
20052005
|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.
20062006
|String, for example, `/<datacenter_name>/vm/<folder_name>/<subfolder_name>`.
20072007

2008-
l|platform
2009-
vsphere
2010-
ingressVIP
2008+
|platform:
2009+
vsphere:
2010+
ingressVIP:
20112011
|Virtual IP (VIP) addresses that you configured for cluster Ingress.
20122012

20132013
*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.
20142014
a|An IP address, for example `128.0.0.1`.
20152015

2016-
l|platform
2017-
vsphere
2018-
network
2016+
|platform:
2017+
vsphere:
2018+
network:
20192019
|The network in the vCenter instance that contains the virtual IP addresses and DNS records that you configured.
20202020
|String
20212021

2022-
l|platform
2023-
vsphere
2024-
password
2022+
|platform:
2023+
vsphere:
2024+
password:
20252025
|The password for the vCenter user name.
20262026
|String
20272027

2028-
l|platform
2029-
vsphere
2030-
resourcePool
2028+
|platform:
2029+
vsphere:
2030+
resourcePool:
20312031
|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`.
20322032
a|String, for example, `/<datacenter_name>/host/<cluster_name>/Resources/<resource_pool_name>/<optional_nested_resource_pool_name>`.
20332033

2034-
l|platform
2035-
vsphere
2036-
username
2034+
|platform:
2035+
vsphere:
2036+
username:
20372037
|The user name to use to connect to the vCenter instance with. This user must have at least
20382038
the roles and privileges that are required for
20392039
link:https://github.com/vmware-archive/vsphere-storage-for-kubernetes/blob/master/documentation/vcp-roles.md[static or dynamic persistent volume provisioning]
20402040
in vSphere.
20412041
|String
20422042

2043-
l|platform
2044-
vsphere
2045-
vCenter
2043+
|platform:
2044+
vsphere:
2045+
vCenter:
20462046
|The fully-qualified hostname or IP address of a vCenter server.
20472047
|String
20482048
|====
@@ -2053,38 +2053,38 @@ l|platform
20532053
Optional VMware vSphere machine pool configuration parameters are described in the following table:
20542054

20552055
.Optional VMware vSphere machine pool parameters
2056-
[cols=".^2a,.^3a,.^3a",options="header"]
2056+
[cols=".^2l,.^3a,.^3a",options="header"]
20572057
|====
20582058
|Parameter|Description|Values
20592059

2060-
l|platform
2061-
vsphere
2062-
clusterOSImage
2060+
|platform:
2061+
vsphere:
2062+
clusterOSImage:
20632063
|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.
20642064
|An HTTP or HTTPS URL, optionally with a SHA-256 checksum. For example, `\https://mirror.openshift.com/images/rhcos-<version>-vmware.<architecture>.ova`.
20652065

2066-
l|platform
2067-
vsphere
2068-
osDisk
2069-
diskSizeGB
2066+
|platform:
2067+
vsphere:
2068+
osDisk:
2069+
diskSizeGB:
20702070
|The size of the disk in gigabytes.
20712071
|Integer
20722072

2073-
l|platform
2074-
vsphere
2075-
cpus
2073+
|platform:
2074+
vsphere:
2075+
cpus:
20762076
|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.
20772077
|Integer
20782078

2079-
l|platform
2080-
vsphere
2081-
coresPerSocket
2079+
|platform:
2080+
vsphere:
2081+
coresPerSocket:
20822082
|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.
20832083
|Integer
20842084

2085-
l|platform
2086-
vsphere
2087-
memoryMB
2085+
|platform:
2086+
vsphere:
2087+
memoryMB:
20882088
|The size of a virtual machine's memory in megabytes.
20892089
|Integer
20902090
|====

0 commit comments

Comments
 (0)