Application Delivery Management

Install a NetScaler Console agent OpenShift operator for NetScaler Console on-prem deployment

If you are using NetScaler Console on-premises, the container agent is used for several specific strategic and technical reasons. Some of the important reasons are:

  • Seamless Management of Cloud-Native Workloads - The primary reason for using the container agent is to manage NetScaler CPX (the containerized version of NetScaler).
  • Localized Control - The agent acts as a licensing proxy between your NetScaler Console on-prem and NetScaler CPX instances running inside a Kubernetes cluster.
  • Simplified Connectivity (Microservices Architecture) - If your NetScaler Console and your Kubernetes cluster are on different networks, the container agent acts as a secure “in-cluster” gateway.

Note:

NetScaler Console agent is supported for NetScaler Console on-prem deployments from NetScaler Console on-prem 14.1.60.x.

An operator is an open-source toolkit that enables you to deploy and manage the Kubernetes applications in an effective, automated, and scalable way. As an administrator, you can deploy an agent in the OpenShift cluster using the NetScaler® ADM Agent Operator.

Note:

An agent configured in the OpenShift cluster is not automatically upgraded by default.

Prerequisites

Before you deploy, ensure that:

  • You have the privileged security context constraints to control permissions for pods. For the agent, run the following command to get the privilege security context constraints to the service account:

     oc adm policy add-scc-to-user privileged -z adm-agent-serviceaccount
     <!--NeedCopy-->
    
  • Run the following command to create an agent login secret (loginsecret):

     oc create secret generic admlogin --from-literal=username=nsroot --from-literal=password=<NetScaler Console-agent-password> -n <namespace>
     <!--NeedCopy-->
    
  • Run the following command to create a secret for NetScaler Console Server (accessSecret) secret:

     oc create secret generic testonprem--from-literal=username=nsroot --from-literal=password=< NetScaler Console password> -n <namespace>
     <!--NeedCopy-->
    

Install the agent operator

  1. Log on to the OpenShift cluster console.

  2. Navigate to Operators > OperatorHub.

  3. In the search bar, provide the agent name and select the NetScaler ADM Agent Operator and then click Install.

    NetScaler agent operator

  4. In the Install Operator page, you have two options:

    1. All namespaces on the cluster (default) - Enables the agent operator to subscribe to all the namespaces available in the cluster and allows you to initiate the instance of agent operator from any namespace on the cluster.

    2. A specific namespace on the cluster - Enables the agent operator to subscribe to a selected namespace on the cluster and you can initiate the instance of agent operator only from the selected namespace.

      In this example, the agent operator is assigned to a namespace called Default. Select Automatic under Update approval, and click Install.

      NetScaler agent operator

      Wait until the agent operator is successfully subscribed.

      NetScaler operator ready to use

  5. Navigate to Workloads > Pods and verify that the netscaler-adm-agent-operator-controller pod is up and running.

  6. After the pod is up and running, you must see two instances for Console agent in the NetScaler ADM Agent Operator. Click NetScaler ADM Agent Operator On Prem to deploy agent.

    NetScaler Operator provided API

  7. Select the YAML view to update any parameters and then click Create.

    Note:

    Ensure that there is only one instance of agent per OpenShift cluster.

    The following three parameters are mandatory:

    • accessSecret: The secret named as testonprem is created.
    • AdmURL: The NetScaler Console IP address.
    • loginsecret: The secret named as admlogin is created.

    NetScaler Operator - Creates ADM agent on-prem

    NetScaler Operator - Creates ADM agent on-prem

  8. Navigate to Workloads > Pods and ensure that the agent pods are up and running.

    NetScaler Operator - Pods

Delete an agent instance

You can delete the instance of agent from the cluster by navigating to Operators > Installed Operators. In the NetScaler ADM Agent Operator tab, select the instance, and select Delete AdmAgentOnPrems from the list.

NetScaler Operator - Delete ADM agent on-prem

Uninstall the agent operator

If you want to uninstall the agent operator pod from the cluster, navigate to Operators > Installed Operators, and then select Uninstall Operator from the list.

NetScaler operator uninstall ADM agent on-prem

Install a NetScaler Console agent OpenShift operator for NetScaler Console on-prem deployment