apply recommendations

Signed-off-by: Benedikt Bongartz <[email protected]>

Author: frzifus

.chloggen/native_sidecar.yaml

@@ -2,7 +2,7 @@
 change_type: enhancement
 
 # 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: pkg/sidecar
+component: collector
 
 # A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
 note: Add native sidecar injection behind a feature gate which is disabled by default.
@@ -13,4 +13,9 @@ issues: [2376]
 # (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:
+subtext: |
+  Native sidecars are supported since Kubernetes version `1.28` and are availabe by default since `1.29`.
+  To use native sidecars on Kubernetes v1.28 make sure the "SidecarContainers" feature gate on kubernetes is enabled.
+  If native sidecars are available, the operator can be advised to use them by adding adding
+  the `--feature-gates=operator.sidecarcontainers.native` to the Operator args.
+  In the future this may will become availabe as deployment mode on the Collector CR. See [#3356](https://github.com/open-telemetry/opentelemetry-operator/issues/3356)

pkg/sidecar/pod.go

@@ -70,34 +70,34 @@ func add(cfg config.Config, logger logr.Logger, otelcol v1beta1.OpenTelemetryCol
 	return pod, nil
 }
 
+func isOtelColContainer(c corev1.Container) bool { return c.Name == naming.Container() }
+
 // remove the sidecar container from the given pod.
 func remove(pod corev1.Pod) corev1.Pod {
 	if !existsIn(pod) {
 		return pod
 	}
 
-	fn := func(c corev1.Container) bool { return c.Name == naming.Container() }
-	pod.Spec.Containers = slices.DeleteFunc(pod.Spec.Containers, fn)
+	pod.Spec.Containers = slices.DeleteFunc(pod.Spec.Containers, isOtelColContainer)
 
 	if featuregate.EnableNativeSidecarContainers.IsEnabled() {
 		// NOTE: we also remove init containers (native sidecars) since k8s 1.28.
 		// This should have no side effects.
-		pod.Spec.InitContainers = slices.DeleteFunc(pod.Spec.InitContainers, fn)
+		pod.Spec.InitContainers = slices.DeleteFunc(pod.Spec.InitContainers, isOtelColContainer)
 	}
 	return pod
 }
 
 // existsIn checks whether a sidecar container exists in the given pod.
 func existsIn(pod corev1.Pod) bool {
-	fn := func(c corev1.Container) bool { return c.Name == naming.Container() }
-	if slices.ContainsFunc(pod.Spec.Containers, fn) {
+	if slices.ContainsFunc(pod.Spec.Containers, isOtelColContainer) {
 		return true
 	}
 
 	if featuregate.EnableNativeSidecarContainers.IsEnabled() {
 		// NOTE: we also check init containers (native sidecars) since k8s 1.28.
 		// This should have no side effects.
-		if slices.ContainsFunc(pod.Spec.InitContainers, fn) {
+		if slices.ContainsFunc(pod.Spec.InitContainers, isOtelColContainer) {
 			return true
 		}
 	}

pkg/sidecar/pod_test.go

@@ -32,7 +32,7 @@ import (
 
 var logger = logf.Log.WithName("unit-tests")
 
-func sidecarFeatureGate(t *testing.T) {
+func enableSidecarFeatureGate(t *testing.T) {
 	originalVal := featuregate.EnableNativeSidecarContainers.IsEnabled()
 	t.Logf("original is: %+v", originalVal)
 	require.NoError(t, colfeaturegate.GlobalRegistry().Set(featuregate.EnableNativeSidecarContainers.ID(), true))
@@ -42,7 +42,7 @@ func sidecarFeatureGate(t *testing.T) {
 }
 
 func TestAddNativeSidecar(t *testing.T) {
-	sidecarFeatureGate(t)
+	enableSidecarFeatureGate(t)
 	// prepare
 	pod := corev1.Pod{
 		Spec: corev1.PodSpec{
@@ -269,7 +269,7 @@ func TestRemoveNonExistingSidecar(t *testing.T) {
 }
 
 func TestExistsIn(t *testing.T) {
-	sidecarFeatureGate(t)
+	enableSidecarFeatureGate(t)
 
 	for _, tt := range []struct {
 		desc     string

tests/e2e-native-sidecar/00-assert.yaml

@@ -10,6 +10,7 @@ spec:
   - name: myapp
   initContainers:
   - name: otc-container
+    restartPolicy: Always
 status:
   containerStatuses:
   - name: myapp

tests/e2e-native-sidecar/00-install.yaml

@@ -35,7 +35,7 @@ metadata:
 spec:
   containers:
   - name: myapp
-    image: jaegertracing/vertx-create-span:operator-e2e-tests
+    image: ghcr.io/open-telemetry/opentelemetry-operator/e2e-test-app-python:main
     ports:
       - containerPort: 8080
         protocol: TCP