Cloud provider — VMware vSphere: configuration

Schema version: 1

• settings

  object
  • settings.disableTimesync

    boolean

    Disable time synchronization on the vSphere side.

    Caution! This parameter will not disable the NTP daemons in the guest OS, but only disable the time correction on the part of ESXi.

  • settings.externalNetworkNames

    array of strings

    Names of networks (just the name and not the full path) connected to VirtualMachines and used by vsphere-cloud-controller-manager to insert ExternalIP into the .status.addresses field in the Node API object.

  • settings.host

    string

    The domain of the vCenter server.

  • settings.insecure

    boolean

    Set to true if vCenter has a self-signed certificate.

  • settings.internalNetworkNames

    array of strings

    Names of networks (just the name and not the full path) connected to VirtualMachines and used by vsphere-cloud-controller-manager to insert InternalIP into the .status.addresses field in the Node API object.

  • settings.nsxt

    object

    Kubernetes load balancer support using NSX-T for the vSphere cloud controller manager.

    • settings.nsxt.defaultIpPoolName

      string

      Required value

      Name of the default IP pool used for the SVC’s without loadbalancer.vmware.io/class annotation set.

      Example:

      defaultIpPoolName: pool1
      

    • settings.nsxt.defaultTcpAppProfileName

      string

      Name of default NSX-T application profile used for TCP connections.

      Default: "default-tcp-lb-app-profile"

      Examples:

      defaultTcpAppProfileName: default-tcp-lb-app-profile
      

      defaultTcpAppProfileName: tcp-profile1
      

    • settings.nsxt.defaultUdpAppProfileName

      string

      Name of default NSX-T application profile used for UDP connections.

      Default: "default-udp-lb-app-profile"

      Examples:

      defaultUdpAppProfileName: default-udp-lb-app-profile
      

      defaultUdpAppProfileName: udp-profile1
      

    • settings.nsxt.host

      string

      Required value

      NSX-T host.

      Example:

      host: 1.2.3.4
      

    • settings.nsxt.insecureFlag

      boolean

      To be set to true if NSX-T uses self-signed certificate.

      Examples:

      insecureFlag: true
      

      insecureFlag: false
      

    • settings.nsxt.loadBalancerClass

      array

      Additional section to define Load Balancer Classes (to use class, set annotation loadbalancer.vmware.io/class: <class name> to SVC).

      Examples:

      loadBalancerClass: []
      

      loadBalancerClass:
        name: LBC1
        ipPoolName: pool2
      

      loadBalancerClass:
        name: LBC1
        ipPoolName: pool2
        tcpAppProfileName: profile2
        udpAppProfileName: profile3
      

      • settings.nsxt.loadBalancerClass.ipPoolName

        string

        Required value

        Name of the IP pool.

      • settings.nsxt.loadBalancerClass.name

        string

        Required value

        Load Balancer Class name to use in SVC annotation loadbalancer.vmware.io/class: <class name>.

      • settings.nsxt.loadBalancerClass.tcpAppProfileName

        string

        Name of application profile used for TCP connections.

        Default: "defaultTcpAppProfileName"

      • settings.nsxt.loadBalancerClass.udpAppProfileName

        string

        Name of application profile used for UDP connections.

        Default: "defaultUdpAppProfileName"

    • settings.nsxt.password

      string

      Required value

      NSX-T password.

      Example:

      password: password
      

    • settings.nsxt.size

      string

      Size of load balancer service.

      Default: "MEDIUM"

      Allowed values: SMALL, MEDIUM, LARGE, XLARGE

      Example:

      size: SMALL
      

    • settings.nsxt.tier1GatewayPath

      string

      Required value

      Policy path for the NSX-T tier1 gateway.

      Example:

      tier1GatewayPath: "/path/tier1"
      

    • settings.nsxt.user

      string

      Required value

      NSX-T user name.

      Example:

      user: user
      

  • settings.password

    string

    The user’s password.

  • settings.region

    string

    Is a tag added to the vSphere Datacenter where all actions will occur: provisioning VirtualMachines, storing virtual disks on datastores, connecting to the network.

  • settings.regionTagCategory

    string

    The name of the tag category used to identify the region (vSphere Datacenter).

  • settings.sshKeys

    array of strings

    A list of public SSH keys in plain-text format.

  • settings.storageClass

    object
    • settings.storageClass.compatibilityFlag

      string

      A flag allowing the use of the old CSI version:

      • legacy — use the old version of the driver. FCD discs only, no online-resizing;
      • migration — in this case, both drivers will be available in the cluster at the same time. This mode is used to migrate from an old driver.

      Allowed values: legacy, migration

    • settings.storageClass.default

      Deprecated

      string

      The name of StorageClass that will be used in the cluster by default.

      If the parameter is omitted, the default StorageClass is either:

      • an arbitrary StorageClass present in the cluster that has the default annotation;
      • the first (in lexicographic order) StorageClass created by the module.

      Parameter is deprecated. Instead, use the global parameter global.defaultClusterStorageClass.

      Example:

      default: fast-lun102-7d0bf578
      

    • settings.storageClass.exclude

      array of strings

      A list of StorageClass names (or regex expressions for names) to exclude from the creation in the cluster.

      Example:

      exclude:
      - ".*-lun101-.*"
      - slow-lun103-1c280603
      

  • settings.username

    string

    The login ID.

  • settings.vmFolderPath

    string

    The path to the VirtualMachine Folder where the cloned VMs will be created.

  • settings.zoneTagCategory

    string

    The name of the tag category used to identify the region (vSphere Cluster).

  • settings.zones

    array of strings

    The globally restricted set of zones that this Cloud Provider works with.