Manage the Amazon Distro for OpenTelemetry Operator
The Amazon Distro for OpenTelemetry (ADOT) Operator is available as an Amazon EKS add-on. After installing the ADOT Operator, you can configure the ADOT Collector to specify the deployment type and the service that will receive your application metric or trace data. This topic describes how to manage the ADOT add-on.
To install the ADOT Collector, see Deploy the Amazon Distro for OpenTelemetry Collector. Alternatively, with the advanced configuration feature of Amazon EKS add-ons, you can install the ADOT Collector during add-on creation or add-on updates. For more information, see Deploy the Amazon Distro for OpenTelemetry Collector using advanced configuration.
Install the Amazon Distro for OpenTelemetry (ADOT) Operator
Installing the ADOT add-on includes the ADOT Operator, which in turn deploys the ADOT
Collector. The ADOT Operator is a custom controller which introduces a new object type
called the OpenTelemetryCollector
through CustomResourceDefinition (CRD)OpenTelemetryCollector
resource, then it installs the ADOT Collector.
Prerequisites
-
You have met the ADOT prerequisites.
-
Update your
kubeconfig
if necessary using the following command.aws eks update-kubeconfig --name
my-cluster
--regionregion-code
-
Version
2.12.3
or later or1.27.160
or later of the Amazon CLI installed and configured on your device or Amazon CloudShell. You can check your current version withaws --version | cut -d / -f2 | cut -d ' ' -f1
. Package managers suchyum
,apt-get
, or Homebrew for macOS are often several versions behind the latest version of the Amazon CLI. To install the latest version, see Installing, updating, and uninstalling the Amazon CLI and Quick configuration withaws configure
in the Amazon Command Line Interface User Guide. The Amazon CLI version installed in the Amazon CloudShell may also be several versions behind the latest version. To update it, see Installing Amazon CLI to your home directory in the Amazon CloudShell User Guide. -
An existing Amazon EKS cluster.
-
An existing Amazon EKS service IAM role. If you don't have the role, you can follow Create an IAM role to create one.
Update the Amazon Distro for OpenTelemetry (ADOT) Operator
Amazon EKS does not automatically update ADOT on your cluster. You must initiate the update and then Amazon EKS updates the Amazon EKS add-on for you.
To update the ADOT Amazon EKS add-on using the Amazon CLI
-
Check the current version of your ADOT add-on. Replace
with your cluster name.my-cluster
aws eks describe-addon --cluster-name
my-cluster
--addon-name adot --query "addon.addonVersion" --output text -
Determine the ADOT versions are available that are supported by your cluster's version.
aws eks describe-addon-versions --addon-name adot --kubernetes-version
1.23
\ --query "addons[].addonVersions[].[addonVersion, compatibilities[].defaultVersion]" --output textAn example output is as follows.
v0.58.0-eksbuild.1 True v0.56.0-eksbuild.2 False
The version with
True
underneath is the default version deployed when the add-on is created. The version deployed when the add-on is created might not be the latest available version. In the previous output, the latest version is deployed when the add-on is created. -
Update the ADOT version. Replace
with the name of your cluster andmy-cluster
with the desired version. Optionally, thev0.58.0-eksbuild.1
flag can be added to deploy an ADOT Collector during add-on installation. You may also configure other available values with this flag.--configuration-values
aws eks update-addon --cluster-name
my-cluster
--addon-name adot --addon-versionv0.58.0-eksbuild.1
--resolve-conflictsPRESERVE
--configuration-values my-configuration-values
The
PRESERVE
option preserves any custom settings that you've set for the add-on. For more information about other options for this setting, see update-addon in the Amazon EKS Command Line Reference. For more information about Amazon EKS add-on configuration management, see Kubernetes field management.
Remove the Amazon Distro for OpenTelemetry (ADOT) Operator
-
You must delete the ADOT Collector resource separately from the ADOT Collector. In this command, specify the YAML file that you used to deploy the ADOT Collector:
kubectl delete -f collector-config-
(amp|cloudwatch|xray|advanced)
.yaml -
You can remove the ADOT Operator through either the Amazon CLI or
eksctl
. If you remove the ADOT Operator, you must follow the installation instructions again to reinstall:CLI
aws eks delete-addon --addon-name adot --cluster-name
my-cluster
eksctl
eksctl delete addon --cluster
my-cluster
--name adot