Skip to content

Commit 360e62f

Browse files
eks-distro-pr-botsnarkychef
eks-distro-pr-bot
and
snarkychef
authored
Docs for newly released package versions (#10455)
Co-authored-by: Subbu Vakati <subbusrv@amazon.com>
1 parent 79d5e04 commit 360e62f

File tree

5 files changed

+760
-5
lines changed

5 files changed

+760
-5
lines changed

‎docs/content/en/docs/packages/adot/v0.45.1.md‎

Lines changed: 139 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,139 @@
1+
---
2+
title: "v0.45.1"
3+
linkTitle: "v0.45.1"
4+
weight: 20
5+
aliases:
6+
/docs/reference/packagespec/adot/v0.45.1/
7+
description: >
8+
---
9+
10+
{{% pageinfo %}}
11+
The logging exporter is now [deprecated](https://github.com/open-telemetry/opentelemetry-collector/pull/11037) , users should update the config to the debug exporter instead
12+
13+
{{% /pageinfo %}}
14+
15+
### Configuring ADOT in EKS Anywhere package spec
16+
17+
#### Example
18+
19+
For complete configuration examples and use cases, refer to [ADOT with AMP and AMG.]({{< relref "adot_amp_amg.md" >}})
20+
21+
#### Configurable parameters and default values under `spec.config`
22+
23+
| Parameter | Description | Default |
24+
|-----|---------|-------------|
25+
|**General**|
26+
| hostNetwork | Indicates if the pod should run in the host networking namespace. | `false` |
27+
| image.pullPolicy | Specifies image pull policy: `IfNotPresent`, `Always`, `Never`. | `"IfNotPresent"` |
28+
| mode | Specifies Collector deployment options: `daemonset`, `deployment`, or `statefulset`. | `"daemonset"` |
29+
| ports.[\*].containerPort | Specifies containerPort used. | See footnote [^1] |
30+
| ports.[\*].enabled | Indicates if a port is enabled. | See footnote [^1] |
31+
| ports.[\*].hostPort | Specifies hostPort used. | See footnote [^1] |
32+
| ports.[\*].protocol | Specifies protocol used. | See footnote [^1] |
33+
| ports.[\*].servicePort | Specifies servicePort used. | See footnote [^1] |
34+
| resources.limits.cpu | Specifies CPU resource limits for containers. | `1` |
35+
| resources.limits.memory | Specifies memory resource limits for containers. | `"2Gi"` |
36+
|**ServiceAccount**|
37+
| serviceAccount.create | Specifies whether a service account should be created. | `true` |
38+
| serviceAccount.annotations | Annotations to add to the service account (e.g., `eks.amazonaws.com/role-arn` for IRSA). | `{}` |
39+
| serviceAccount.name | The name of the service account to use. If not set and create is true, a name is generated using the fullname template. | `""` |
40+
|**ClusterRole**|
41+
| clusterRole.create | Specifies whether a clusterRole should be created. Some presets also trigger the creation of a cluster role. | `false` |
42+
| clusterRole.annotations | Annotations to add to the clusterRole. Can be used in combination with presets. | `{}` |
43+
| clusterRole.name | The name of the clusterRole to use. If not set, a name is generated using the fullname template. | `""` |
44+
| clusterRole.rules | A set of rules as documented in [Kubernetes RBAC](https://kubernetes.io/docs/reference/access-authn-authz/rbac/). Can be used in combination with presets to add additional rules. | `[]` |
45+
|**Presets**|
46+
| presets.logsCollection.enabled | Configures the collector to collect logs. Adds the filelog receiver to the logs pipeline and adds necessary volumes and volume mounts. Best used with mode = daemonset. | `false` |
47+
| presets.logsCollection.includeCollectorLogs | Include ADOT collector's own logs in collection. | `false` |
48+
| presets.logsCollection.storeCheckpoints | Enables writing checkpoints in /var/lib/otelcol/ host directory. Changes collector's user to root. | `false` |
49+
| presets.hostMetrics.enabled | Configures the collector to collect host metrics. Adds the hostmetrics receiver to the metrics pipeline. Best used with mode = daemonset. | `false` |
50+
| presets.kubernetesAttributes.enabled | Configures the Kubernetes Processor to add Kubernetes metadata. Adds k8sattributes processor to all pipelines and creates ClusterRole with minimum required RBAC rules. Best used with mode = daemonset. | `false` |
51+
| presets.kubernetesAttributes.extractAllPodLabels | When enabled, the processor extracts all labels for an associated pod and adds them as resource attributes. | `false` |
52+
| presets.kubernetesAttributes.extractAllPodAnnotations | When enabled, the processor extracts all annotations for an associated pod and adds them as resource attributes. | `false` |
53+
| presets.kubeletMetrics.enabled | Configures the collector to collect node, pod, and container metrics from the API server on a kubelet. Adds kubeletstats receiver to the metrics pipeline and adds necessary ClusterRole rules. Best used with mode = daemonset. | `false` |
54+
| presets.kubernetesEvents.enabled | Configures the collector to collect kubernetes events. Adds k8sobjects receiver to the logs pipeline. Best used with mode = deployment or statefulset. | `false` |
55+
| presets.clusterMetrics.enabled | Configures the Kubernetes Cluster Receiver to collect cluster-level metrics. Adds k8s_cluster receiver to the metrics pipeline and adds necessary ClusterRole rules. Best used with mode = deployment or statefulset. | `false` |
56+
|**Config**|
57+
| config.config | Specifies Collector receiver, processor, exporter, and extensions configurations. Refer to [aws-otel-collector](https://github.com/aws-observability/aws-otel-collector) for full details. **Note EKS Anywhere ADOT package version matches the exact aws-otel-collector version.** | See footnote [^2] |
58+
| config.config.receiver | Specifies how data gets in the Collector. Receivers can be either push or pull based, and support one or more data source. | See footnote [^2] |
59+
| config.config.processor | Specifies how processors are run on data between the stage of being received and being exported. Processors are optional though some are [recommended.](https://github.com/open-telemetry/opentelemetry-collector/tree/main/processor#recommended-processors) | See footnote [^2] |
60+
| config.config.exporters | Specifies how data gets sent to backends/destinations. Exporters can be either push or pull based, and support one or more data source. | See footnote [^2] |
61+
| config.config.extensions | Specifies tasks that do not involve processing telemetry data. Examples of extensions include health monitoring, service discovery, and data forwarding. Extensions are optional. | See footnote [^2] |
62+
| config.config.service | Specifies what components are enabled in the Collector based on the configuration found in the receivers, processors, exporters, and extensions sections. **If a component is configured, but not defined within the service section, then it is not enabled.** | See footnote [^2] |
63+
|**Deployment mode only**|
64+
| replicaCount | Specifies replicaCount for pods. | `1` |
65+
| service.type | Specifies service types: `ClusterIP`, `NodePort`, `LoadBalancer`, `ExternalName`. |`"ClusterIP"` |
66+
67+
[^1]:
68+
The default `ports` enables `otlp` and `otlp-http`. See below specification for details.
69+
```yaml
70+
apiVersion: packages.eks.amazonaws.com/v1alpha1
71+
kind: Package
72+
...
73+
spec:
74+
config: |
75+
ports:
76+
otlp:
77+
enabled: true
78+
containerPort: 4317
79+
servicePort: 4317
80+
hostPort: 4317
81+
protocol: TCP
82+
otlp-http:
83+
enabled: true
84+
containerPort: 4318
85+
servicePort: 4318
86+
hostPort: 4318
87+
protocol: TCP
88+
```
89+
90+
[^2]:
91+
The default `config.config` deploys an ADOT Collector with the metrics pipeline, which includes otlp and prometheus receiver, and logging exporter. See below specification for details.
92+
```yaml
93+
apiVersion: packages.eks.amazonaws.com/v1alpha1
94+
kind: Package
95+
...
96+
spec:
97+
config: |
98+
config:
99+
receivers:
100+
otlp:
101+
protocols:
102+
grpc:
103+
endpoint: 0.0.0.0:4317
104+
http:
105+
endpoint: 0.0.0.0:4318
106+
prometheus:
107+
config:
108+
scrape_configs:
109+
- job_name: opentelemetry-collector
110+
scrape_interval: 10s
111+
static_configs:
112+
- targets:
113+
- ${MY_POD_IP}:8888
114+
processors:
115+
batch: {}
116+
memory_limiter: null
117+
exporters:
118+
logging:
119+
loglevel: info
120+
extensions:
121+
health_check: {}
122+
memory_ballast: {}
123+
service:
124+
telemetry:
125+
metrics:
126+
address: 0.0.0.0:8888
127+
extensions:
128+
- health_check
129+
- memory_ballast
130+
pipelines:
131+
metrics:
132+
exporters:
133+
- logging
134+
processors:
135+
- memory_limiter
136+
- batch
137+
receivers:
138+
- otlp
139+
- prometheus

‎docs/content/en/docs/packages/emissary/v3.10.0.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
title: "v3.10.0"
3+
linkTitle: "v3.10.0"
4+
weight: 20
5+
aliases:
6+
/docs/reference/packagespec/emissary/v3.10.0/
7+
description: >
8+
---
9+
10+
{{% pageinfo %}}
11+
Emissary version 3.10.0 has decoupled the CRD portion of the package, and now supports installing multiple instances of the emissary package in the same cluster.
12+
{{% /pageinfo %}}
13+
14+
### Configuring Emissary Ingress in EKS Anywhere package spec
15+
16+
| Parameter | Description | Default |
17+
|---|---|---|
18+
|**General**|||
19+
| hostNetwork | Whether Emissary will use the host network, useful for on-premise setup .<br/>Example:<br/> <pre>hostNetwork: false</pre>| false
20+
| createDefaultListeners | Whether Emissary should be created with default listeners, HTTP on port 8080 and HTTPS on port 8443. <br/>Example:<br/> <pre>createDefaultListeners: false</pre>| false
21+
| replicaCount | Replica count for Emissary to deploy. <br/>Example:<br/> <pre>replicaCount: 2</pre>| 2
22+
| daemonSet | Whether to create Emissary as a Daemonset instead of a deployment <br/>Example:<br/> <pre>daemonSet: false</pre>| false

‎docs/content/en/docs/packages/metrics-server/v3.13.0.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: "v3.13.0"
3+
linkTitle: "v3.13.0"
4+
weight: 40
5+
aliases:
6+
/docs/reference/packagespec/metrics-server/v3.13.0/
7+
description: >
8+
---
9+
10+
### Configuring Metrics Server in EKS Anywhere package spec
11+
12+
| Parameter | Description | Default |
13+
|---|---|---|
14+
|**General**|||
15+
| args | Additional args to provide to metrics-server <br/>Example:<br/> <pre>cloudProvider: ["--kubelet-insecure-tls"] </pre>| []

‎docs/content/en/docs/packages/packagelist.md‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,11 @@ description: >
1010

1111
| Name | Description | Versions | GitHub |
1212
|----------------------------|----------------------------|---------------------------|-----------------------------|
13-
| [ADOT]({{< relref "./adot" >}}) | ADOT Collector is an AWS distribution of the OpenTelemetry Collector, which provides a vendor-agnostic solution to receive, process and export telemetry data. | [v0.43.1]({{< relref "./adot/v0.43.1.md" >}}) | https://github.com/aws-observability/aws-otel-collector |
13+
| [ADOT]({{< relref "./adot" >}}) | ADOT Collector is an AWS distribution of the OpenTelemetry Collector, which provides a vendor-agnostic solution to receive, process and export telemetry data. | [v0.45.1]({{< relref "./adot/v0.45.1.md" >}}) | https://github.com/aws-observability/aws-otel-collector |
1414
| [Cert-manager]({{< relref "./cert-manager" >}}) | Cert-manager is a certificate manager for Kubernetes clusters. | [v1.18.2]({{< relref "./cert-manager/v1.18.2.md" >}}) | https://github.com/cert-manager/cert-manager |
1515
| [Cluster Autoscaler]({{< relref "./cluster-autoscaler" >}}) | Cluster Autoscaler is a component that automatically adjusts the size of a Kubernetes Cluster so that all pods have a place to run and there are no unneeded nodes. | [v9.47.0]({{< relref "./cluster-autoscaler/v9.47.0.md" >}}) | https://github.com/kubernetes/autoscaler |
16-
| [Emissary Ingress]({{< relref "./emissary" >}}) | Emissary Ingress is an open source `Ingress` supporting API Gateway + Layer 7 load balancer built on Envoy Proxy. | [v3.9.1]({{< relref "./emissary/v3.9.1.md" >}}) | https://github.com/emissary-ingress/emissary/ |
16+
| [Emissary Ingress]({{< relref "./emissary" >}}) | Emissary Ingress is an open source `Ingress` supporting API Gateway + Layer 7 load balancer built on Envoy Proxy. | [v3.10.0]({{< relref "./emissary/v3.10.0.md" >}}) | https://github.com/emissary-ingress/emissary/ |
1717
| [Harbor]({{< relref "./harbor" >}}) | Harbor is an open source trusted cloud native registry project that stores, signs, and scans content. | [v2.12.2]({{< relref "./harbor/v2.12.2.md" >}})| https://github.com/goharbor/harbor<br>https://github.com/goharbor/harbor-helm |
1818
| [MetalLB]({{< relref "./metallb" >}}) | MetalLB is a virtual IP provider for services of type `LoadBalancer` supporting ARP and BGP. | [v0.15.2]({{< relref "./metallb/v0.15.2.md" >}}) | https://github.com/metallb/metallb/ |
19-
| [Metrics Server]({{< relref "./metrics-server" >}}) | Metrics Server is a scalable, efficient source of container resource metrics for Kubernetes built-in autoscaling pipelines. | [v3.12.2]({{< relref "./metrics-server/v3.12.2.md" >}}) | https://github.com/kubernetes-sigs/metrics-server |
20-
| [Prometheus]({{< relref "./prometheus" >}}) | Prometheus is an open-source systems monitoring and alerting toolkit that collects and stores metrics as time series data. | [v2.55.1]({{< relref "./prometheus/v2.55.1.md" >}}) | https://github.com/prometheus/prometheus |
21-
19+
| [Metrics Server]({{< relref "./metrics-server" >}}) | Metrics Server is a scalable, efficient source of container resource metrics for Kubernetes built-in autoscaling pipelines. | [v3.13.0]({{< relref "./metrics-server/v3.13.0.md" >}}) | https://github.com/kubernetes-sigs/metrics-server |
20+
| [Prometheus]({{< relref "./prometheus" >}}) | Prometheus is an open-source systems monitoring and alerting toolkit that collects and stores metrics as time series data. | [v3.8.0]({{< relref "./prometheus/v3.8.0.md" >}}) | https://github.com/prometheus/prometheus |

0 commit comments

Comments
 (0)