Return an empty, valid configuration struct in v1alpha1 conversion webhook #4289
Conversation
This file contains hidden or 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
|
@CodiumAI-Agent /review |
This change is meant to make the conversion webhook to be more resilient in the face of invalid input. It is rare, though possible, for an opentelemetrycollector custom resource to be stored as a v1alpha1 version and with an invalid configuration. With an older version of the operator running this would simply result in no collector starting due to an invalid configuration. However, once the operator is updated to a new enough version where v1beta1 is the stored version, this invalid configuration will result in the conversion webhook failing. After several minutes the operator will crash. On a production cluster we had this situation result in the resource quota controller failing to initialize after a control-plane upgrade. This resulted in an incident where new jobs could not be created.
bderrly
force-pushed
the
api-conversion-resilience
branch
from
f059f52 to
780bc39
Compare
|
Thanks for taking a look @frzifus. I added the changelog file as well as an e2e test. |
frzifus
approved these changes
Aug 21, 2025
iblancasa
approved these changes
Aug 25, 2025
pavolloffay
reviewed
Aug 25, 2025
| @@ -0,0 +1,19 @@ | |||
| apiVersion: opentelemetry.io/v1alpha1 | |||
There was a problem hiding this comment.
does v1beta1 fail on the admision with this config?
There was a problem hiding this comment.
Yes, since Config changed from string to an object:
Error from server: error when creating "otel-test.yaml": admission webhook "mopentelemetrycollectorbeta.kb.io" denied the request: json: cannot unmarshal string into Go struct field OpenTelemetryCollectorSpec.spec.config of type v1beta1.Config
swiatekm
approved these changes
Aug 29, 2025
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.
Description: Returns a valid, empty configuration struct in the v1alpha1 conversion webhook rather than returning a failure.
Link to tracking Issue(s): #4288
Testing: Added a few tests with invalid YAML configuration strings to ensure that a valid configuration, and no error, is returned from the webhook.
Documentation: None