github.com/openshift/installer@v1.4.17/docs/user/vsphere/customization.md (about)

     1  # vSphere Platform Customization
     2  
     3  Beyond the [platform-agnostic `install-config.yaml` properties](../customization.md#platform-customization), the installer supports additional, vSphere-specific properties.
     4  
     5  ## Cluster-scoped properties
     6  
     7  * `vCenter` (required string): The domain name or IP address of the vCenter.
     8  * `username` (required string): The username to use to connect to the vCenter.
     9  * `password` (required string): The password to use to connect to the vCenter.
    10  * `datacenter` (required string): The name of the datacenter to use in the vCenter.
    11  * `defaultDatastore` (required string): The default datastore to use for provisioning volumes.
    12  * `folder` (optional string): The absolute path of an existing folder where the installer should create VMs. The absolute path is of the form `/example_datacenter/vm/example_folder/example_subfolder`. If a value is specified, the folder must exist. If no value is specified, a folder named with the cluster ID will be created in the `datacenter` VM folder.
    13  * `resourcePool` (optional string): The absolute path of an existing resource pool where the installer should create VMs. The absolute path is of the form `/example_datacenter/host/example_cluster/Resources/example_resource_pool/optionally_sub_resource_pool`. If a value is specified, the resource pool must exist. If no value is specified, resources will be installed in the root of the cluster `/example_datacenter/host/example_cluster/Resources`.
    14  
    15  ## Machine pools
    16  
    17  * `osDisk` (optional object):
    18      * `diskSizeGB` (optional integer): The size of the disk in gigabytes (GB).
    19  * `cpus` (optional integer): The total number of virtual processor cores to assign a vm.
    20  * `coresPerSocket` (optional integer): The number of cores per socket in a vm. The number of vCPUs on the vm will be cpus/coresPerSocket (default is 1).
    21  * `memoryMB` (optional integer): The size of a VM's memory in megabytes.
    22  * `disk_type` (optional string): DiskType is the name of the disk provisioning type, valid values are thin, thick, and eagerZeroedThick. When not specified, it will be set according to the default storage policy of vsphere.
    23  
    24  ## Examples
    25  
    26  Some example `install-config.yaml` are shown below.
    27  For examples of platform-agnostic configuration fragments, see [here](../customization.md#examples).
    28  
    29  ### Minimal
    30  
    31  An example minimal vSphere install config is:
    32  
    33  ```yaml
    34  apiVersion: v1
    35  baseDomain: example.com
    36  metadata:
    37    name: test-cluster
    38  platform:
    39    vSphere:
    40      vCenter: your.vcenter.example.com
    41      username: username
    42      password: password
    43      datacenter: datacenter
    44      defaultDatastore: datastore
    45  pullSecret: '{"auths": ...}'
    46  sshKey: ssh-ed25519 AAAA...
    47  ```
    48  
    49  ### Custom Machine Pools
    50  
    51  An example vSphere install config with custom machine pools:
    52  ```yaml
    53  apiVersion: v1
    54  baseDomain: example.com
    55  controlPlane:
    56    name: master
    57    platform:
    58      vsphere:
    59        cpus: 8
    60        coresPerSocket: 2
    61        memoryMB: 24576
    62        osDisk:
    63          diskSizeGB: 512
    64    replicas: 3
    65  compute:
    66  - name: worker
    67    platform:
    68      vsphere:
    69        cpus: 8
    70        coresPerSocket: 2
    71        memoryMB: 24576
    72        osDisk:
    73          diskSizeGB: 512
    74    replicas: 5
    75  metadata:
    76    name: test-cluster
    77  platform:
    78    vSphere:
    79      vCenter: your.vcenter.example.com
    80      username: username
    81      password: password
    82      datacenter: datacenter
    83      defaultDatastore: datastore
    84  pullSecret: '{"auths": ...}'
    85  sshKey: ssh-ed25519 AAAA...
    86  ```