Skip to content

Commit 9436089

Browse files
erichsueh3erichsueh3
authored
ADOT EKS add-on Getting Started Guide updates (#434)
* added note about permissions not needed past 0.62.1 * add additional collector config values + default values to table, add note about service-account-role-arn flag * update version number of config values table
1 parent f31425d commit 9436089

File tree

3 files changed

+30
-18
lines changed

3 files changed

+30
-18
lines changed

‎src/docs/getting-started/adot-eks-add-on/add-on-configuration-collector-deployment.mdx

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -11,17 +11,23 @@ For more information on Collector configuration, and to learn about Amazon Manag
1111

1212
Below is a list of configurable values EKS add-ons provides for ADOT, specifically to enable Collector deployment.
1313

14-
| Value | Description | Example |
15-
| ------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------- |
16-
| `collector.serviceAccount.create` | Specify whether or not to create a service account for use with Collector deployment. Required for Collector deployment. | "{"collector":{"serviceAccount":{"create":true}}}" |
17-
| `collector.serviceAccount.name` | Specify a name for a service account for use with Collector deployment, either to create or a pre-existing service account. Required for Collector deployment. | "{"collector":{"serviceAccount":{"name":"adot-collector"}}}" |
18-
| `collector.serviceAccount.annotations` | Specifies annotations for a service account for use with Collector deployment. Required if `collector.serviceAccount.create` is true. | "{"collector":{"serviceAccount":{"annotations":{"eks.amazonaws.com/role-arn":"arn:aws:iam::000000000000:role/adot-collector"}}}}}" |
19-
| `collector.amp.enabled` | Specify whether or not to enable Amazon Managed Prometheus as a destination for Collector deployment. | "{"collector":{"amp":{"enabled":true}}}" |
20-
| `collector.amp.remoteWriteEndpoint` | Specify a remote write endpoint for Amazon Managed Prometheus. Required if `collector.amp.enabled` is true. | "{"collector":{"amp":{"remoteWriteEndpoint":"https://aps-workspaces.us-west-2.amazonaws.com/workspaces/ws-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/api/v1/remote_write"}}}" |
21-
| `collector.cloudwatch.enabled` | Specify whether or not to enable AWS CloudWatch as a destination for Collector deployment. | "{"collector":{"cloudwatch":{"enabled":true}}}" |
22-
| `collector.xray.enabled` | Specify whether or not to enable AWS X-Ray as a destination for Collector deployment. | "{"collector":{"xray":{"enabled":true}}}" |
23-
24-
14+
| Value | Description | Default | Example |
15+
| ------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
16+
| `collector.mode` | Specifies what mode to deploy the Collector in. Modes are `deployment`, `daemonset`, `statefulset`, and `sidecar`. | `deployment` | "{"collector":{"mode":"deployment"}}" |
17+
| `collector.replicas` | Specifies how many replicas of the Collector to deploy. | `1` | "{"collector":{"replicas":1}}" |
18+
| `collector.resources.limits.cpu` | Modifies the cpu resource limit for the ADOT Collector pod.* | `256m` | "{"collector":{"resource":{"limits":{"cpu":"256m"}}}}" |
19+
| `collector.resources.limits.memory` | Modifies the memory resource limit for the ADOT Collector pod.* | `512Mi` | "{"collector":{"resource":{"limits":{"memory":"512Mi"}}}}" |
20+
| `collector.resources.requests.cpu` | Modifies the cpu resource request for the ADOT Collector pod.* | `64m` | "{"collector":{"resource":{"requests":{"cpu":"64m"}}}}" |
21+
| `collector.resources.requests.memory` | Modifies the memory resource request for the ADOT Collector pod.* | `128Mi` | "{"collector":{"resource":{"requests":{"memory":"128Mi"}}}}" |
22+
| `collector.serviceAccount.create` | Specify whether or not to create a service account for use with Collector deployment. | `true` | "{"collector":{"serviceAccount":{"create":true}}}" |
23+
| `collector.serviceAccount.name` | Specify a name for a service account for use with Collector deployment, either to create or a pre-existing service account. | `aws-otel-collector` | "{"collector":{"serviceAccount":{"name":"aws-otel-collector"}}}" |
24+
| `collector.serviceAccount.annotations*` | Specifies annotations for a service account for use with Collector deployment. | N/A | "{"collector":{"serviceAccount":{"annotations":{"eks.amazonaws.com/role-arn":"arn:aws:iam::000000000000:role/adot-collector"}}}}}" |
25+
| `collector.amp.enabled` | Specify whether or not to enable Amazon Managed Prometheus as a destination for Collector deployment. | `false` | "{"collector":{"amp":{"enabled":true}}}" |
26+
| `collector.amp.remoteWriteEndpoint` | Specify a remote write endpoint for Amazon Managed Prometheus. Required if `collector.amp.enabled` is true. | N/A | "{"collector":{"amp":{"remoteWriteEndpoint":"https://aps-workspaces.us-west-2.amazonaws.com/workspaces/ws-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/api/v1/remote_write"}}}" |
27+
| `collector.cloudwatch.enabled` | Specify whether or not to enable AWS CloudWatch as a destination for Collector deployment. | `false` | "{"collector":{"cloudwatch":{"enabled":true}}}" |
28+
| `collector.xray.enabled` | Specify whether or not to enable AWS X-Ray as a destination for Collector deployment. | `false` | "{"collector":{"xray":{"enabled":true}}}" |
29+
30+
*This configuration value can be used to annotate your service account and associate it with an IAM role for IRSA. As an alternative to using this configuration value for IRSA, you can use the `--service-account-role-arn` flag when creating or updating the add-on. This flag will annotate service accounts created by the add-on with the role ARN you provide. The equivalent to the example provided for `collector.serviceAccount.annotations` is `--service-account-role-arn arn:aws:iam::000000000000:role/adot-collector`.
2531

2632
An example of how to use EKS add-ons to install ADOT, with a Collector deployment to Amazon Managed Prometheus using a pre-existing service account for IRSA, can be seen in the command below
2733

0 commit comments

Comments
 (0)