[chore]: Deprecated VolumeSizeLimit in the Instrumentation CRD (#4431)

* fix: deprecate volumeSizeLimit field in instrumentation types

* feat: add deprecation warnings for volumeSizeLimit field in instrumentation spec

* chore: Regenerated bundle and manifests

* fix: minor changes

* fix: updates related to changelog

* bug: Revert rename of volumeLimitSize

* chore: Regenerated bundle and manifests

Author: ShreyashSri

.chloggen/fix_deprecate_VolumeSizeLimit.yaml

@@ -0,0 +1,19 @@
+# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
+change_type: deprecation
+
+# The name of the component, or a single word describing the area of concern, (e.g. collector, target allocator, auto-instrumentation, opamp, github action)
+component: auto-instrumentation
+
+# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Deprecate VolumeSizeLimit in the Instrumentation CRD
+
+# One or more tracking issues related to the change
+issues: [3382]
+
+# (Optional) One or more lines of additional information to render under the primary note.
+# These lines will be padded with 2 spaces and then inserted directly into the document.
+# Use pipe (|) for multiline entries.
+subtext: |
+  - The `volumeSizeLimit` field is deprecated.
+  - Use `spec.<lang>.volume.size` instead of `spec.<lang>.volumeSizeLimit`.
+  - The validating webhook emits a warning when `volumeSizeLimit` is used.

apis/v1alpha1/instrumentation_types.go

@@ -163,6 +163,7 @@ type Java struct {
 
 	// VolumeSizeLimit defines size limit for volume used for auto-instrumentation.
 	// The default size is 200Mi.
+	// Deprecated: use spec.<lang>.volume.size instead. This field will be inactive in a future release.
 	VolumeSizeLimit *resource.Quantity `json:"volumeLimitSize,omitempty"`
 
 	// Env defines java specific env vars. There are four layers for env vars' definitions and
@@ -201,6 +202,7 @@ type NodeJS struct {
 
 	// VolumeSizeLimit defines size limit for volume used for auto-instrumentation.
 	// The default size is 200Mi.
+	// Deprecated: use spec.<lang>.volume.size instead. This field will be inactive in a future release.
 	VolumeSizeLimit *resource.Quantity `json:"volumeLimitSize,omitempty"`
 
 	// Env defines nodejs specific env vars. There are four layers for env vars' definitions and
@@ -226,6 +228,7 @@ type Python struct {
 
 	// VolumeSizeLimit defines size limit for volume used for auto-instrumentation.
 	// The default size is 200Mi.
+	// Deprecated: use spec.<lang>.volume.size instead. This field will be inactive in a future release.
 	VolumeSizeLimit *resource.Quantity `json:"volumeLimitSize,omitempty"`
 
 	// Env defines python specific env vars. There are four layers for env vars' definitions and
@@ -251,6 +254,7 @@ type DotNet struct {
 
 	// VolumeSizeLimit defines size limit for volume used for auto-instrumentation.
 	// The default size is 200Mi.
+	// Deprecated: use spec.<lang>.volume.size instead. This field will be inactive in a future release.
 	VolumeSizeLimit *resource.Quantity `json:"volumeLimitSize,omitempty"`
 
 	// Env defines DotNet specific env vars. There are four layers for env vars' definitions and
@@ -274,6 +278,7 @@ type Go struct {
 
 	// VolumeSizeLimit defines size limit for volume used for auto-instrumentation.
 	// The default size is 200Mi.
+	// Deprecated: use spec.<lang>.volume.size instead. This field will be inactive in a future release.
 	VolumeSizeLimit *resource.Quantity `json:"volumeLimitSize,omitempty"`
 
 	// Env defines Go specific env vars. There are four layers for env vars' definitions and
@@ -299,6 +304,7 @@ type ApacheHttpd struct {
 
 	// VolumeSizeLimit defines size limit for volume used for auto-instrumentation.
 	// The default size is 200Mi.
+	// Deprecated: use spec.<lang>.volume.size instead. This field will be inactive in a future release.
 	VolumeSizeLimit *resource.Quantity `json:"volumeLimitSize,omitempty"`
 
 	// Env defines Apache HTTPD specific env vars. There are four layers for env vars' definitions and
@@ -339,6 +345,7 @@ type Nginx struct {
 
 	// VolumeSizeLimit defines size limit for volume used for auto-instrumentation.
 	// The default size is 200Mi.
+	// Deprecated: use spec.<lang>.volume.size instead. This field will be inactive in a future release.
 	VolumeSizeLimit *resource.Quantity `json:"volumeLimitSize,omitempty"`
 
 	// Env defines Nginx specific env vars. There are four layers for env vars' definitions and

apis/v1alpha1/instrumentation_webhook.go

@@ -259,6 +259,29 @@ func (w InstrumentationWebhook) validate(r *Instrumentation) (admission.Warnings
 
 	warnings = append(warnings, validateExporter(r.Spec.Exporter)...)
 
+	// Deprecated field warnings: spec.<lang>.volumeSizeLimit
+	if r.Spec.Java.VolumeSizeLimit != nil {
+		warnings = append(warnings, "spec.java.volumeSizeLimit is deprecated and will be removed in a future release; use spec.java.volume.size instead")
+	}
+	if r.Spec.NodeJS.VolumeSizeLimit != nil {
+		warnings = append(warnings, "spec.nodejs.volumeSizeLimit is deprecated and will be removed in a future release; use spec.nodejs.volume.size instead")
+	}
+	if r.Spec.Python.VolumeSizeLimit != nil {
+		warnings = append(warnings, "spec.python.volumeSizeLimit is deprecated and will be removed in a future release; use spec.python.volume.size instead")
+	}
+	if r.Spec.DotNet.VolumeSizeLimit != nil {
+		warnings = append(warnings, "spec.dotnet.volumeSizeLimit is deprecated and will be removed in a future release; use spec.dotnet.volume.size instead")
+	}
+	if r.Spec.Go.VolumeSizeLimit != nil {
+		warnings = append(warnings, "spec.go.volumeSizeLimit is deprecated and will be removed in a future release; use spec.go.volume.size instead")
+	}
+	if r.Spec.ApacheHttpd.VolumeSizeLimit != nil {
+		warnings = append(warnings, "spec.apachehttpd.volumeSizeLimit is deprecated and will be removed in a future release; use spec.apachehttpd.volume.size instead")
+	}
+	if r.Spec.Nginx.VolumeSizeLimit != nil {
+		warnings = append(warnings, "spec.nginx.volumeSizeLimit is deprecated and will be removed in a future release; use spec.nginx.volume.size instead")
+	}
+
 	return warnings, nil
 }
 

apis/v1alpha1/instrumentation_webhook_test.go

@@ -621,6 +621,67 @@ func TestInstrumentationValidatingWebhook(t *testing.T) {
 		})
 	}
 }
+func TestInstrumentationValidatingWebhook_DeprecationWarnings(t *testing.T) {
+	defaultSize := resource.MustParse("200Mi")
+
+	tests := []struct {
+		name string
+		inst Instrumentation
+		want string
+	}{
+		{
+			name: "java volumeSizeLimit deprecated",
+			inst: Instrumentation{Spec: InstrumentationSpec{Java: Java{VolumeSizeLimit: &defaultSize}}},
+			want: "spec.java.volumeSizeLimit is deprecated and will be removed in a future release; use spec.java.volume.size instead",
+		},
+		{
+			name: "nodejs volumeSizeLimit deprecated",
+			inst: Instrumentation{Spec: InstrumentationSpec{NodeJS: NodeJS{VolumeSizeLimit: &defaultSize}}},
+			want: "spec.nodejs.volumeSizeLimit is deprecated and will be removed in a future release; use spec.nodejs.volume.size instead",
+		},
+		{
+			name: "python volumeSizeLimit deprecated",
+			inst: Instrumentation{Spec: InstrumentationSpec{Python: Python{VolumeSizeLimit: &defaultSize}}},
+			want: "spec.python.volumeSizeLimit is deprecated and will be removed in a future release; use spec.python.volume.size instead",
+		},
+		{
+			name: "dotnet volumeSizeLimit deprecated",
+			inst: Instrumentation{Spec: InstrumentationSpec{DotNet: DotNet{VolumeSizeLimit: &defaultSize}}},
+			want: "spec.dotnet.volumeSizeLimit is deprecated and will be removed in a future release; use spec.dotnet.volume.size instead",
+		},
+		{
+			name: "go volumeSizeLimit deprecated",
+			inst: Instrumentation{Spec: InstrumentationSpec{Go: Go{VolumeSizeLimit: &defaultSize}}},
+			want: "spec.go.volumeSizeLimit is deprecated and will be removed in a future release; use spec.go.volume.size instead",
+		},
+		{
+			name: "apachehttpd volumeSizeLimit deprecated",
+			inst: Instrumentation{Spec: InstrumentationSpec{ApacheHttpd: ApacheHttpd{VolumeSizeLimit: &defaultSize}}},
+			want: "spec.apachehttpd.volumeSizeLimit is deprecated and will be removed in a future release; use spec.apachehttpd.volume.size instead",
+		},
+		{
+			name: "nginx volumeSizeLimit deprecated",
+			inst: Instrumentation{Spec: InstrumentationSpec{Nginx: Nginx{VolumeSizeLimit: &defaultSize}}},
+			want: "spec.nginx.volumeSizeLimit is deprecated and will be removed in a future release; use spec.nginx.volume.size instead",
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			warnings, err := InstrumentationWebhook{}.ValidateCreate(context.Background(), &tt.inst)
+			assert.NoError(t, err)
+
+			found := false
+			for _, w := range warnings {
+				if w == tt.want {
+					found = true
+					break
+				}
+			}
+			assert.True(t, found, "expected warnings to contain %q, got %v", tt.want, warnings)
+		})
+	}
+}
 
 func TestInstrumentationJaegerRemote(t *testing.T) {
 	tests := []struct {

bundle/community/manifests/opentelemetry-operator.clusterserviceversion.yaml

@@ -99,7 +99,7 @@ metadata:
     categories: Logging & Tracing,Monitoring
     certified: "false"
     containerImage: ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator
-    createdAt: "2025-10-17T09:24:13Z"
+    createdAt: "2025-10-23T18:06:48Z"
     description: Provides the OpenTelemetry components, including the Collector
     operators.operatorframework.io/builder: operator-sdk-v1.29.0
     operators.operatorframework.io/project_layout: go.kubebuilder.io/v3

bundle/openshift/manifests/opentelemetry-operator.clusterserviceversion.yaml

@@ -99,7 +99,7 @@ metadata:
     categories: Logging & Tracing,Monitoring
     certified: "false"
     containerImage: ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator
-    createdAt: "2025-10-17T09:24:14Z"
+    createdAt: "2025-10-23T18:06:48Z"
     description: Provides the OpenTelemetry components, including the Collector
     operators.operatorframework.io/builder: operator-sdk-v1.29.0
     operators.operatorframework.io/project_layout: go.kubebuilder.io/v3

docs/api/instrumentations.md

@@ -270,7 +270,8 @@ If omitted, an emptyDir is used with size limit VolumeSizeLimit<br/>
         <td>int or string</td>
         <td>
           VolumeSizeLimit defines size limit for volume used for auto-instrumentation.
-The default size is 200Mi.<br/>
+The default size is 200Mi.
+Deprecated: use spec.<lang>.volume.size instead. This field will be inactive in a future release.<br/>
         </td>
         <td>false</td>
       </tr></tbody>
@@ -1453,7 +1454,8 @@ If omitted, an emptyDir is used with size limit VolumeSizeLimit<br/>
         <td>int or string</td>
         <td>
           VolumeSizeLimit defines size limit for volume used for auto-instrumentation.
-The default size is 200Mi.<br/>
+The default size is 200Mi.
+Deprecated: use spec.<lang>.volume.size instead. This field will be inactive in a future release.<br/>
         </td>
         <td>false</td>
       </tr></tbody>
@@ -2708,7 +2710,8 @@ If omitted, an emptyDir is used with size limit VolumeSizeLimit<br/>
         <td>int or string</td>
         <td>
           VolumeSizeLimit defines size limit for volume used for auto-instrumentation.
-The default size is 200Mi.<br/>
+The default size is 200Mi.
+Deprecated: use spec.<lang>.volume.size instead. This field will be inactive in a future release.<br/>
         </td>
         <td>false</td>
       </tr></tbody>
@@ -3598,7 +3601,8 @@ If omitted, an emptyDir is used with size limit VolumeSizeLimit<br/>
         <td>int or string</td>
         <td>
           VolumeSizeLimit defines size limit for volume used for auto-instrumentation.
-The default size is 200Mi.<br/>
+The default size is 200Mi.
+Deprecated: use spec.<lang>.volume.size instead. This field will be inactive in a future release.<br/>
         </td>
         <td>false</td>
       </tr></tbody>
@@ -4531,7 +4535,8 @@ If omitted, an emptyDir is used with size limit VolumeSizeLimit<br/>
         <td>int or string</td>
         <td>
           VolumeSizeLimit defines size limit for volume used for auto-instrumentation.
-The default size is 200Mi.<br/>
+The default size is 200Mi.
+Deprecated: use spec.<lang>.volume.size instead. This field will be inactive in a future release.<br/>
         </td>
         <td>false</td>
       </tr></tbody>
@@ -5683,7 +5688,8 @@ If omitted, an emptyDir is used with size limit VolumeSizeLimit<br/>
         <td>int or string</td>
         <td>
           VolumeSizeLimit defines size limit for volume used for auto-instrumentation.
-The default size is 200Mi.<br/>
+The default size is 200Mi.
+Deprecated: use spec.<lang>.volume.size instead. This field will be inactive in a future release.<br/>
         </td>
         <td>false</td>
       </tr></tbody>
@@ -6565,7 +6571,8 @@ If omitted, an emptyDir is used with size limit VolumeSizeLimit<br/>
         <td>int or string</td>
         <td>
           VolumeSizeLimit defines size limit for volume used for auto-instrumentation.
-The default size is 200Mi.<br/>
+The default size is 200Mi.
+Deprecated: use spec.<lang>.volume.size instead. This field will be inactive in a future release.<br/>
         </td>
         <td>false</td>
       </tr></tbody>