You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
1. Meet the prerequisites described [here](/docs/getting-started/adot-eks-add-on/requirements).
11
-
2. Leverage EKS add-ons to deploy the ADOT Operator to your Amazon EKS cluster.
12
-
3. Deploy the ADOT Collector Custom Resource Definition (CRD). You have the option to associate your IAM role with your EKS service account using [IRSA](https://docs.aws.amazon.com/emr/latest/EMR-on-EKS-DevelopmentGuide/setting-up-enable-IAM.html). By doing this, your service account can then provide AWS permissions to the containers you run in any pod that use that service account.
10
+
+ You have met the [ADOT prerequisites](/docs/getting-started/adot-eks-add-on/requirements)\.
13
11
14
-
This section will go into detail for the second and third steps. Alternatively, the second and third steps can be simplified, and combined into one, using the EKS add-ons advanced configuration feature. For more information on advanced configuration for ADOT, see [Add-on Advanced Configuration](/docs/getting-started/adot-eks-add-on/add-on-configuration). For more information on ADOT Collector deployment using advanced configuration, see [Add-on Advanced Configuration: Collector Deployment](/docs/getting-started/adot-eks-add-on/add-on-configuration-collector-deployment).
12
+
------
13
+
## AWS Management Console
15
14
16
-
## Leverage EKS Add-Ons to deploy the ADOT Operator to your Amazon EKS cluster
15
+
Install the ADOT Amazon EKS add\-on to your Amazon EKS cluster using the following steps:
17
16
18
-
1. Apply the necessary permissions for ADOT to your cluster with the command:
1. On the **Select add\-ons** page, do the following:
26
+
27
+
1. In the **Amazon EKS\-addons** section, select the **AWS Distro for OpenTelemetry** check box\.
28
+
29
+
1. Choose **Next**\.
30
+
31
+
1. On the **Configure selected add\-ons settings** page, do the following:
32
+
33
+
1. The default version will be selected in the **Version** dropdown list\. Select the **Version** you'd like to use\.
34
+
35
+
1.\(Optional\) If deploying an ADOT Collector, expand **Optional configuration settings** and provide the **Configuration values** that match your use case for Collector deployment\. The **Add\-on configuration schema** provides the available options for your configuration values\.
36
+
37
+
1. If a service account is already created in the cluster without an IAM role, expand the **Optional configuration settings** and select **Override** for the **Conflict resolution method**\.
38
+
39
+
1. Choose **Next**\.
40
+
41
+
1. On the **Review and add** page, choose **Create**\. After the add\-on installation is complete, you see your installed add\-on\.
42
+
43
+
------
44
+
## AWS CLI
45
+
46
+
1. Install the ADOT Amazon EKS add\-on to your Amazon EKS cluster\. Optionally, the `--configuration-values` flag can be added to deploy an ADOT Collector during add\-on installation\. You may also configure other available values with this flag\.
The sample application will generate and send OTLP data to any of the services that you have configured through the AWS Distro for
8
+
OpenTelemetry [\(ADOT\) Collector deployment](/docs/getting-started/adot-eks-add-on/add-on-configuration-collector-deployment)\. This step is optional if you already have an application running inside your cluster that can produce data\.
9
+
Consult your application's documentation to ensure that data is sent to the correct endpoints\.
10
+
11
+
The sample application and traffic generator were largely taken from an example in the [ADOT Collector repository](https://github.com/aws-observability/aws-otel-collector/blob/main/examples/docker/docker-compose.yaml)\.
12
+
A `docker-compose.yaml` file was translated to Kubernetes resources using the [Kompose tool](https://kompose.io/)\.
13
+
14
+
To apply the traffic generator and sample application, do the following steps\. Make sure that you have satisfied the prerequisites and completed the
15
+
procedure in [Install the AWS Distro for OpenTelemetry \(ADOT\) Operator](/docs/getting-started/adot-eks-add-on/installation)\.
16
+
17
+
1. Download the `traffic-generator.yaml` file to your computer\. You can also [view the file](https://github.com/aws-observability/aws-otel-community/blob/master/sample-configs/traffic-generator.yaml) on GitHub\.
2. In `traffic-generator.yaml`, make sure that the second `kind` value reflects your mode\. For more information,
24
+
see [Deploy the ADOT Collector](https://aws-otel.github.io/docs/getting-started/adot-eks-add-on/installation#deploy-the-adot-collector) on GitHub\.
25
+
26
+
```
27
+
kind: Deployment
28
+
```
29
+
30
+
`traffic-generator.yaml` makes `http` calls to the Kubernetes service `sample-app:4567`\. This allows the traffic generator to
31
+
interact with the sample application on port `4567`\.`sample-app` resolves to the IP address of the `sample-app` Pod\.
32
+
33
+
3. Apply `traffic-generator.yaml` to your cluster\.
34
+
35
+
```
36
+
kubectl apply -f traffic-generator.yaml
37
+
```
38
+
39
+
4. Download the `sample-app.yaml` file to your computer\. You can also [view the file](https://github.com/aws-observability/aws-otel-community/blob/master/sample-configs/sample-app.yaml) on GitHub\.
This topic covers some of the common errors that you might encounter while using the AWS Distro for OpenTelemetry (ADOT) Amazon EKS add-on. The topic also includes instructions on how to resolve or workaround the common errors.
9
+
---
10
+
### Error: "code": "AccessDenied", "message": "roles.rbac.authorization.k8s.io \"opentelemetry-operator-leader-election-role\" is forbidden: User \"eks:addon-manager\" cannot patch resource \"roles\" in API group \"rbac.authorization.k8s.io\" in the namespace \"opentelemetry-operator-system\"
11
+
12
+
You don't have permission to install the ADOT for Amazon EKS add-on. See Install the AWS Distro for OpenTelemetry (ADOT) Operator. If you have deleted the add-on and are now reinstalling, make sure that you have applied the required permissions.
13
+
14
+
### Error: "status": "CREATE_FAILED" or "status": "UPDATE_FAILED"
15
+
16
+
This can happen due to the following reasons:
17
+
- There might be a conflict. You can overwrite conflicts by adding the `--resolve-conflicts=OVERWRITE` flag and running the create command again.
18
+
- If you're using an add-on version earlier than v0.51.0, you may be on an unsupported architecture, such as arm64. Consult your logs to determine if this is the case. If so, updating your add-on version may resolve this issue because v0.51.0 and later are multi-arch.
## Updating ADOT using EKS add-ons and Updating the Collector Custom Resource
8
+
## Update the AWS Distro for OpenTelemetry \(ADOT\) Operator<aname="adot-update"></a>
9
9
10
-
The ADOT Operator and Collector Custom Resource are periodically updated with new versions. Check for an update of the ADOT Operator version EKS add-ons uses by executing the command
11
-
```console
12
-
aws eks describe-addon-versions —addon-name adot
13
-
```
10
+
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\.
14
11
15
-
Refer [here](https://docs.aws.amazon.com/eks/latest/userguide/managing-kube-proxy.html) for more information. If a new version is found, update it in your cluster with the command
**To update the ADOT Amazon EKS add\-on using the AWS CLI**
19
13
20
-
After updating the ADOT Operator using EKS add-ons, the Collector CR will also have been updated, as the default ADOT Collector image the ADOT Operator uses will have been updated as well. Reapply the Collector configurations with any changes from the last Collector Custom Resource Definition, if necessary.
14
+
1. Check the current version of your ADOT add\-on\. Replace `my-cluster`with your cluster name\.
21
15
22
-
### Updating ADOT using EKS add-ons advanced configuration feature
If you followed steps from [Add-on Advanced Configuration](/docs/getting-started/adot-eks-add-on/add-on-configuration), then you can update ADOT using EKS add-ons advanced configuration feature as well. You can execute the command
1. Determine the ADOT versions are available that are supported by your cluster's version\.
28
21
29
-
Updating the configuration values used by the add-on with a new JSON string will override previously set configuration values. If you would like to reset the configuration values used back to default values, you can use an empty JSON string (`--configuration-values "{}"`).
--query "addons[].addonVersions[].[addonVersion, compatibilities[].defaultVersion]" --output text
25
+
```
30
26
31
-
ADOT can also be updated to a new add-on version alongside updates to configuration values. However, the configuration values must be compatible with the add-on version that ADOT is being updated to; the add-on will not update if those configuration values are not available in the new version.
27
+
An example output is as follows\.
32
28
33
-
## Cleanup of ADOT using EKS Add-ons and Cleanup of Other Components
29
+
```
30
+
v0.58.0-eksbuild.1
31
+
True
32
+
v0.56.0-eksbuild.2
33
+
False
34
+
```
34
35
35
-
### Delete the Collector resource
36
+
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
37
+
the previous output, the latest version is deployed when the add\-on is created\.
36
38
37
-
You can delete individual services by specifying their YAML:
1. Update the ADOT version\. Replace `my-cluster` with the name of your cluster and `v0.58.0-eksbuild.1` with the desired version\. Optionally, the `--configuration-values` flag can
40
+
be added to deploy an ADOT Collector during add\-on installation\. You may also configure other available values with this flag\.
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](https://docs.aws.amazon.com/cli/latest/reference/eks/update-addon.html) in the
47
+
Amazon EKS Command Line Reference\. For more information about Amazon EKS add\-on configuration management, see [Kubernetes field management](https://docs.aws.amazon.com/eks/latest/userguide/kubernetes-field-management.html)\.
47
48
48
-
After uninstalling ADOT, before reinstalling you must reinstall permissions first, see [this page](/docs/getting-started/adot-eks-add-on/requirements#adot-requirements).
49
+
## Remove the AWS Distro for OpenTelemetry \(ADOT\) Operator<aname="adot-remove"></a>
50
+
+ 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:
+ You can remove the ADOT Operator through either the AWS CLI or `eksctl`\. If you remove the ADOT Operator, you must follow the [installation instructions](/docs/getting-started/eks-add-on/installation) again to reinstall:
0 commit comments