Skip to content

Commit

Permalink
[collector] Remove default collector image (#1148)
Browse files Browse the repository at this point in the history
* Remove default collector image

* fix command

* regen examples

* Remove command name restriction

* Adding warning
  • Loading branch information
TylerHelmuth authored Apr 19, 2024
1 parent 6ca3468 commit 8467a3e
Show file tree
Hide file tree
Showing 84 changed files with 334 additions and 86 deletions.
2 changes: 1 addition & 1 deletion charts/opentelemetry-collector/Chart.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
apiVersion: v2
name: opentelemetry-collector
version: 0.88.0
version: 0.89.0
description: OpenTelemetry Collector Helm chart for Kubernetes
type: application
home: https://opentelemetry.io/
Expand Down
14 changes: 7 additions & 7 deletions charts/opentelemetry-collector/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ helm repo add open-telemetry https://open-telemetry.github.io/opentelemetry-helm
To install the chart with the release name my-opentelemetry-collector, run the following command:

```console
helm install my-opentelemetry-collector open-telemetry/opentelemetry-collector --set mode=<value>
helm install my-opentelemetry-collector open-telemetry/opentelemetry-collector --set mode=<value> --set image.repository="otel/opentelemetry-collector-k8s" --set command.name="otelcol-k8s"
```

Where the `mode` value needs to be set to one of `daemonset`, `deployment` or `statefulset`.
Expand Down Expand Up @@ -87,7 +87,7 @@ The collector can be used to collect logs sent to standard output by Kubernetes
This feature is disabled by default. It has the following requirements:

- It needs agent collector to be deployed.
- It requires the [Filelog receiver](https://opentelemetry.io/docs/kubernetes/collector/components/#filelog-receiver) to be included in the collector, such as [contrib](https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib) version of the collector image.
- It requires the [Filelog receiver](https://opentelemetry.io/docs/kubernetes/collector/components/#filelog-receiver) to be included in the collector, such as [k8s](https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-k8s) version of the collector image.

To enable this feature, set the `presets.logsCollection.enabled` property to `true`.
Here is an example `values.yaml`:
Expand Down Expand Up @@ -147,7 +147,7 @@ The collector can be configured to add Kubernetes metadata, such as pod name and

This feature is disabled by default. It has the following requirements:

- It requires the [Kubernetes Attributes processor](https://opentelemetry.io/docs/kubernetes/collector/components/#kubernetes-attributes-processor) to be included in the collector, such as [contrib](https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib) version of the collector image.
- It requires the [Kubernetes Attributes processor](https://opentelemetry.io/docs/kubernetes/collector/components/#kubernetes-attributes-processor) to be included in the collector, such as [k8s](https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-k8s) version of the collector image.

To enable this feature, set the `presets.kubernetesAttributes.enabled` property to `true`.
Here is an example `values.yaml`:
Expand All @@ -169,7 +169,7 @@ The collector can be configured to collect node, pod, and container metrics from

This feature is disabled by default. It has the following requirements:

- It requires the [Kubeletstats receiver](https://opentelemetry.io/docs/kubernetes/collector/components/#kubeletstats-receiver) to be included in the collector, such as [contrib](https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib) version of the collector image.
- It requires the [Kubeletstats receiver](https://opentelemetry.io/docs/kubernetes/collector/components/#kubeletstats-receiver) to be included in the collector, such as [k8s](https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-k8s) version of the collector image.

To enable this feature, set the `presets.kubeletMetrics.enabled` property to `true`.
Here is an example `values.yaml`:
Expand All @@ -187,7 +187,7 @@ The collector can be configured to collects cluster-level metrics from the Kuber

This feature is disabled by default. It has the following requirements:

- It requires the [Kubernetes Cluster receiver](https://opentelemetry.io/docs/kubernetes/collector/components/#kubernetes-cluster-receiver) to be included in the collector, such as [contrib](https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib) version of the collector image.
- It requires the [Kubernetes Cluster receiver](https://opentelemetry.io/docs/kubernetes/collector/components/#kubernetes-cluster-receiver) to be included in the collector, such as [k8s](https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-k8s) version of the collector image.
- It requires statefulset or deployment mode with a single replica.

To enable this feature, set the `presets.clusterMetrics.enabled` property to `true`.
Expand All @@ -208,7 +208,7 @@ The collector can be configured to collect Kubernetes events.

This feature is disabled by default. It has the following requirements:

- It requires [Kubernetes Objects receiver](https://opentelemetry.io/docs/kubernetes/collector/components/#kubernetes-objects-receiver) to be included in the collector, such as [contrib](https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib) version of the collector image.
- It requires [Kubernetes Objects receiver](https://opentelemetry.io/docs/kubernetes/collector/components/#kubernetes-objects-receiver) to be included in the collector, such as [k8s](https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-k8s) version of the collector image.

To enable this feature, set the `presets.kubernetesEvents.enabled` property to `true`.
Here is an example `values.yaml`:
Expand All @@ -227,7 +227,7 @@ The collector can be configured to collect host metrics for Kubernetes nodes.

This feature is disabled by default. It has the following requirements:

- It requires [Host Metrics receiver](https://opentelemetry.io/docs/kubernetes/collector/components/#host-metrics-receiver) to be included in the collector, such as [contrib](https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib) version of the collector image.
- It requires [Host Metrics receiver](https://opentelemetry.io/docs/kubernetes/collector/components/#host-metrics-receiver) to be included in the collector, such as [k8s](https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-k8s) version of the collector image.

To enable this feature, set the `presets.hostMetrics.enabled` property to `true`.
Here is an example `values.yaml`:
Expand Down
25 changes: 25 additions & 0 deletions charts/opentelemetry-collector/UPGRADING.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,31 @@ created but the Memory Ballast Extension will still be removed.
Depending on the progress made in [Issue 891](https://github.com/open-telemetry/opentelemetry-helm-charts/issues/891),
the use of `GOMEMLIMIT` may completely replace the Memory Ballast Extension in the future.

## 0.88.0 to 0.89.0

> [!WARNING]
> Critical content demanding immediate user attention due to potential risks.
As part of working towards using the [OpenTelemetry Collector Kubernetes Distro](https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-k8s) by default, the chart now requires users to explicitly set an image repository. If you are already explicitly setting an image repository this breaking change does not affect you.

If you are using a OpenTelemetry Community distribution of the Collector we recommend you use `otel/opentelemetry-collector-k8s`, but carefully review the [components included in this distribution](https://github.com/open-telemetry/opentelemetry-collector-releases/blob/main/distributions/otelcol-k8s/manifest.yaml) to make sure it includes all the components you use in your configuration. In the future this distribution will become the default image used for the chart.

You can use the OpenTelemetry Collector Kubernetes Distro by adding these lines to your values.yaml:

```yaml
image:
repository: "otel/opentelemetry-collector-k8s"
```
If you want to stick with using the Contrib distribution, add these lines to your values.yaml:
```yaml
image:
repository: "otel/opentelemetry-collector-contrib"
```
For more details see [#1135](https://github.com/open-telemetry/opentelemetry-helm-charts/issues/1135).
## 0.84.0 to 0.85.0
The `loggingexporter` has been removed from the default configuration. Use the `debugexporter` instead.
Expand Down
6 changes: 6 additions & 0 deletions charts/opentelemetry-collector/ci/GOMEMLIMIT-values.yaml
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
mode: deployment

image:
repository: "otel/opentelemetry-collector-k8s"

command:
name: "otelcol-k8s"

useGOMEMLIMIT: true
7 changes: 7 additions & 0 deletions charts/opentelemetry-collector/ci/clusterrole-values.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,11 @@
mode: daemonset

image:
repository: "otel/opentelemetry-collector-k8s"

command:
name: "otelcol-k8s"

clusterRole:
create: true
name: "testing-clusterrole"
Expand Down
7 changes: 7 additions & 0 deletions charts/opentelemetry-collector/ci/config-override-values.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,11 @@
mode: daemonset

image:
repository: "otel/opentelemetry-collector-k8s"

command:
name: "otelcol-k8s"

config:
receivers:
jaeger: null
Expand Down
7 changes: 7 additions & 0 deletions charts/opentelemetry-collector/ci/daemonset-values.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,11 @@
mode: daemonset

image:
repository: "otel/opentelemetry-collector-k8s"

command:
name: "otelcol-k8s"

resources:
limits:
cpu: 100m
Expand Down
7 changes: 7 additions & 0 deletions charts/opentelemetry-collector/ci/deployment-values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@ global:
test: templated-value

mode: deployment

image:
repository: "otel/opentelemetry-collector-k8s"

command:
name: "otelcol-k8s"

resources:
limits:
cpu: 100m
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,11 @@
mode: deployment

image:
repository: "otel/opentelemetry-collector-k8s"

command:
name: "otelcol-k8s"

ports:
jaeger-compact:
enabled: false
Expand Down
6 changes: 6 additions & 0 deletions charts/opentelemetry-collector/ci/hpa-deployment-values.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
mode: deployment

image:
repository: "otel/opentelemetry-collector-k8s"

command:
name: "otelcol-k8s"

autoscaling:
enabled: true
minReplicas: 1
Expand Down
6 changes: 6 additions & 0 deletions charts/opentelemetry-collector/ci/hpa-statefulset-values.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
mode: statefulset

image:
repository: "otel/opentelemetry-collector-k8s"

command:
name: "otelcol-k8s"

autoscaling:
enabled: true
minReplicas: 1
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
mode: deployment

image:
repository: "otel/opentelemetry-collector-k8s"

command:
name: "otelcol-k8s"

resources:
limits:
cpu: 100m
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,11 @@
mode: daemonset

image:
repository: "otel/opentelemetry-collector-k8s"

command:
name: "otelcol-k8s"

resources:
limits:
cpu: 100m
Expand Down
7 changes: 7 additions & 0 deletions charts/opentelemetry-collector/ci/networkpolicy-values.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,11 @@
mode: deployment

image:
repository: "otel/opentelemetry-collector-k8s"

command:
name: "otelcol-k8s"

resources:
limits:
cpu: 100m
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
mode: deployment

image:
repository: "otel/opentelemetry-collector-k8s"

command:
name: "otelcol-k8s"

presets:
clusterMetrics:
enabled: true
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
mode: daemonset

image:
repository: "otel/opentelemetry-collector-k8s"

command:
name: "otelcol-k8s"

presets:
hostMetrics:
enabled: true
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
mode: deployment

image:
repository: "otel/opentelemetry-collector-k8s"

command:
name: "otelcol-k8s"

presets:
kubernetesEvents:
enabled: true
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
mode: daemonset

image:
repository: "otel/opentelemetry-collector-k8s"

command:
name: "otelcol-k8s"

presets:
kubeletMetrics:
enabled: true
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
mode: daemonset

image:
repository: "otel/opentelemetry-collector-k8s"

command:
name: "otelcol-k8s"

presets:
kubernetesAttributes:
enabled: true
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
mode: daemonset

image:
repository: "otel/opentelemetry-collector-k8s"

command:
name: "otelcol-k8s"

presets:
logsCollection:
enabled: true
Expand Down
6 changes: 6 additions & 0 deletions charts/opentelemetry-collector/ci/probes-values.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
mode: daemonset

image:
repository: "otel/opentelemetry-collector-k8s"

command:
name: "otelcol-k8s"

livenessProbe:
initialDelaySeconds: 10
periodSeconds: 5
Expand Down
7 changes: 7 additions & 0 deletions charts/opentelemetry-collector/ci/statefulset-values.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,11 @@
mode: statefulset

image:
repository: "otel/opentelemetry-collector-k8s"

command:
name: "otelcol-k8s"

replicaCount: 2
resources:
limits:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
mode: daemonset

image:
repository: "otel/opentelemetry-collector-k8s"

command:
name: "otelcol-k8s"

config:
exporters:
otlp:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
mode: deployment

image:
repository: "otel/opentelemetry-collector-k8s"

command:
name: "otelcol-k8s"

resources:
limits:
cpu: 100m
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ metadata:
name: example-opentelemetry-collector-agent
namespace: default
labels:
helm.sh/chart: opentelemetry-collector-0.88.0
helm.sh/chart: opentelemetry-collector-0.89.0
app.kubernetes.io/name: opentelemetry-collector
app.kubernetes.io/instance: example
app.kubernetes.io/version: "0.98.0"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ metadata:
name: example-opentelemetry-collector
namespace: default
labels:
helm.sh/chart: opentelemetry-collector-0.88.0
helm.sh/chart: opentelemetry-collector-0.89.0
app.kubernetes.io/name: opentelemetry-collector
app.kubernetes.io/instance: example
app.kubernetes.io/version: "0.98.0"
Expand Down
Loading

0 comments on commit 8467a3e

Please sign in to comment.