This list is a high-level overview of the steps when you are onboarding your very first pod to the control plane and that pod is an existing Horizon pod that you have already stood up using one of the supported deployment architectures. A Horizon pod is based on the Horizon Connection Server software.
The following diagram illustrates the overall flow.
Reasons for Onboarding
You onboard Horizon pods to the cloud for two primary use cases: to activate a subscription license for that pod and to activate your use of those cloud-hosted services that the cloud plane provides for Horizon pods, such as the Cloud Monitoring Service (CMS). The CMS is one of the central services provided in Horizon Cloud. The CMS provides for visibility, health monitoring, and help desk services with cloud-connected pods.
After you complete these onboarding steps for your very first cloud-connected pod, the subscription license takes effect for that onboarded pod. You can also start using the cloud-hosted services that the control plane provides for that pod type, which include the Cloud Monitoring Service (CMS). At that point, you can also onboard additional pods.
Have the Pod All Ready Before You Begin
Before beginning this workflow, you must have a Horizon pod deployed already, using one of the supported deployment designs. Obtain specific pod-deployment steps from the following resources.
- Fulfill the prerequisites, which include obtaining a Horizon subscription license, such as the Horizon universal license. For a high-level description of the process of onboarding a pod to the cloud control plane, also see Horizon Cloud Deployments and Onboarding Pods.
- Verify you meet the DNS, ports, and protocol requirements for connecting a Horizon pod with Horizon Cloud. See DNS, Ports, and Protocols Requirements When Using Horizon Cloud Connector and a Horizon Pod.
- If your environment requires the use of a proxy server for the Horizon Cloud Connector virtual appliance to reach the Internet, obtain the required proxy settings so that you can specify them when you deploy the appliance into your pod's environment.
- Optionally log in to the Horizon Cloud tenant portal and configure more administrators for your tenant environment.
Tip: Even though you can complete the next steps to onboard the pod solely using the My VMware account that is the one initially associated with your tenant environment, it is prudent to configure more administrators at the start of this process. If only a single My VMware account is associated with your tenant account and you lose your access to the credentials, delays might occur because you must open a service request with VMware to associate a new My VMware account with the tenant account. To prevent such delays, log in to the tenant portal at cloud.horizon.vmware.com with the initially associated My VMware account and then follow steps described in Add Administrators to Log in to Your Horizon Cloud Tenant Environment using the row in the General Setup section of the screen.
- Deploy the Horizon Cloud Connector virtual appliance into the pod's environment. Follow the steps from Download and Deploy the Horizon Cloud Connector.
Note: If you deploy Horizon Cloud Connector 1.9 and want to enable the use of Horizon Cloud services such as the CMS, you must select the Full Feature profile during deployment.
- After the virtual appliance is powered up, enable SSH access to the virtual appliance to remotely run commands in the appliance's operating system. Follow the steps in Enable SSH Access to the Horizon Cloud Connector Using a Command Line Interface.
Note: Those steps to enable SSH are used for the time when the pod is not yet successfully paired with Horizon Cloud. After the pod is successfully paired with Horizon Cloud, then you will be able to use the browser-based Horizon Cloud Connector's configuration portal to activate and deactivate SSH access to the virtual appliance.
- If your environment requires use of a proxy and you did not specify proxy-related settings in the OVF deployment wizard, configure the proxy-related settings for the virtual appliance. See Modifying Proxy Settings for Horizon Cloud Connector 1.6 or Later for more details.
- If you want to access the browser-based Horizon Cloud Connector configuration portal using a fully qualified domain name (FQDN) instead of using the Horizon Cloud Connector virtual appliance's IP address, create a forward and reverse lookup record in your DNS server that maps an FQDN to the virtual appliance's IP address.
- Verify the health of the pod's system components and services by opening an SSH session to the Horizon Cloud Connector virtual appliance and running the
precheck.shdiagnostics script. See Verify the Horizon Pod and Virtual Appliance Are Ready to Be Paired with Horizon Control Plane for more details.
- Using either a mapped FQDN or the virtual appliance's IP address, log in to the browser-based Horizon Cloud Connector configuration portal and complete the onboarding steps that pair the connector with the pod's Connection Server. Follow the steps described in Complete Pairing the Horizon Pod with Horizon Cloud Using the Horizon Cloud Connector Configuration Portal.
Tip: When the connector and Connection Server are successfully paired, the Horizon Cloud Connector configuration portal will display a Congratulations message. At this point, VMware will activate your subscription license. The activation is typically completed after 30 minutes but can take up to 4 hours in some cases. When the license is activated, you will see the message Connected to License Service in your pod's web-based console's Product Licensing & Usage screen.
- Depending on your team standard practices and environment, optionally configure the Horizon Cloud Connector virtual appliance in areas such as configuring a CA-signed certificate and setting a password expiry for the appliance's root user. For a list of such typical tasks and links to steps, see Typical Administrative and Maintenance Tasks for a Paired Horizon Cloud Connector.
- Register your Active Directory domain with the deployed pod, which includes providing the names of service accounts. Ensure these service accounts meet the requirements described in Service Accounts That Horizon Cloud Requires for its Operations
Tip: Completing the Active Directory domain registration workflow enables you to take advantage of all the cloud-hosted services, such as the Cloud Monitoring Service (CMS). Until the pod's Active directory domain is registered with your tenant environment, the areas of the console involving those features are inaccessible.
- In the rare, atypical situation where your tenant environment already has Horizon Cloud pods in Microsoft Azure that are running manifests older than manifest 1600.0, you must give the Horizon Cloud Super Administrators role to an Active Directory group that includes the domain join account as a member. See the topic Assign Horizon Cloud Administrative Roles to Active Directory Groups in the Administration Guide.