Add support for priorityClassName for collector (#1178)

apis/v1alpha1/opentelemetrycollector_types.go

@@ -138,6 +138,11 @@ type OpenTelemetryCollectorSpec struct {
 	// HostNetwork indicates if the pod should run in the host networking namespace.
 	// +optional
 	HostNetwork bool `json:"hostNetwork,omitempty"`
+	// If specified, indicates the pod's priority.
+	// If not specified, the pod priority will be default or zero if there is no
+	// default.
+	// +optional
+	PriorityClassName string `json:"priorityClassName,omitempty"`
 }
 
 // OpenTelemetryTargetAllocator defines the configurations for the Prometheus target allocator.

apis/v1alpha1/opentelemetrycollector_webhook.go

@@ -108,6 +108,11 @@ func (r *OpenTelemetryCollector) validateCRDSpec() error {
 		return fmt.Errorf("the OpenTelemetry Collector mode is set to %s, which does not support the attribute 'tolerations'", r.Spec.Mode)
 	}
 
+	// validate priorityClassName
+	if r.Spec.Mode == ModeSidecar && r.Spec.PriorityClassName != "" {
+		return fmt.Errorf("the OpenTelemetry Collector mode is set to %s, which does not support the attribute 'priorityClassName'", r.Spec.Mode)
+	}
+
 	// validate target allocation
 	if r.Spec.TargetAllocator.Enabled && r.Spec.Mode != ModeStatefulSet {
 		return fmt.Errorf("the OpenTelemetry Collector mode is set to %s, which does not support the target allocation deployment", r.Spec.Mode)

apis/v1alpha1/opentelemetrycollector_webhook_test.go

@@ -332,6 +332,16 @@ func TestOTELColValidatingWebhook(t *testing.T) {
 				ModeDeployment, ModeDaemonSet, ModeStatefulSet,
 			),
 		},
+		{
+			name: "invalid mode with priorityClassName",
+			otelcol: OpenTelemetryCollector{
+				Spec: OpenTelemetryCollectorSpec{
+					Mode:              ModeSidecar,
+					PriorityClassName: "test-class",
+				},
+			},
+			expectedErr: "does not support the attribute 'priorityClassName'",
+		},
 	}
 
 	for _, test := range tests {

bundle/manifests/opentelemetry.io_opentelemetrycollectors.yaml

@@ -660,6 +660,10 @@ spec:
                   type: object
                 type: array
                 x-kubernetes-list-type: atomic
+              priorityClassName:
+                description: If specified, indicates the pod's priority. If not specified,
+                  the pod priority will be default or zero if there is no default.
+                type: string
               replicas:
                 description: Replicas is the number of pod instances for the underlying
                   OpenTelemetry Collector. Set this if your are not using autoscaling

config/crd/bases/opentelemetry.io_opentelemetrycollectors.yaml

@@ -658,6 +658,10 @@ spec:
                   type: object
                 type: array
                 x-kubernetes-list-type: atomic
+              priorityClassName:
+                description: If specified, indicates the pod's priority. If not specified,
+                  the pod priority will be default or zero if there is no default.
+                type: string
               replicas:
                 description: Replicas is the number of pod instances for the underlying
                   OpenTelemetry Collector. Set this if your are not using autoscaling

docs/api.md

@@ -1802,6 +1802,13 @@ OpenTelemetryCollectorSpec defines the desired state of OpenTelemetryCollector.
           Ports allows a set of ports to be exposed by the underlying v1.Service. By default, the operator will attempt to infer the required ports by parsing the .Spec.Config property but this property can be used to open additional ports that can't be inferred by the operator, like for custom receivers.<br/>
         </td>
         <td>false</td>
+      </tr><tr>
+        <td><b>priorityClassName</b></td>
+        <td>string</td>
+        <td>
+          If specified, indicates the pod's priority. If not specified, the pod priority will be default or zero if there is no default.<br/>
+        </td>
+        <td>false</td>
       </tr><tr>
         <td><b>replicas</b></td>
         <td>integer</td>

pkg/collector/daemonset.go

@@ -57,6 +57,7 @@ func DaemonSet(cfg config.Config, logger logr.Logger, otelcol v1alpha1.OpenTelem
 					HostNetwork:        otelcol.Spec.HostNetwork,
 					DNSPolicy:          getDnsPolicy(otelcol),
 					SecurityContext:    otelcol.Spec.PodSecurityContext,
+					PriorityClassName:  otelcol.Spec.PriorityClassName,
 				},
 			},
 		},

pkg/collector/daemonset_test.go

@@ -207,3 +207,32 @@ func TestDaemonSetNodeSelector(t *testing.T) {
 	d2 := DaemonSet(cfg, logger, otelcol_2)
 	assert.Equal(t, d2.Spec.Template.Spec.NodeSelector, map[string]string{"node-key": "node-value"})
 }
+
+func TestDaemonSetPriorityClassName(t *testing.T) {
+	otelcol_1 := v1alpha1.OpenTelemetryCollector{
+		ObjectMeta: metav1.ObjectMeta{
+			Name: "my-instance",
+		},
+	}
+
+	cfg := config.New()
+
+	d1 := DaemonSet(cfg, logger, otelcol_1)
+	assert.Empty(t, d1.Spec.Template.Spec.PriorityClassName)
+
+	priorityClassName := "test-class"
+
+	otelcol_2 := v1alpha1.OpenTelemetryCollector{
+		ObjectMeta: metav1.ObjectMeta{
+			Name: "my-instance-priortyClassName",
+		},
+		Spec: v1alpha1.OpenTelemetryCollectorSpec{
+			PriorityClassName: priorityClassName,
+		},
+	}
+
+	cfg = config.New()
+
+	d2 := DaemonSet(cfg, logger, otelcol_2)
+	assert.Equal(t, priorityClassName, d2.Spec.Template.Spec.PriorityClassName)
+}

pkg/collector/deployment.go

@@ -59,6 +59,7 @@ func Deployment(cfg config.Config, logger logr.Logger, otelcol v1alpha1.OpenTele
 					Tolerations:        otelcol.Spec.Tolerations,
 					NodeSelector:       otelcol.Spec.NodeSelector,
 					SecurityContext:    otelcol.Spec.PodSecurityContext,
+					PriorityClassName:  otelcol.Spec.PriorityClassName,
 				},
 			},
 		},

pkg/collector/deployment_test.go

@@ -229,3 +229,32 @@ func TestDeploymentNodeSelector(t *testing.T) {
 	d2 := Deployment(cfg, logger, otelcol_2)
 	assert.Equal(t, d2.Spec.Template.Spec.NodeSelector, map[string]string{"node-key": "node-value"})
 }
+
+func TestDeploymentPriorityClassName(t *testing.T) {
+	otelcol_1 := v1alpha1.OpenTelemetryCollector{
+		ObjectMeta: metav1.ObjectMeta{
+			Name: "my-instance",
+		},
+	}
+
+	cfg := config.New()
+
+	d1 := Deployment(cfg, logger, otelcol_1)
+	assert.Empty(t, d1.Spec.Template.Spec.PriorityClassName)
+
+	priorityClassName := "test-class"
+
+	otelcol_2 := v1alpha1.OpenTelemetryCollector{
+		ObjectMeta: metav1.ObjectMeta{
+			Name: "my-instance-priortyClassName",
+		},
+		Spec: v1alpha1.OpenTelemetryCollectorSpec{
+			PriorityClassName: priorityClassName,
+		},
+	}
+
+	cfg = config.New()
+
+	d2 := Deployment(cfg, logger, otelcol_2)
+	assert.Equal(t, priorityClassName, d2.Spec.Template.Spec.PriorityClassName)
+}

pkg/collector/statefulset.go

@@ -59,6 +59,7 @@ func StatefulSet(cfg config.Config, logger logr.Logger, otelcol v1alpha1.OpenTel
 					Tolerations:        otelcol.Spec.Tolerations,
 					NodeSelector:       otelcol.Spec.NodeSelector,
 					SecurityContext:    otelcol.Spec.PodSecurityContext,
+					PriorityClassName:  otelcol.Spec.PriorityClassName,
 				},
 			},
 			Replicas:             otelcol.Spec.Replicas,

pkg/collector/statefulset_test.go

@@ -288,3 +288,32 @@ func TestStatefulSetNodeSelector(t *testing.T) {
 	d2 := StatefulSet(cfg, logger, otelcol_2)
 	assert.Equal(t, d2.Spec.Template.Spec.NodeSelector, map[string]string{"node-key": "node-value"})
 }
+
+func TestStatefulSetPriorityClassName(t *testing.T) {
+	otelcol_1 := v1alpha1.OpenTelemetryCollector{
+		ObjectMeta: metav1.ObjectMeta{
+			Name: "my-instance",
+		},
+	}
+
+	cfg := config.New()
+
+	sts1 := StatefulSet(cfg, logger, otelcol_1)
+	assert.Empty(t, sts1.Spec.Template.Spec.PriorityClassName)
+
+	priorityClassName := "test-class"
+
+	otelcol_2 := v1alpha1.OpenTelemetryCollector{
+		ObjectMeta: metav1.ObjectMeta{
+			Name: "my-instance-priortyClassName",
+		},
+		Spec: v1alpha1.OpenTelemetryCollectorSpec{
+			PriorityClassName: priorityClassName,
+		},
+	}
+
+	cfg = config.New()
+
+	sts2 := StatefulSet(cfg, logger, otelcol_2)
+	assert.Equal(t, priorityClassName, sts2.Spec.Template.Spec.PriorityClassName)
+}