opentelemetry-operator icon indicating copy to clipboard operation
opentelemetry-operator copied to clipboard

Deprecate `VolumeSizeLimit` in the Instrumentation CRD

Open swiatekm opened this issue 1 year ago • 1 comments
trafficstars

Component(s)

auto-instrumentation

Describe the issue you're reporting

With https://github.com/open-telemetry/opentelemetry-operator/pull/3285, it's possible to customize the instrumentation volume more deeply in general, including changing the size. Changing the volume size limit can now be accomplished by using a custom volume, so the individual attribute isn't necessary anymore.

There is no formal way of deprecating a CRD field, so what we should do here is:

  1. Add a deprecation warning to the field description.
  2. Emit a warning in the admission webhook if the field is set.

swiatekm avatar Oct 23 '24 09:10 swiatekm

discussed at sig meeting. No objections.

pavolloffay avatar Nov 07 '24 17:11 pavolloffay

Hi @pavolloffay , @swiatekm ,

From what I understand, the usual procedure to deprecate fields in a CRD is to define a new version (e.g., v1alpha2) and set served: false on the previous version.

Please let me know if I’m mistaken. I’m new to this project, so I may not be aware of other constraints or considerations.

If it’s okay, could you please assign this issue to me? I would love to work on it and learn more about the project.

Thanks!

apt-x4869 avatar Sep 14 '25 21:09 apt-x4869

@apt-x4869 we are planning to release a new version of the Instrumentation CRD, but before we do that, we want to indicate to users that this field will be removed in the new version. That is what this issue is about. If you'd like to work on it, then original comment has information on what actually needs to be done.

swiatekm avatar Sep 15 '25 16:09 swiatekm

@swiatekm I would like to work on this issue

ShreyashSri avatar Oct 12 '25 18:10 ShreyashSri