Integrate with OpenStack Heat services

Last published : Sep 21, 2026
The OpenStack Neutron LBaaS enables core load balancing services, such as load balancing, SSL offloading, and content switching, for applications. LBaaS is managed through a REST API, and the API allows tenants to make REST calls to create, update, and delete LBaaS objects. Because LBaaS provides load balancing services, it does not allow use of the more advanced NetScaler features during the orchestration process. The NetScaler Heat plug-in overcomes this limitation.

Heat Orchestration Service

The OpenStack Heat orchestration service allows deployment of complex cloud applications on the basis of templates. The Heat orchestration template (HOT) describes the infrastructure for a cloud application in text files that are readable and writable by humans, and can be managed by version control tools. YAML, a structured language, is used to write these templates. The HOT template allows you to create most of the OpenStack resource types and specifies the relationships among the resources defined within it. The NetScaler Heat plug-in allows you to configure advanced application delivery controller (ADC) functionalities on any NetScaler instance.

NetScaler StyleBooks

NetScaler Application Delivery Management (ADM) StyleBooks can be used to create and configure NetScaler functionalities. Just like Heat templates, the StyleBooks are also written in YAML. A separate StyleBooks can be created for each functionality, and a single StyleBooks can be used to deploy configurations on multiple NetScaler instances.
During NetScaler integration with OpenStack, NetScaler ADM publishes all NetScaler ADM StyleBooks as a resource in the Heat service.  This includes both the StyleBooks that are shipped with NetScaler ADM and the StyleBooks that are created by the user at a later point of time.  The Heat template allows you to configure the advanced features of NetScalers using these StyleBooks resources.

Workflow to Configure NetScaler Instances using Heat

The following flowchart illustrates the workflow for deploying the Heat stack:
Workflow to configure ADC instances using Heat
Perform the following tasks as a cloud administrator:
To configure Heat services in OpenStack:
  1. Download NetScaler bundles for OpenStack
    Install the NetScaler bundles in OpenStack. In NetScaler ADM, navigate to Downloads and download the NetScaler driver bundles, untar the bundles, and copy the contents of the Heat folder in the bundle to the Heat engine resources directory in OpenStack. The directory path is as follows:             /opt/stack/heat/heat/engine/resources/netscaler_resources
  2. Create a section "netscaler_plugin" in the heat.conf file, and update the following parameters in that section:
    1. When the communication is HTTP, the parameters are updated as follows:
      NMAS_BASE_URI=<http://10.146.103.45:80>
      NMAS\_USERNAME=<openstack_driver_username>
      NMAS\_PASSWORD=<openstack_driver_password>
    2. When the communication is https, the parameters are updated as follows:
      NMAS_BASE_URI=https://common_name_used_in_certificate
      NMAS\_USERNAME=\<openstack\_driver\_username
      NMAS\_PASSWORD=\&lt;openstack\_driver\_password\>
      SSL\_CERT\_VERIFY=\&lt;True\_or\_False\>
      CERT\_FILE\_PATH=\&lt;path\_of\_the\_certificate\_file\>
      If user sets ssl\_cert\_verify to be "False," NetScaler ADM sends verify=False in the request calls, which disables the SSL certificate validation. If ssl\_cert\_verify is set to "True" and cert\_file\_path entry is present, NetScaler ADM sends this path in the verify parameter of request, otherwise NetScaler ADM sends verify=True.
      Note
      For deploying NetScaler ADM in "High Availability" mode, update the following parameters in heat.conf file:
      NMAS\_BASE\_URI=\&lt;IP address of the front-end virtual server\>
  3. Restart the Heat service in OpenStack.
    When you restart the NetScaler Heat services in OpenStack, all the defined NetScaler ADM StyleBooks are imported into Heat as resources. Also, the NetScaler network resource and the certificate resource are imported into OpenStack as NetScaler Heat resources.
  4. Register NetScaler® ADM with OpenStack.
    1. In NetScaler ADM, navigate to Orchestration \> Cloud Orchestration \> OpenStack, and click Configure OpenStack Settings.
    2. In Configure OpenStack Settings page, you can set the parameters to configure OpenStack. You have two options here: Default and Customized.
    3. Select Default if the OpenStack services are running on default ports. Enter the following parameters:
      1. OpenStack Controller IP Address
      2. Admin user name
      3. Password
      4. OpenStack Admin Tenant
      5. NetScaler Driver and Heat password
      Note
      This is the same password (NMAS\_PASSWORD) that you entered in the heat.conf file.
  5. Create service packages and define the SLAs with your tenant.
    A tenant is created in NetScaler ADM for each user during OpenStack registration, and the tenant information is used by both the LBaaS driver and the Heat plug-in. The Heat plug-in uses this information to contact NetScaler ADM to import StyleBooks as Heat resources in OpenStack.
    Note
    For more information about creating service packages and other pre-configuration tasks in NetScaler ADM and OpenStack, see Integrating NetScaler ADM with OpenStack Platform.
  6. Observe that all the relevant StyleBooks in NetScaler ADM are imported into OpenStack Heat as resources. Also, observe that the NetScaler network resource and NetScaler certificate resource are imported into OpenStack Heat as resources.
    Note
    Currently, you can use only the StyleBooks that are shipped with NetScaler ADM.
    Your tenant can now create the Heat template in OpenStack, enter the values of the required Heat parameters, and deploy the Heat stack. When the Heat stack is deployed, the configuration is pushed to NetScaler ADM, and the required NetScaler instances are configured.
To prepare Heat template and launch Heat stack:
  1. In OpenStack, the tenant can create a Heat orchestration template (HOT) by using the Heat resources.
  2. In OpenStack Horizon, the tenant admin can navigate to Project \> Orchestration \> Stacks to create the Heat template and launch the Heat Stack. There are two ways to create HOT:
    • File - Select the updated template from the local directory
    • Direct input - Copy and paste the YAML contents from the template in the window
    Note
    After successfully deploying the stack, the tenant can update the stack by using the Change Stack Template. But the subnet information and the virtual IP address (VIP) that was provided initially during creation of stack cannot be modified.
    After the tenant deploys the stack, navigate to Orchestration \> Cloud Orchestration \> OpenStack \> Requests in NetScaler ADM to observe the lists of tasks. Also, navigate to Applications \> Configuration in NetScaler ADM to observe that the NetScaler instances are successfully configured in the form of StyleBooks configuration packs.
An Example of a NetScaler ADM StyleBooks:
The following image shows an example of how a NetScaler ADM StyleBooks is constructed and briefly explains the components. For more information about NetScaler ADM StyleBooks and how to use the shipped StyleBooks, see StyleBooks.
Example StyleBooks
An Example of a Heat Template:
The following image shows the structure of a Heat template defined in YAML, and points to the StyleBooks resources and NetScaler network resources that are imported as Heat resources.
Example Heat template
For more information about Heat services and how to create templates, see OpenStack Heat documentation.