EnglishFrançaisDeutschEspañolItaliano日本語한국어NederlandsPortuguês (Brasil)中文 (简体)中文 (繁體, 台灣)
Skip to main content

2 september 2026

Add and Deploy a Horizon Edge for OpenStack

You can add and deploy a Horizon Edge for Horizon Cloud on OpenStack capacity types (Customer deployment or Platform9 Private Cloud Director). You can then configure the Unified Access Gateway (UAG) for the Edge.

Note: Horizon Cloud on OpenStack is currently available in Limited Availability (LA) mode only.

General Prerequisites

Configure prerequisites for the Horizon Cloud service, the Unified Access Gateway (UAG), and Private Cloud Director.

Private Cloud Director Prerequisites

If you are creating a Horizon Edge for OpenStack using the Platform9 capacity type, ensure that you have access to a local installed instance of Private Cloud Director (PCD) or a SaaS instance of PCD. The currently supported versions are:

  • OnPrem Multi Node: PCD 2025.6-151
  • SaaS Multi Node: PCD 2025.8-112

Identity Access - User and Application Credentials

Ensure that your user credentials provide appropriate identity access. You'll need a valid user account for the target tenant/project with at least admin role to allow resource creation and other operation tasks in PCD.

Also ensure that the account belongs to the appropriate domain. Domain scope is essential for successful keystone authentication.

  1. Define environment variables to define scope.

  2. Create an application credential using the OpenStack Platform9 CLI. Sample syntax is shown below. For related information, see Application Credentials in Red Hat documentation.

    openstack application credential create \
--role admin \
--description "credential with admin privileges" \
my-admin-appcred

  3. Use --role admin to assign the admin role for full project-level operations.

  4. Ensure that the credential is created under the correct domain and project scope.

  5. Save the generated Application Credential ID and Secret securely. You will use these to create the provider Edge later.

  6. Verify that the Web download method for image creation is enabled.

Prepare KVM Host

Prepare your KVM host using OpenStack Platform9 recommendations. Ubuntu LTS 22.04 is currently the supported OS for the KVM Host. For more information, see Hypervisor Host Prerequisites in Platform9's Private Cloud Director product documentation.

  1. Ensure that you have access to at least one cluster with a minimum of 3 KVM hosts.

  2. Ensure that the storage option in the deployment is supported for OpenStack Platform9. See Supported storage drivers in Platform9's Private Cloud Director product documentation.

  3. Configure the Cinder Driver for storage as appropriate. See All About Cinder Drivers in OpenStack product documentation.

  4. For fast cloning, ensure that the array offload for XCOPY is configured in Cinder if the driver for the array offers the XCOPY feature.

Get OpenRC Parameters

Obtain the required OpenRC file parameter as described below. The OpenStack openrc file is often named PROJECT-openrc.sh and is a Bash script used to set the environment variables that are needed for command-line tools to interact with your cloud project.

  1. Log in to Private Cloud Director (PCD) with your user credentials.

  2. Ensure that you have the correct Region and Project selected. If needed, click the Settings icon to select API Access.

  3. Navigate to the pcdctl RC section and enter the values for your OpenRC file. The needed pcdctl RC environment variables are shown below, with example values.

    export OS_USERNAME=admin@airct1.localnet
export OS_PASSWORD=<your-password>
export OS_AUTH_URL=https://pcd-region1.steslabs.ney/keystone/v3
export OS_AUTH_TYPE=password
export OS_IDENTITY_API_VERSION=3
export OS_REGION_NAME=Default
export OS_USER_DOMAIN_NAME=Default
export OS_PROJECT_DOMAIN_NAME=Default
export OS_PROJECT_NAME=PROD
export OS_INTERFACE=public

Machine and User Identity Prerequisites

See Requirements Checklist for Deploying a Horizon Cloud on OpenStack Edge and Identity and Access Management in Horizon Cloud in Getting Started with Horizon Cloud.

Networking, Load Balancer, and VM Prerequisites

See Configure Network Settings and Parent VM Setup for Horizon Cloud on OpenStack Edge Deployments in this Using and Managing Horizon Cloud guide.

Procedure - Creating the Edge Deployment using Self-hosted On Prem Access to the Control Plane

The Horizon Universal Console in Horizon Cloud makes the Add Horizon Edge UI page available from various entry points. Your starting point in the console for this step typically depends on whether your environment is greenfield or it has existing Horizon Edge deployments.

  • No Horizon Edges yet - If there are no Horizon Edges deployed in the environment yet, you usually start the process by clicking Start Deployment. The console then displays the Add Horizon Edge UI stepper page.

    Alternatively, you can start by clicking Capacity > Add > Platform9. The console then displays the Add Horizon Edge UI stepper page.

  • At least one Horizon Edge - If there is at least one Horizon Edge that has already been created and deployed in your Horizon Cloud environment, click Capacity > Horizon Edges > Add > Horizon Cloud > Platform9 from the Horizon Universal Console to open the Add Horizon Edge stepper page.

  1. Log in to Horizon Cloud. Specifically, go to https://connect.omnissa.com and open the Horizon Cloud tile.

  2. From the Horizon Universal Console UI, click Capacity > Horizon Edges in the left pane navigation. This example procedure will use the Platform9 capacity type selection.

  3. From the Horizon Edges tab, click Add and from the drop-down menu, select Horizon Cloud > Platform9.

    Note: You can select either Platform9 or OpenStack. If you are using Platform9 Private Cloud Director to provide the OpenStack infrastructure, then select Platform9. If you have any other generic or open-source software to self-deploy or self-manage the OpenStack infrastructure, then select OpenStack. In this example, we are assuming the use of Platform9 Private Cloud Director to provide the OpenStack infrastructure and so we will select Platform9.

  4. Respond to all subsequent UI stepper pages as described below.

Requirements

Review the requirements as shown, confirm that you have met the requirements, and then click Next.

Note: Be sure to download the Horizon Edge VM image from the link provided in this Requirements section and add the downloaded image to your OpenStack image repository before proceeding.

General Information

On the General Information page, enter a Horizon Edge name and description (optional) and then click Next.

Capacity Provider

On the Capacity Provider page, enter the following information and then click Next.

  1. For Platform type, specify the capacity type that your Edge Gateway will be deployed into. In this example, that is the OpenStack Platform9 SDDC that this Edge will connect to.

  2. For Management Console Location, select Self-hosted for on-prem or Saas-hosted for cloud-hosted deployments. In this example, we will select Self-hosted.

  3. For Keystone URL, enter the authorization URL as defined in the OS_AUTH_URL= setting of your openrc.sh file.

  4. For Location, choose the physical location that is closest to you from the list of available options. Begin entering the city where the OpenStack Platform9 SDDC is located and then select from the populated list.

  5. For Project domain name, enter the project domain name as specified in the OS_PROJECT_DOMAIN_NAME= setting of your openrc.sh file.

  6. For Project name, enter the project name as specified in the OS_PROJECT_NAME= setting of your openrc.sh file.

  7. For Region, enter the region name as specified in the OS_REGION_NAME= setting of your openrc.sh file. This specification is optional.

  8. For Credential Type, select either User credentials and then specify your User domain name, User name, and Password as defined in your openrc.sh file OR App Credentials and then specify the App ID, App Secret key value, and Thumbprint. For Thumbprint, enter the SHA-256 certificate thumbprint from the management console. Onscreen help is available.

Site

On the Site page, click Add New and respond to prompts or select an existing site from the drop-down menu and then click Next.

Horizon Edge Gateway - Self-Hosted

  1. On the Horizon Edge Gateway page, enter the following information and then click Next.

    • FQDN – Enter the fully qualified domain name (FQDN) for the Edge Gateway. The FQDN must be resolvable from VDI desktops.

    • Use SSO – Keep this option disabled if no SSO configurations exist yet. Otherwise, enable this option if an SSO configuration is already created and you want to associate it with this Edge.

    • SSO Configurations – This option becomes available if Use SSO is enabled. Begin entering the name of the desired SSO configuration, then select it from the list.

  2. Click Next.

    After you click Next, the Initiation of Horizon Edge Gateway creation in progress. It will take a few minutes to be completed. message appears informing you that initiation of Horizon Edge Gateway creation in progress. When initiation is complete, the next stepper page (Edge Gateway Appliance) appears. A summary page tells you when the initiation is complete. However, you must also wait until Platform9 VM instance deployment completes, which can take 20 minutes or so.

  3. On the Edge Gateway Appliance page, click Download to download the appliance.

  4. On the Edge Gateway Appliance page, click Download cloud-init YAML to download the needed cloud-init file.

  5. Open the cloud-init YAML file that you downloaded and add the following commands to enable SSH access and set the password for the admin user.

    • Note: In the cloud-init YAML code, replace FILL_IN_ADMIN_PASSWORD to enter a password of your choice for admin access.

    • Note: If a runcmd: section already exists in the file, append the following two list items under it rather than adding a second runcmd: key.

      runcmd:
  - [ '/bin/bash', '-c', '/opt/horizon/bin/configure-adapter.py --sshEnable' ]
  - [ '/bin/bash', '-c', "echo -e '<FILL_IN_ADMIN_PASSWORD>\n<FILL_IN_ADMIN_PASSWORD>' | passwd admin" ]

    Ensure the indentation of the two list items matches, as an invalid YAML file will cause SSH to remain disabled without displaying an error notification.

  6. Save the updated cloud-init YAML file and then click Next.

  7. On the Deploy and Pair Horizon Edge Gateway page, copy the pairing code and then click Finish.

    Save the pairing code as you will need to use it later in this procedure. This value is used to pair the Edge appliance with the Horizon Cloud console on first boot.

  8. Log in to the Platform9 Private Cloud Director console.

  9. In the left navigation pane, select Images under the Virtual Machines section.

  10. Click Upload and then browse to and select the QCOW2 image that you downloaded earlier.

  11. Specify a Name for the image and for Disk format, select QCOW2.

  12. Ensure that all the checkboxes are unchecked.

  13. Click Add Image to complete the upload process.

  14. While still in the Platform9 Private Cloud Director console, navigate to Virtual Machines > Virtual Machines > Deploy New VM and specify the following information as prompted:

    • Provide a Name for the Edge VM.
    • Select the Cluster where you want to deploy the Edge VM.
    • For Boot VM from, select New Volume.
    • Set the Volume Size to 40 GiB.
    • Select the appropriate Volume Type for your deployment.
    • Check the Delete Volume on VM Termination option.
    • Choose the QCOW2 image you imported in the previous step.
    • Click Next to proceed.

  15. In the Flavor Selection section, specify the following information and then click Next to proceed.

    • For Hot-plug Compatible, specify the disabled setting.
    • For GPU Compatible, specify the disabled setting.
    • For Flavor, select the recommended specification of 8 vCPU and 16 GB RAM.

  16. In the Networking section, select a network for your VM that meets the requirements outlined in the Ports and Protocols document and then click Next to proceed.

  17. In the Customize VM section, specify the following information and then click Deploy Virtual Machine to proceed.

    • For Number of VMs, specify 1.
    • For SSH key, select an applicable option from the drop-down menu.
    • For Server Group, select an applicable option from the drop-down menu.
    • Enable the Use Cloud-init option.
    • Copy and paste the cloud-init YAML content from the file that you saved earlier into the Cloud-init YAML code box.
    • Note: In the cloud-init YAML code, replace FILL_IN_PAIRING_CODE_FROM_ABOVE_STEP to enter the pairing code obtained from the Horizon Cloud console. This is the pairing code value that you obtained and saved earlier in this procedure.
    • Note: If you have not done this already in the cloud-init YAML code, replace FILL_IN_ROOT_PASSWORD to enter a password of your choice for root access.

  18. Optionally enable the Assign Security Groups toggle and specify security groups of your choosing.

  19. Disable the Set Migration Priority option.

  20. From the Horizon Cloud console, navigate to Capacity > Horizon Edges and click on the deployed Edge. If the deployment was successful, you should see green checkmarks for Agent Monitoring, Deployment Status, and Connectivity Status.

  21. After you create your Edge, you can configure your Unified Access Gateway (UAG). See Create a UAG Deployment for an OpenStack Edge.

Procedure - Creating the Edge Deployment using SaaS-hosted Cloud Access to the Control Plane

The Horizon Universal Console in Horizon Cloud makes the Add Horizon Edge UI page available from various entry points. Your starting point in the console for this step typically depends on whether your environment is greenfield or it has existing Horizon Edge deployments.

  • No Horizon Edges yet - If there are no Horizon Edges deployed in the environment yet, you usually start the process by clicking Start Deployment. The console then displays the Add Horizon Edge UI stepper page.

    Alternatively, you can start by clicking Capacity > Add > Platform9. The console then displays the Add Horizon Edge UI stepper page.

  • At least one Horizon Edge - If there is at least one Horizon Edge that has already been created and deployed in your Horizon Cloud environment, click Capacity > Horizon Edges > Add > Horizon Cloud > Platform9 from the Horizon Universal Console to open the Add Horizon Edge stepper page.

  1. Log in to Horizon Cloud. Specifically, go to https://connect.omnissa.com and open the Horizon Cloud tile.

  2. From the Horizon Universal Console UI, click Capacity > Horizon Edges in the left pane navigation.

  3. From the Horizon Edges tab, click Add and from the drop-down menu, select Horizon Cloud > Platform9.

    Note: You can select either Platform9 or OpenStack. If you are using Platform9 Private Cloud Director to provide the OpenStack infrastructure, then select Platform9. If you have any other generic or open-source software to self-deploy or self-manage the OpenStack infrastructure, then select OpenStack. In this example, we are assuming the use of Platform9 Private Cloud Director to provide the OpenStack infrastructure and so we will select Platform9.

  4. Respond to all subsequent UI stepper pages as described below.

Requirements

Review the requirements as shown, confirm that you have met the requirements, and then click Next.

General Information

On the General Information page, enter a Horizon Edge name and description (optional) and then click Next.

Capacity Provider

On the Capacity Provider page, enter the following information and then click Next.

  1. For Platform type, specify the capacity type that your Edge Gateway will be deployed into. In this example, that is the OpenStack Platform9 SDDC that this Edge will connect to.

  2. For Management Console Location, select Self-hosted for on-prem or Saas-hosted for cloud-hosted deployments. In this example, we will select Saas-hosted.

  3. For Keystone URL, enter the authorization URL as defined in the OS_AUTH_URL= setting of your openrc.sh file.

  4. For Location, choose the physical location that is closest to you from the list of available options. Begin entering the city where the OpenStack Platform9 SDDC is located and then select from the populated list.

  5. For Project domain name, enter the project domain name as specified in the OS_PROJECT_DOMAIN_NAME= setting of your openrc.sh file.

  6. For Project name, enter the project name as specified in the OS_PROJECT_NAME= setting of your openrc.sh file.

  7. For Region, enter the region name as specified in the OS_REGION_NAME= setting of your openrc.sh file. This specification is optional.

  8. For Credential Type, select either User credentials and then specify your User domain name, User name, and Password as defined in your openrc.sh file OR App Credentials and then specify the App ID, App Secret key value, and Thumbprint. For Thumbprint, enter the SHA-256 certificate thumbprint from the management console. Onscreen help is available.

Site

On the Site page, click Add New and respond to prompts or select an existing site from the drop-down menu and then click Next.

Horizon Edge Gateway - SaaS Hosted

On the Horizon Edge Gateway page, enter the following information and then click Save & Close.

  • FQDN – Enter the fully qualified domain name (FQDN) for the Edge Gateway. The FQDN must be resolvable from VDI desktops.

  • Flavor - Select a flavor size from the drop-down menu.

  • Volume Type - Select a volume type from the drop-down menu.

  • Agent Monitoring – Keep this option enabled.

  • Use SSO – Keep this option disabled if no SSO configurations exist yet. Otherwise, enable this option if an SSO configuration is already created and you want to associate it with this Edge.

  • SSO Configurations – This option becomes available if Use SSO is enabled. Begin entering the name of the desired SSO configuration and then select it from the list.

  • Management Network - Select your Platform9-specified management subnet from the drop-down menu of choices. You can open your Platform9 Private Cloud Director (PCD) application to explore details about these various network choices.

  • IP Address (optional - Enter an IP address or let the system assign the IP for you based on your network selection.

  • Network security groups - Select your Platform9-specified network security group from the drop-down menu of choices. You can open your Platform9 Private Cloud Director (PCD) application to explore details about these various security group choices.

  • Proxy - Optionally specify proxy settings for outbound traffic as part of this Edge deployment process. Editing or updating these proxy settings after Edge deployment is not currently supported. Proxy settings include name, host, port, type, username, and password as described in onscreen help.

  • Advanced - Open the Advanced section of the page to be provided with the options to specify a Service CIDR and a Pod CIDR. If you do not specify these values, the defaults are used, as described in onscreen help.

After you click Save & Close, the Initiation of Horizon Edge Gateway creation in progress. It will take a few minutes to be completed. message appears informing you that initiation of Horizon Edge Gateway creation in progress. When initiation is complete, the next stepper page (Edge Gateway Appliance) appears. A summary page tells you when the initiation is complete. However, you must also wait until Platform9 VM instance deployment completes, which can take 20 minutes or so.

After you create your Edge, you can configure your Unified Access Gateway (UAG). See Create a UAG Deployment for an OpenStack Edge.

Was deze pagina nuttig?

Feedback geven over dit onderwerp

Was dit onderwerp nuttig?

Vermeld geen persoonlijke of vertrouwelijke informatie.

Link genereren…