Citrix Application Delivery Management service

Service Graph - Simplified onboarding

The onboarding process of service graph is simplified in a single workflow by:

  • Configuring the Citrix ADM agent as a microservice in the Kubernetes cluster.

  • Completing the other workflows such as registering cluster, adding instances, and enabling licensing and detailed TCP and Web transactions.


    If you want to use an existing Citrix ADM agent or configure an on-premises ADM agent using a hypervisor, follow the procedures at Setting up service graph to populate the service graph.

  1. Navigate to Applications > Service Graph and select the Microservices tab.

    You can view the microservices cluster is not configured. Click the option to configure.

    Configure service graph

  2. Select Custom Deployment.

  3. Select the deployment type.

  4. Select Microservices as the application type.

  5. Click Next to set up the agent.

  6. In the Download Agent Microservice page, specify the following parameters:

    1. Application ID – A string id to define the service for the agent in the Kubernetes cluster and distinguish this agent from other agents in the same cluster.

    2. Password – Specify a password for CPX to use this password to onboard CPX to ADM through the agent.

    3. Confirm Password – Specify the same password for confirmation.


      You must not use the default password (nsroot).

    4. Click Submit.

  7. Click Download YAML File or Download Helm Chart.

  8. In the Kubernetes main mode, save the downloaded YAML file and run the following command to register the agent:

    kubectl create -f <yaml file>

    For example, kubectl create -f testing.yaml

    The agent is successfully created.

  9. Click Register Agent.

    Register agent

    The page loads for a few seconds and displays the registered agent.

  10. Ensure if the agent is present in the list and click Next.

    Registered agent list

  11. You must register the cluster. Click Add More Clusters and specify the following parameters:

    1. Name - Specify a name of your choice.

    2. API Server URL - You can get the API Server URL details from the Kubernetes main node.

      1. On the Kubernetes main node, run the command kubectl cluster-info.

        API Server URL

      2. Enter the URL that displays for “Kubernetes main is running at.”

    3. Authentication Token - Specify the authentication token. The authentication token is required to validate access for communication between Kubernetes cluster and Citrix ADM. To generate an authentication token:

      On the Kubernetes main node:

      1. Use the following YAML to create a service account:

        apiVersion: v1
        kind: ServiceAccount
          name: <name>
          namespace: <namespace>
      2. Run kubectl create -f <yaml file>.

        The service account is created.

      3. Run kubectl create clusterrolebinding <name> --clusterrole=cluster-admin --serviceaccount=<namespace>:<name> to bind the cluster role to service account.

        The service account now has the cluster-wide access.

        A token is automatically generated while creating the service account.

      4. Run kubectl describe sa <name> to view the token.

      5. To get the secret string, run kubectl describe secret <token-name>.

        Generate token

  12. Select the agent from the list.

  13. Click Create.

  14. In the Clusters page, the cluster information is displayed. Click Next.


  15. Configure the CPX and VPX instances, and click Next.

    Configure instances

  16. Click Next to auto-license the virtual servers and to enable detailed web and TCP transactions.

    Configure license and web transaction

  17. The configurations are complete. Select Service Graph and click Done.

    Service graph configuration complete

The Service Graph gets populated in approximately 15 minutes. Navigate to Applications > Service Graph and select the Microservices tab to view service graph.

Service Graph - Simplified onboarding