Federated Architecture for Google Cloud Platform: Download and Deploy the Horizon Edge Gateway

You can download and deploy the Horizon Edge Gateway into your Horizon 8 federated deployment in Google Cloud Platform (GCP) to pair with Horizon Cloud.

Download and deploy the Horizon Edge Gateway appliance for an edge deployment that uses federated architecture for the Google Cloud GCVE solution. In the federated architecture, you must deploy Horizon Edge Gateway into the native Google Cloud Platform (GCP) infrastructure within your edge's environment.

The following is a high-level overview of the steps required to deploy Horizon Edge Gateway into the native GCP infrastructure within your pod's environment:

• Download the Horizon Edge Gateway TAR file.
• Create a Google Cloud Storage bucket and upload the appliance TAR to that bucket.
• Create a custom image from the uploaded TAR file.
• Create the Horizon Edge Gateway virtual machine (VM) instance from the custom image.

Prerequisites

You must meet the following prerequisites before continuing.

• Verify that you meet the Horizon Edge Gateway-related prerequisites described in Getting Started with a Horizon 8 Edge Deployment.

• Verify that you meet the Make Appropriate Destination URLs Reachable to Deploy a Horizon Edge Gateway in a Microsoft Azure Environment for using Horizon Edge Gateway to pair a Horizon 8 pod with Horizon Cloud.

• Verify that you are using the appropriate version of the Horizon Edge Gateway. See the Omnissa Product Interoperability Matrix.

• The Horizon Edge Gateway virtual appliance must reach the internet to communicate with the Horizon Control Plane. If your environment requires use of a proxy server and proxy configuration for deployed appliances to reach the Internet, verify that you have reviewed the proxy-related information, known limitations, and known issues when using proxy settings with the Horizon Edge Gateway appliance.

  Note: Update the proxy configuration in the Edge.

  /opt/horizon/bin/configure-edge-gateway.sh --configure-proxy --proxy-host 127.0.0.1 --proxy-port 3128 --proxy-username 'exampleUsername' --proxy-password 'examplePassword'
  
  

  To explore more options, run the script with -h option as shown below:

  /opt/horizon/bin/configure-edge-gateway.sh -h
  

• To use a proxy while pairing edge using configure-edge-gateway.sh script, you must first run the following command, specifying as true when ProxySSL is enabled and otherwise specifying as false:

  /opt/horizon/bin/configure-edge-gateway.sh -p 'Pairing_Code' -x -i 'IP_or FQDN_of Proxy' -r 'Proxy_Port' -m 'Proxy_User_Name' -a 'Proxy_Password' -s 'true_or_false'
  

• You can perform some of the deployment steps using either the Google Cloud graphical user interface (GUI) or the Google Cloud command-line interface (CLI). To use the CLI, you must first install the required components on your local system:

  • The gsutil tool. For instructions, see the Google Cloud Storage documentation.
  • The Google Cloud SDK. For instructions, see the Google Cloud SDK documentation.

Procedure

1. Download the Horizon Edge Gateway disk image by using the step to obtain the Horizon Edge Gateway Appliance binary in the middle of the procedure on page Add and Deploy a Horizon 8 Edge. Respond to all onscreen prompts.

   The Horizon Edge Gateway disk image/appliance is available as a TAR file. Download the TAR file to your local system as specified.

   Save the downloaded binary to a location from which you will deploy it into the desired virtualization platform and then return to this step sequence to continue the required pairing process.

   Note: To deploy the appliance into a GCVE environment, download the latest Horizon Edge Gateway disk image. We recommend that you use the latest version of the Edge Gateway appliance. For version information, see the Omnissa Product Interoperability Matrix.

   Before uploading the disk image file to your GCVE environment, you must first create a Google Cloud Storage bucket.

2. Create a Google Cloud Storage bucket in your GCVE environment. For detailed instructions, refer to the Google Cloud documentation.

3. Upload the downloaded TAR file to your Google Cloud Storage bucket. You can perform this step using either the Google Cloud graphical user interface (GUI) or the Google Cloud command-line interface (CLI).

   • (GUI) Log in to the Google Cloud Platform for your GCVE environment. Go to the Cloud Storage page, select the bucket that you created earlier, and upload the TAR file to that bucket.

   • (CLI) Open the gsutil console and run the following command.

     gsutil cp <file-path-to-TAR-file> gs://<bucket-name>
     

4. Create a custom image from the uploaded TAR file.

   • (GUI) In the Google Cloud Platform, go to the Compute Engine > Images page. Select the option to create an image. In the image creation page, specify Cloud Storage as the source and browse to the uploaded TAR file in your bucket. Specify other image properties as appropriate and then proceed to create the image.

     Verify that the new image appears in the Images list.

   • (CLI) In the gsutil console, run the image creation command, similar to the following example.

     gcloud compute --project <project-name> images create <image-name> --description <image-description> --source-uri <TAR-file-uri>
     

     Note: You can customize the command with appropriate parameters as needed. For detailed information, see the Google Cloud SDK reference documentation.

5. To support the creation and configuration of the Horizon Edge Gateway VM instance, prepare a startup script similar to the following example.

   #! /bin/bash
   /opt/horizon/bin/configure-adapter.py --sshEnable
   echo -e '<password>\n<password>' | passwd admin
   echo -e '<password>\n<password>' | passwd ccadmin
   echo 'cs_ip cs_fqdn' >> /etc/hosts
   

   In the example, the script supports the following configurations:

   • Enablement of SSH access to the Horizon Edge Gateway appliance.
   • Creation of an admin user account on the appliance with the defined password (\n). Ensure that you define a strong password.
   • Creation of a ccadmin user account on the appliance with the defined password (\n). Ensure that you define a strong password.
   • Resolution of the Connection Server host name (cs_fqdn) to the Connection Server IP address (cs_ip).

6. Create the Horizon Edge Gateway VM instance from the custom image. Ensure that you configure a minimum of n2-standard-8 for the VM sizing or machine type.

   • (GUI) In the Google Cloud Platform, go to the Images page, select the custom image that you created earlier, and select the option to create a VM instance. Specify a minimum of n2-standard-8 for the VM sizing or machine type, designate the custom image as the boot disk, and add the startup script that you prepared earlier. Specify other VM properties as appropriate and then proceed to create the VM instance.

     Verify that the Horizon Edge Gateway VM appears in the list of VM instances.

   • (CLI) In the gsutil console, run the instance creation command, similar to the following example.

     gcloud compute --project <project-name> instances create <instance-name> 
     --zone <zone> --machine-type <n2-standard-8-minimum> --network <network> 
     --subnet <subnet> --maintenance-policy <maintenance-policy> --scopes <scope> 
     --image <custom-TAR-image> --metadata startup-script=<startup-script>
     

     Note: You can customize the command with appropriate parameters as needed. For detailed information, see the Google Cloud SDK reference documentation.

7. After the Horizon Edge Gateway VM starts up, edit the configuration of the VM instance and remove the startup script.

   Important: You must remove the startup script from the instance to prevent the script from running every time the Horizon Edge Gateway reboots.

8. SSH to the Horizon Edge Gateway VM GCP instance.

   For related information, see Enable SSH Access for Horizon Edge.

   See the Google Cloud documentation for details about connecting to your instance. We recommend SSH to allow copy-paste of the pairing key.

9. Run a pair edge script using the following command format, where pairing_code is the pairing code that you copied from the Deploy and Pair Horizon Edge Gateway step in the middle of the procedure described in Add and Deploy a Horizon 8 Edge.

```

sudo su -
/opt/horizon/bin/configure-edge-gateway.sh -p <pairing_code>
```

11. To improve security, consider deactivating SSH when you have completed these steps.

12. Go back to the Horizon Universal Console to complete the configuration of the Horizon Connection Server detail. See Add and Deploy a Horizon 8 Edge.