Install the CXDOT Collector in a Kubernetes cluster

​

Supported environments and distributions

• Upstream Kubernetes (self-managed or on-premises)
• Amazon EKS
• Google GKE
• Azure AKS

​

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

1. Run the following kubectl command to create the cxdot namespace:
   kubectl create namespace cxdot
   
2. Set the name of your Cortex XCOR tenant by adding the following keys to your Helm values file:
   values.yaml

   config:
     orgName: TENANT
     clusterName: CLUSTER
   
   Replace the following values:
   • 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:
   apiVersion: v1
   kind: Secret
   metadata:
     name: cxdot-api-token
     namespace: cxdot
   type: Opaque
   data:
     api-token: "TOKEN"
   
   Replace TOKEN with your base64-encoded Cortex XCOR API token.
   Alternatively, you can reference an existing Kubernetes Secret by supplying it to Helm as the value of config.apiToken. If you use this method, don’t encode the value of your API token.
4. Run the following Helm command to install the CXDOT Collector in your Kubernetes cluster:
   helm install cxdot-collector \
     oci://us-docker.pkg.dev/chronosphereio/helm/cxdot-collector \
     --version "VERSION" \
     --namespace cxdot \
     -f values.yaml
   
   Replace VERSION with the version of the CXDOT Collector to use (for example, 1.4.0+otel-0.157.0).
5. Run the following kubectl command to verify that the CXDOT Collector was installed successfully:
   kubectl -n cxdot get ds,deploy
   
   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.

​

Upgrade

helm upgrade cxdot-collector \
  oci://us-docker.pkg.dev/chronosphereio/helm/cxdot-collector \
  --version "VERSION" \
  --namespace cxdot \
  -f values.yaml

​

Uninstall

1. Run the following Helm command to uninstall the components of the CXDOT Collector:
   helm uninstall cxdot-collector --namespace cxdot
   
2. Run the following kubectl command to delete the namespace associated with the CXDOT Collector:
   kubectl delete namespace cxdot