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.-
Run the following kubectl command to create the
cxdotnamespace: -
Set your configuration schema version, XCOR tenant name, and cluster name
in your Helm values file:
Replace the following values:values.yaml
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 thek8s.cluster.nameresource attribute.
-
Set your API token by creating a
Kubernetes Secret
named
cxdot-api-tokenwith the following contents:ReplaceTOKENwith your XCOR API token. When you create your Secret, Kubernetes base64-encodes the value ofstringData, then stores the encoded value in a field calleddata.If your API token is stored in an existing Secret with a different name, setapiTokenSecretNamein your Helm values file to the name of that Secret. If your API token is stored in a key that isn’t namedapi-token, setapiTokenSecretKeyto the name of that key. -
Run the following Helm command to install the CXDOT Collector in your
Kubernetes cluster:
Replace
VERSIONwith 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. -
Run the following
kubectlcommand to verify that the CXDOT Collector was installed successfully:Confirm that the output returns a list of resources that includesds/cxdot-node-collector,deploy/cxdot-api-server, anddeploy/cxdot-cluster-collector. These are components of the CXDOT Collector.
Upgrade
To upgrade the CXDOT Collector to a new version, or after updating configuration settings in your Helm values file, run the following command: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.Migrate to updated Helm structure
CXDOT Collector versions 1.17.0 and later use a different structure for Helm values files than versions 1.16.0 and earlier. To convert an existing Helm values file to the new structure, you must move certain keys and their children accordingly.- The following keys, if present, must be top-level keys:
orgNameclusterNameenvironmentNameapiTokenSecretNameapiTokenSecretKeyegress
- The following keys, if present, must be nested under
collection.cxdot:schema_versionintegrationsdebugcgroup_runtime
- The
extensionskey, if present, must be nested undercollection.
- New structure
- Old structure
values.yaml
Uninstall
To uninstall the CXDOT Collector, follow these steps.-
Run the following Helm command to uninstall the components of the CXDOT
Collector:
-
Run the following kubectl command to delete the namespace associated with
the CXDOT Collector: