The VMware Edge Cloud Orchestrator service uses an API that is part of the vSphere Configuration Profiles feature, itself a desired state system, where the input is a document describing desired configuration, and an ESXi component that realizes that configuration.

As part of the configuration files, the VMware Edge Cloud Orchestrator service uses a Kubernetes custom resources exposing ESXi configuration, this provides a unified devops user interface experience for all configuration at an edge location.

The configuration file is placed in your Git repository with a name chosen by you ending in .yaml (for example, hostconfig.yaml). This file is used to configure the VMware Edge Cloud Orchestrator host after synchronization.

The following example shows a HostConfiguration object to set NTP configuration for a VMware Edge Cloud Orchestrator host. For more advanced host configuration examples, visit the Example repository https://github.com/alanrenouf/KeswickExample.

apiVersion: esx.vmware.com/v1alpha1
kind: HostConfiguration
metadata:
  name: keswick-host-config
  namespace: esx-system
spec:
  layertype: Incremental
  profile: |
    {
      "esx": {
        "system": {
          "system_time": {
            "enabled": true,
            "protocol": "NTP",
            "ntp_config": {
              "server": [{
                  "hostname": "0.pool.ntp.org",
                  "command": "SERVER"
                },
                {
                  "hostname": "1.pool.ntp.org",
                  "command": "SERVER"
                }
              ]
            }
          }
        }
      }
    }

Applying Configuration

Configuration is applied to the VMware Edge Cloud Orchestrator host depending on what configuration is changed. If the change requires a reboot, immediate host reboot is initiated. If the change requires entering the maintenance mode, the host automatically enters the maintenance mode.

After the configuration is applied, the VMware Edge Cloud Orchestrator host automatically exists the maintenance mode (all previously suspended VM workloads are resumed).

Note:

Not all configuration changes require maintenance mode or host reboot (for example, the NTP configuration change shown in the example does not require both) and the configuration changes are applied on the running host.

If a configuration change does require maintenance mode or a reboot, there is a workload disruption and availability impact. You must plan these updates carefully.