Skip to main content
Install the CXDOT Collector in your Kubernetes cluster to collect telemetry data and send that telemetry data to Palo Alto Networks Cortex XCOR.

Supported environments and distributions

The CXDOT Collector supports Kubernetes clusters running in a Linux environment with either x86_64 (AMD64) or ARM64 architecture. The following Kubernetes distributions are supported:
  • Upstream Kubernetes (self-managed or on-premises)
  • Amazon EKS
  • Google GKE
  • Azure AKS

Prerequisites

Before installing the CXDOT Collector in a Kubernetes cluster, you must meet these prerequisites:
  • Your Kubernetes cluster must use Kubernetes version 1.31 or later.
  • You must have Helm version 3.8 or later installed.
  • You must have an API token from a restricted service account with a write-only scope.

Install

To install the CXDOT Collector in a Kubernetes cluster, follow these steps.
  1. Run the following kubectl command to create the cxdot namespace:
  2. Set your configuration schema version, Cortex XCOR tenant name, and cluster name in your Helm values file:
    values.yaml
    Replace the following values:
    • VERSION: The CXDOT Collector schema version to use (for example, v1.23).
    • TENANT: The name of your Cortex XCOR tenant.
    • CLUSTER: The name of the cluster where you’re installing the CXDOT Collector. This value gets added to your telemetry data as the k8s.cluster.name resource attribute.
  3. Set your API token by creating a Kubernetes Secret named cxdot-api-token with the following contents:
    Replace TOKEN with your Cortex XCOR API token. When you create your Secret, Kubernetes base64-encodes the value of stringData, then stores the encoded value in a field called data.
    If your API token is stored in an existing Secret with a different name, set config.apiTokenSecretName in your Helm values file to the name of that Secret. If your API token is stored in a key that isn’t named api-token, set config.apiTokenSecretKey to the name of that key.
  4. Run the following Helm command to install the CXDOT Collector in your Kubernetes cluster:
    Replace VERSION with the version of the CXDOT Collector to use (for example, 1.9.0). To find the latest version, view the CXDOT Collector release notes in Cortex XCOR. In the navigation menu, select More information > Release notes, and then click the CXDOT Collector tab.
  5. Run the following kubectl command to verify that the CXDOT Collector was installed successfully:
    Confirm that the output returns a list of resources that includes ds/cxdot-node-collector, deploy/cxdot-api-server, and deploy/cxdot-cluster-collector. These are components of the CXDOT Collector.
After you install the CXDOT Collector, the Collector uses the Kubernetes integration to collect metrics from your Kubernetes cluster. Configure this integration to customize or disable its behavior.

Upgrade

To upgrade the CXDOT Collector to a new version, or after updating configuration settings in your Helm values file, run the following command:
Replace VERSION with the version of the CXDOT Collector to use (for example, 1.9.0). To find the latest version, view the CXDOT Collector release notes in Cortex XCOR. In the navigation menu, select More information > Release notes, and then click the CXDOT Collector tab.
When you upgrade the CXDOT Collector, your configured schema_version value stays the same. To update the active schema version, you must change this value manually.

Uninstall

To uninstall the CXDOT Collector, follow these steps.
  1. Run the following Helm command to uninstall the components of the CXDOT Collector:
  2. Run the following kubectl command to delete the namespace associated with the CXDOT Collector: