This section provides details of the VMware vCenter access and network access for creating and provisioning the deployers and cluster virtual machines.

environments:
  <environment name>:
      server: <vCenter name or IP address>
      username: <vCenter user name>
      datacenter: <vCenter datacenter name>
      cluster: <vCenter cluster name>
      nics: [ <LIST of vCenter networks> ]
      nameservers: [ <LIST of DNS servers> ]
      search-domains: [ <LIST of search domains ]
      ntp: <ntp server name or IP address>
      https-proxy: <HTTP proxy server>
      no-proxy: <list of domains not using proxy>

Guidelines for configuring the VMware vCenter environment:

• The environment name can have only lowercase letters, digits, and hyphens (-).

• The NIC's list must have only one network, although the NIC configuration allows multiple networks. This network is used as the management network in the deployer or cluster that refers to this environment.

• Configure multiple environments for this vCenter if your vCenter has more than one network that serves as a management network. One for each network. In addition, refer to the corresponding environment in the deployer or cluster based on the management network it uses.

• Make sure the NIC's name-servers and search-domains fields are configured as lists.

Before creating and deploying a deployer, define a minimum of one environment.

deployers:
  <deployer name>:
      environment: <environment of vCenter hosting the deployer>
      address: <deployer VM IP address in CIDR format>
      gateway: <gateway IP address>
      username: <user name for deployer>
      # SSH private-key-file with path relative to the staging directory
      # If the line is missing, ssh private key will be auto-generated and saved inside .sec/
      private-key-file: <path and filename for ssh private key>
      host: <ESXi host IP address>
      datastore: <vCenter datastore name for host>

Guidelines for configuring the deployer:

• The name of the deployer can have only lowercase letters, digits, and hyphens (-).

• The private-key-file field, when present, should refer to the SSH private key file. This file must be in the staging directory and must not be accessible (read/write/execute) to other users.

  If the private-key-file line is missing, the deployer script generates an SSH private key for the deployer and places it in the .sec subdirectory under the staging directory. The filename is <deployer-name>_auto.pem.

• To avoid resource contention, do not run the deployer in an ESXi server that serves any Cisco Smart PHY cluster.

Before creating and deploying a cluster, configure one environment and one deployer. A cluster has an environment field to reference to its corresponding environment.

clusters:
 <SMI cluster name>
   type: "smartphy"
   environment: <environment of vCenter hosting the SMI cluster>
   gateway: <gateway IP address>
   username: <user name for the SMI cluster>
   # SSH private-key-file with path relative to the staging directory
   # If the line is missing, ssh private key will be auto-generated and saved inside .sec/
   private-key-file: <path and filename for ssh private key>
   # The following two fields are for multi-node cluster only
   master-vip: <virtual IP address for the management network in CIDR format>
   vrouter-id: <VRRP ID for the management network>
   # ingress-hostname only supports '.' and alphanumeric characters
   ingress-hostname: "smartphy.example.com"

   # For Multi-Node cluster only
   nodes:
    - host: <ESXi host 1 IP address>
     addresses: [ <CONTROL-PLANE 1 IP>, <ETCD 1 IP>, <INTRA 1 IP>, <OPS 1 IP> ]
     datastore: <vCenter datastore for host 1>
     ops:
      interfaces:
       - vip: [ <LIST of virtual IP for CIN network in CIDR format> ]
         vrouter-id: <VRRP ID for CIN network>
         addresses: [ <LIST of IP addresses for CIN network in CIDR format> ]
         nics: <vCenter network for CIN>
         # CIN routing table (optional)
         routes:
          - { dest: [ <LIST of destination subnets> ], nhop: <next hop IP> }
          - { dest: [ <LIST of destination subnets> ], nhop: <next hop IP> }
    - host: <ESXi host 2 IP address>
      addresses: [ <CONTROL-PLANE 2 IP>, <ETCD 2 IP>, <INTRA 2 IP>, <OPS 2 IP> ]
      datastore: <vCenter datastore for host 2>
      ops:
       interfaces:
        - addresses: [ <LIST of IP addresses for CIN network in CIDR format> ]
    - host: <ESXi host 3 IP address>
      addresses: [ <CONTROL-PLANE 3 IP>, <ETCD 3 IP>, <INTRA 3 IP>, <OPS 3 IP> ]
      datastore: <vCenter datastore for host 3>
      ops:
       interfaces:
        - addresses: [ <LIST of IP addresses for CIN network in CIDR format> ]

   # For Single-Node cluster only
     nodes:
      - host: <ESXi host IP address>
        addresses: [ <AIO VM IP address> ]
        datastore: <vCenter datastore for host>
        ops:
         interfaces:
          - addresses: [ <LIST of IP addresses for CIN network in CIDR format> ]
            nics: <vCenter network for CIN>
            routes:
             - { dest: [ <LIST of destination subnets> ], nhop: <next hop IP> }
             - { dest: [ <LIST of destination subnets> ], nhop: <next hop IP> }

Guidelines for configuring a cluster:

• The name of the cluster can have only lowercase letters, digits, and hyphens (-).

• The private-key-file field, when present, should refer to the SSH private key file. This file must be in the staging directory and must not be accessible (read/write/execute) to other users.

  If the private-key-file line is missing, the deployer script generates an SSH private key for the cluster and places it in the .sec subdirectory under the staging directory. The filename is <cluster-name>_auto.pem.

• Configure the virtual IP address of the Smart PHY cluster and VRRP ID (vrouter-id at cluster level) for the management network for multinode clusters. The management network supports only IPv4. The vrouter-id can take values 1–254.

• If multiple clusters share the same management subnet, the VRRP ID for each cluster must be unique in the management subnet.