[collector] Remove default collector image #1148
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dmitryax
approved these changes
Apr 16, 2024
jaronoff97
reviewed
Apr 17, 2024
|
|
||
| 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 and command name. If you are already explicitly setting an image repository and command name 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. |
There was a problem hiding this comment.
why are we looking to move away from the contrib distribution in the helm chart?
There was a problem hiding this comment.
contrib really isn't meant to be run in a production setting (doc). Contrib contains every component with stability greater than or equal to alpha, which means it probably has a lot of stuff the average user doesn't need. This opens up a potential attack vector if there's a vuln in one of said components that users are unknowingly pulling in. It also means that the overall image size is much larger than you may need which would result in worse first-pull latency. There are a few other reasons that are documented around, but these are the two biggest IMO.
JaredTan95
approved these changes
Apr 19, 2024
rnishtala-sumo
approved these changes
Apr 19, 2024
dmitryax
approved these changes
Apr 19, 2024
12ushan
pushed a commit
to giffgaff/opentelemetry-helm-charts
that referenced
this pull request
Jul 22, 2024
* Remove default collector image * fix command * regen examples * Remove command name restriction * Adding warning
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Works towards #1135
This PR removes the default
image.repositoryandcommand.namefrom the collector chart so that installs/upgrades fail for users depending on the previously setcontribimage.Adds a new section to UPGRADING.md to guide users through this failure.