Product Documentation

Pre-configuration tasks in Citrix ADM and OpenStack

This section assists you to perform the pre-configuration tasks before you configure Citrix Application Delivery Management (ADM) and OpenStack.

Installing Citrix ADM

Install Citrix ADM on a supported hypervisor. For more information on how to download and install Citrix ADM, see Deploying Citrix ADM.

Installing the Citrix ADC driver software and registering Citrix ADM on OpenStack

Download the Citrix ADC bundle for OpenStack from the Citrix ADM Downloads page.

To install Citrix ADC driver on OpenStack platform using Citrix ADM GUI:

  1. In Citrix ADM, click Downloads. The Downloads page in Citrix ADM provides you links to download Citrix ADC bundle for OpenStack software required for Newton, Ocata, and Pike OpenStack versions.

  2. Download the latest Citrix ADC bundle tar file to a temporary directory (for example, /tmp) in OpenStack Controller.  This bundle includes the LBaaS V2 driver and Heat plug-in for all OpenStack releases.

    localized image

  3. Run the following command to extract the files from the Citrix ADC driver tar file: tar -xvzf <name_of_tar_file>

  4. If you have an OpenStack <Release Name> setup, at the prompt, type the following command:

    cd <Release Name>

    Example:

    cd Newton

  5. Run the following command to install the driver and specify the Citrix ADM IP address, the Citrix ADC driver password that you configured when you registered OpenStack with Citrix ADM, and the protocol:

    ./install.sh --ip=<NetScaler_MAS_IP> --password=<password> --protocol=<protocol> --neutron-lbaas-path <neutron-lbaas-directory-path>

    Example for single node OpenStack setup:

    ./install.sh --ip=10.102.29.90 --password=xxxx --protocol=HTTP --neutron-lbaas-path=/opt/stack/neutron-lbaas

    Example for multinode OpenStack setup:

    ./install.sh --ip=10.102.29.90 --password=xxxx --protocol=HTTP --neutron-lbaas-path=/usr/lib/python2.7/site-packages

    Note

    Providing the path of the neutron-lbaas directory of the system is optional. Providing the path might assist the script to find the drivers.

    After Citrix ADM is registered successfully on OpenStack, you can log on to Citrix ADM using your OpenStack user credentials also.

    After Citrix ADM is registered successfully on OpenStack, restart the OpenStack Neutron services.

Registering OpenStack with Citrix ADM

To register OpenStack with Citrix ADM using Citrix ADM GUI:

  1. In Citrix ADM, navigate to OrchestrationCloud Orchestration > OpenStack.

  2. Click Configure OpenStack Settings.

  3. In Configure OpenStack Settings page, you can set the parameters to configure OpenStack in Citrix ADM. You have two options here - Default and Customized.

    For Newton and Ocata releases of OpenStack, you can use either default or customized deployment type. But for Pike release, you must use customized deployment type to register OpenStack with Citrix ADM.

  • Default Deployment Type

    Select Default, if the OpenStack services are running on default ports. For example, the default portal for Neutron services is 9696, the default portal for Keystone services is 5000.

  1. OpenStack Controller IP Address - IP address of the OpenStack controller (both the KeyStone service and the Neutron service should be reachable on this IP address). For example, enter the IP address 10.102.205.23.

  2. OpenStack Admin Username - administrative username of the OpenStack controller. For example, enter admin1.

  3. Password - password of the administrative user of the OpenStack controller.

  4. OpenStack Admin Tenant - the name of the administrative tenant on OpenStack. For example, enter admin.

    localized image

  • Customized Deployment Type

    Select deployment type as Customized if the OpenStack services are running on ports different from the default ports. If these services are running on different ports, specify them here. Registering OpenStack Newton and Ocata releases with Citrix ADM is different from registering OpenStack Pike release.

    Newton and Ocata Release of OpenStack:

    1. Specify the port numbers for the various OpenStack services if you are registering Newton release of OpenStack.

    2. Specify the OpenStack Admin username, password, and OpenStack Admin Tenant username as you had specified earlier in the Default settings.

      localized image

    Pike Release of OpenStack:

    If you are registering the Pike release of OpenStack enter the details of the OpenStack services as shown in the following image. You must also specify the OpenStack Admin username, password, and OpenStack Admin Tenant username as in Default settings.

    localized image

  1. In OpenStack Neutron LBaaS - Credentials Used by Citrix ADC Driver section, set the Citrix ADC Driver Password for the OpenStack Citrix ADC driver user account. Citrix ADM authenticates the calls from the OpenStack Citrix ADC driver by using these credentials. You must specify the same password when you execute the Citrix ADC driver installation script in the OpenStack controller.

    localized image

  2. Click OK.

Creating a tenant on OpenStack

Create a project or a tenant on OpenStack, add users to the project or tenant, and assign roles to all of the users. KeyStone, the Identity service in OpenStack provides authentication services for each OpenStack service. The authentication service uses a combination of domains, projects (tenants), users, and roles.

For more information on how to create a project, and to perform other tasks in OpenStack, see the OpenStack documentation at http://docs.openstack.org/.

Adding OpenStack tenants

  1. In Citrix ADM, navigate to OrchestrationCloud Orchestration > OpenStackOpenStack Tenants, and then click Add.

  2. In Add OpenStack Tenants page, click +Add, and then select the OpenStack tenant.

  3. Click OK.

Based on whether you are using pre-provisioned instance or auto-provisioning the instance when you are integrating the OpenStack, follow one of these two tasks:

  • Pre-provision the Citrix ADC Devices

  • Auto-provision the Net Scaler VP X devices on OpenStack

Provisioning Citrix ADC devices

Based on whether you are using pre-provisioned instance or auto-provisioning the instance when you are integrating the OpenStack, follow one of these two tasks:

  • Pre-provision the Citrix ADC Devices

  • Auto-provision the Net Scaler VP X devices on OpenStack

Pre-provisioning Citrix ADC devices

Install the Citrix ADC device on any of the hypervisor platforms like XenServer, KVM, or ESX, and add the instance to Citrix ADM. Citrix ADM then manages this device that load balances the traffic in the servers.

To add an existing Citrix ADC VPX instance in Citrix ADM:

  1. In Citrix ADM, navigate to InfrastructureInstancesCitrix ADC VPX, and then click Add.

  2. On the Add Citrix ADC VPX page, specify the IP address of the Citrix ADC VPX instance and select an instance profile from the Profile Name list. The instance profile contains the credentials used to logon to the Citrix ADC VPX. You can also create a new instance profile by clicking the + icon. Click OK.  

Autoprovisioning Citrix ADC devices

Download the required Citrix ADC instance image from the Citrix download page, and upload it on Glance, the OpenStack Imaging service. Having an image available on Glance allows you to configure a Citrix ADC instance on-demand when assigning the instance to the tenant.

To auto-provision the Citrix ADC VPX devices on OpenStack:

  1. In Citrix ADM, navigate to Orchestration > Cloud Orchestration > OpenStack.

  2. Click Deployment Settings.

  3. Set the following parameters:

    1. Management Network - select the management network on OpenStack, to which the auto-provisioned Citrix ADC VPX is connected.

    2. Profile Name - select the profile from the drop-down list. The Citrix ADM uses the password contained in this profile to configure new auto-provisioned Citrix ADC VPX instances.

    3. Licenses - provide the Citrix ADM license activation codes (LAC) used to license new auto-provisioned Citrix ADC instances. Citrix ADM provisions Citrix ADC instances on OpenStack compute in management network, then triggers license installation on them using the specified license code. The Citrix ADC instance then downloads the license files from Citrix website using the LAC specified here.

    4. Citrix ADC VPX Image in Glance - select the Citrix ADC VPX image available in the OpenStack Glance that is used to create a Citrix ADC VPX instance.

    5. Proxy Settings - provide details of Citrix ADC proxy server for installing licenses. This may be required when Citrix ADC does not have direct access to the Internet through the management network.

  4. Click OK.

    localized image

Creating a service package in Citrix ADM

To create service packages for a tenant in Citrix ADM:

  1. In Citrix ADM, navigate to Orchestration > Cloud Orchestration > OpenStack > Service Packages, and then click Add.

  2. On the Service Package page specify the following parameters:

    1. Name - name for the service package. For example, enter SVC-PKG-GOLD.

    2. Citrix ADC Instance Allocation - the type of instance allocation defined in the service package based which Citrix ADC instance resources are allocated to a tenant. Select Dedicated. For more information on policies, see Service Package Isolation Policies.

    3. Citrix ADC Instance Provisioning - select Existing Instance to allocate an existing Citrix ADC instance to a tenant. If you want to create Citrix ADC instances during the configuration itself, select Create Instance OnDemand.

    4. Citrix ADC Instance Type - select Citrix ADC VPX.

    Note

    Select Citrix ADC VPX to allocate pre-provisioned Citrix ADC instances hosted on SDX platform.

  3. Click Continue to associate a tenant with a service package.

    Note

    Enable Provision pair of Citrix ADC instances for high availability, if you are deploying the Citrix ADC instances in high availability mode.

  4. In Assign Instances section, click Add, and then select the Citrix ADC instance that you want to assign to the tenant, and click Continue.

  5. In Assign OpenStack Tenants/Placement Policies section, under OpenStack Tenants, click Add, and select the tenant.

  6. Click Continue, and then click Done.

Note

If the policy is not found, the fallback mechanism is revived, and the Citrix ADM assigns Citrix ADC instances based on tenants. If the tenant is not part of any service package, the Citrix ADM displays an error message that says: “Tenant <admin> is not part of any Service Package and there is no default Service Package.”

Creating placement policies (optional)

Isolation Policies are not tenant-based only. You can create flexible placement policies, where the policies are not only based on tenant name or id, but on other custom attributes also.

To create placement policies for a tenant in Citrix ADM:

  1. In Citrix ADM, navigate to Orchestration > Cloud Orchestration > OpenStack > Placement Policy, and then click Add.

  2. On the Add Placement Policy page, set the following parameters:

    1. Name - type a name for the placement policy

    2. Sample Expressions - select a sample expression from the list. These examples are helpful to construct the placement policy.

    3. Expression - a Boolean expression is populated in this field based on the sample expression that you have selected in the earlier field. Edit the field names as required.

  3. Click OK.

Enabling traffic from Citrix ADC instances to backend servers through client network

By default, in the OpenStack orchestration workflow, Citrix ADC instances are dynamically bound to the load balancer or client networks and member or server networks.

In certain deployments servers are also reachable through client networks and can be routed through the client gateway. In such cases, the Citrix ADC instances need not be bound to server networks, but they need to be bound only to client networks.

Perform the following setting to configure traffic through client gateway.

Navigate to Orchestration > Cloud Orchestration > OpenStack > Deployment Settings, and then select the Provision only VIP network and route pool traffic through VIP network option.

Citrix ADM then configures the Citrix ADC instance to client networks by adding a SNIP in that network, and will further add a default route to the client network gateway. This enables the instance to reach the servers through the client gateway.

Auto-provisioning Citrix ADC VPX devices deployed on Citrix ADC SDX platform

Add the Citrix ADC SDX platform in Citrix ADM, so that Citrix ADM provisions the instances on this platform on-demand.

To auto-provison Citrix ADC instances deployed on Citrix ADC SDX platform:

  1. In Citrix ADM GUI, navigate to NetworksInstancesCitrix ADC SDX, and click Add to add a Citrix ADC SDX platform.

  2. Navigate to OrchestrationCloud Orchestration > OpenStackDeployment Settings.

  3. In Management Network section, select the management network on OpenStack to which the auto-provisioned Citrix ADC SDX is connected.

    1. In Profile Name, select the profile from the drop-down list. The Citrix ADM uses the password contained in this profile to configure new auto-provisioned Citrix ADC VPX instances.

    2. Click OK.

  4. To provision the Citrix ADC SDX platform in OpenStack, navigate to OrchestrationCloud Orchestration > OpenStackService Package.

    1. Click Add to create a new service package.

    2. Enter the name of the service package.

    3. In Citrix ADC Instance Allocation field, select Dedicated.

    4. In Citrix ADC Instance Provisioning field, select Create Instance OnDemand, and in Auto Provision Platform field, select Citrix ADC SDX.

    5. By default, only Citrix ADC VPX instances are provisioned on Citrix ADC SDX platform.

    6. Click Continue.

    7. In Auto Provision Settings section, set the Resources properties.

      1. Throughput field. Enter 1000 Mbps.

      2. Citrix ADC Version field. From the list, select the right version of the Citrix ADC VPX image present on the Citrix ADC SDX platform.

    8. In Citrix ADC SDX Platforms section, click Add to add the SDX platform to the service package.

    9. Click Continue.

    10. In Configure OpenStack Tenants section, click Add to add the  tenants. You can also add new tenants by clicking New.

    11. Click Done.

  5. LBaaS V2 API implementations are performed through Neutron LBaaS commands. Connect to any Neutron  client and execute the configuration tasks. For more information on how to execute configuration commands, see Configuring LBaaS V2 using Command Line.