NetScaler ingress controller

Deploy NetScaler API Gateway using Red Hat OpenShift Operators

OpenShift Operator is an open-source toolkit designed to package, deploy, and manage Kubernetes native applications in a more effective, automated, and scalable way.

An API gateway acts as the single entry point for your APIs and ensures secure and reliable access to multiple APIs and microservices in your system. NetScaler provides an enterprise grade API gateway for North-South API traffic into the OpenShift cluster. The API gateway integrates with the OpenShift cluster through the NetScaler Ingress Controller and the NetScaler (NetScaler MPX, VPX, or CPX) deployed as the Ingress Gateway for on-premises or cloud deployments.

This topic covers information on how to deploy the API gateway using OpenShift Operators.

The NetScaler API Gateway operator installs the CRDs required for the API Gateway functionality. Since this operator leverages the NetScaler Ingress Controller, you need to create an instance of the API Gateway CRD, which is the NetScaler Ingress Controller. If you already have a NetScaler Ingress Controller instance in the cluster you need to install it again.

API gateway supports the following CRDs:

  • Auth CRD (

    Authentication policies are used to enforce access restrictions to resources hosted by an application or an API server.

  • Content routing CRDs ( and

    Kubernetes native Ingress supports only basic host and path based routing. Using content routing CRDs, you can expose the advanced content routing abilities provided by NetScaler ADC like routing based on header values or query strings.

  • Rate limit CRD ( In a Kubernetes deployment, you can rate limit the requests to the resources on the back end server or services using the rate limiting feature provided by the ingress NetScaler.

  • Rewrite and responder CRD ( In a Kubernetes environment, to deploy specific layer 7 policies (such as redirecting HTTP traffic to a specific URL) requires you to add appropriate libraries within the microservices and manually configure the policies. Instead, you can use the Rewrite and Responder features provided by the Ingress NetScaler device to deploy these policies.

  • VIP CRD (

    NetScaler provides a VIP CRD for asynchronous communication between the IPAM controller and the NetScaler Ingress Controller. The IPAM controller is provided by NetScaler for IP address management.

Deploy NetScaler API Gateway using OpenShift Operator

Perform the following steps to deploy the API gateway using the OpenShift Operator.

  1. In the OperatorHub, search for NetScaler API Gateway Operator.

    OpenShift Operator Install

  2. Select the NetScaler API Gateway Operator, and click Install.

    OpenShift Operator Install

  3. Choose the namespace where you want the operator to be installed and click Subscribe.

    OpenShift Operator Install

  4. Once the NetScaler API Gateway operator is installed, you can see it listed under the Installed Operators section on the left panel. At this point, all CRDs are installed in the cluster. OpenShift Operator Install

  5. To create instances of each CRD, select the appropriate CRD and click Create Instance. OpenShift Operator Install

  6. Once you create the instance you can see all your instances by selecting the All instances tab. OpenShift Operator Install

Update the CRD instance

To update any values of the created CRD instance, click the instance and go to the YAML tab and edit the YAML file and click Save.

OpenShift Operator Install

Upgrade CRD versions

For more information on upgrading CRD versions, see the OpenShift documentation.

Delete the instance and operator

To delete an instance of the CRD you have to delete the NetScaler Ingress Controller instance from the user interface. Select the three vertical dots on the right side of the instance as shown in the following image and then click Delete CitrixIngressController.

OpenShift Operator Install

To delete the operator, click the Actions drop-down list and then click Uninstall operator.


Make sure that all instances are deleted manually before uninstalling the operator. The instances are not automatically deleted if you uninstall the operator.

OpenShift Operator Deletion

Deploy NetScaler API Gateway using Red Hat OpenShift Operators