Install a Supervisor Service on Supervisors

After adding a Supervisor Service to vCenter Server, you can install it on a Supervisor in your vSphere with Tanzu environment. If you install a newer version of the Supervisor Service, it overrides any older service versions on that Supervisor. Only one Supervisor Service version can run on the Supervisor at a time.

• Learn more about the supported Supervisor Services and how to download their service YAML files at http://vmware.com/go/supervisor-service.

Note: Supervisor Services are supported on single-cluster Supervisors that run on either VDS or NSX networking stacks. You cannot deploy Supervisor Services on three-zone Supervisors.

Prerequisites

• Add a new Supervisor Service or a newer version of and existing service to vCenter Server. See Add a Supervisor Service to vCenter Server or Add a New Version to a Supervisor Service.
• Verify that you have the Manage Supervisor Services privilege on the vCenter Server system that hosts the Supervisor where you install the service.
• If the Supervisor Service requires persistent storage, configure the vSAN Data Persistence platform. See Using vSAN Data Persistence Platform with Modern Stateful Services.

Procedure

1. From the vSphere Client home menu, select Workload Management.
2. Select Services.
3. In the card of the Supervisor Service that you want to install, select Actions > Install on Supervisors.
4. Select the Supervisor Service version.
   Note: You cannot install Supervisor Service versions that are Deactivated.
5. Select the Supervisor where you want to install the service.
6. In the YAML Service Config field, enter configuration properties if the service requires any.

   If you host service images in a private registry, you can fill in registryName, registryUsername, and registryPasswd properties here as well.

7. View the installation progress for the service on Supervisors.
   1. Select the Supervisor tab and select a Supervisor where you install the service.
   2. Click Configure and click Supervisor Services > Overview.
   3. Select the Installed tab.

Results

The Supervisor Service is in Configuring state, which means that all the necessary resources are being created in the Supervisor and the service YAML is being applied to the cluster. Once the YAML is successfully applied to the Supervisor with all its resources and namespace created or updated, the service state changes to Configured. The service is available to all the namespaces in that cluster and DevOps engineers can use it with their workloads.

Note: When installed on Supervisors, Supervisor Services are deployed as a set of vSphere Pods. These vSphere Pods are used only by the respective Supervisor Services they are part of. Deploying vSphere Pods for generic use is supported only on single-cluster Supervisors configured with the NSX networking stack.

Note:

The Supervisor is not monitoring if the Supervisor Service is actually working. For example, if you have specified incorrect registry user name or password, the service might not be able to fetch any of the images that it needs to run. This way, the service might show as Configured but it's not actually working. To confirm if the Supervisor Service is working or not, check the service namespace and the running pods.

What to do next

Configure the Supervisor Service by using the interface. See where to find it at Access the Management Interface of a Supervisor Service on the Supervisor Cluster.