Implement priority class support for Velero components

- Add --server-priority-class-name flag for Velero server deployment
- Add --node-agent-priority-class-name flag for node agent daemonset
- Add ServerPriorityClassName and NodeAgentPriorityClassName to VeleroOptions
- Add PriorityClassName field to JobConfigs struct for maintenance jobs
- Maintenance jobs get priority class from configmap (global config only)
- Data mover pods get priority class from node-agent-configmap
- Add tests for priority class functionality

This allows different Velero components to use different priority classes
based on their importance and resource requirements.

Signed-off-by: Tiger Kaovilai <tkaovila@redhat.com>

codespell

Signed-off-by: Tiger Kaovilai <tkaovila@redhat.com>

Author: kaovilai

changelogs/unreleased/8883-kaovilai

@@ -0,0 +1 @@
+Implement PriorityClass Support

pkg/cmd/cli/install/install.go

@@ -17,6 +17,7 @@ limitations under the License.
 package install
 
 import (
+	"context"
 	"fmt"
 	"os"
 	"path/filepath"
@@ -26,6 +27,7 @@ import (
 	"github.com/vmware-tanzu/velero/pkg/uploader"
 
 	"github.com/pkg/errors"
+	"github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
 	"github.com/spf13/pflag"
 	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
@@ -90,6 +92,8 @@ type Options struct {
 	NodeAgentConfigMap              string
 	ItemBlockWorkerCount            int
 	NodeAgentDisableHostPath        bool
+	ServerPriorityClassName         string
+	NodeAgentPriorityClassName      string
 }
 
 // BindFlags adds command line values to the options struct.
@@ -191,6 +195,18 @@ func (o *Options) BindFlags(flags *pflag.FlagSet) {
 		o.ItemBlockWorkerCount,
 		"Number of worker threads to process ItemBlocks. Default is one. Optional.",
 	)
+	flags.StringVar(
+		&o.ServerPriorityClassName,
+		"server-priority-class-name",
+		o.ServerPriorityClassName,
+		"Priority class name for the Velero server deployment. Optional.",
+	)
+	flags.StringVar(
+		&o.NodeAgentPriorityClassName,
+		"node-agent-priority-class-name",
+		o.NodeAgentPriorityClassName,
+		"Priority class name for the node agent daemonset. Optional.",
+	)
 }
 
 // NewInstallOptions instantiates a new, default InstallOptions struct.
@@ -296,6 +312,8 @@ func (o *Options) AsVeleroOptions() (*install.VeleroOptions, error) {
 		NodeAgentConfigMap:              o.NodeAgentConfigMap,
 		ItemBlockWorkerCount:            o.ItemBlockWorkerCount,
 		NodeAgentDisableHostPath:        o.NodeAgentDisableHostPath,
+		ServerPriorityClassName:         o.ServerPriorityClassName,
+		NodeAgentPriorityClassName:      o.NodeAgentPriorityClassName,
 	}, nil
 }
 
@@ -384,6 +402,23 @@ func (o *Options) Run(c *cobra.Command, f client.Factory) error {
 	if err != nil {
 		return err
 	}
+
+	// Get Kubernetes client for priority class validation
+	kubeClient, err := f.KubeClient()
+	if err != nil {
+		return err
+	}
+
+	// Validate priority classes if specified
+	logger := logrus.New()
+	logger.SetOutput(os.Stdout)
+	if o.ServerPriorityClassName != "" {
+		kubeutil.ValidatePriorityClass(context.Background(), kubeClient, o.ServerPriorityClassName, logger.WithField("component", "server"))
+	}
+	if o.NodeAgentPriorityClassName != "" {
+		kubeutil.ValidatePriorityClass(context.Background(), kubeClient, o.NodeAgentPriorityClassName, logger.WithField("component", "node-agent"))
+	}
+
 	errorMsg := fmt.Sprintf("\n\nError installing Velero. Use `kubectl logs deploy/velero -n %s` to check the deploy logs", o.Namespace)
 
 	err = install.Install(dynamicFactory, kbClient, resources, os.Stdout)

pkg/cmd/cli/install/install_test.go

@@ -0,0 +1,93 @@
+/*
+Copyright the Velero contributors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package install
+
+import (
+	"testing"
+
+	"github.com/spf13/pflag"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+func TestPriorityClassNameFlag(t *testing.T) {
+	// Test that the flag is properly defined
+	o := NewInstallOptions()
+	flags := pflag.NewFlagSet("test", pflag.ContinueOnError)
+	o.BindFlags(flags)
+
+	// Verify the server priority class flag exists
+	serverFlag := flags.Lookup("server-priority-class-name")
+	assert.NotNil(t, serverFlag, "server-priority-class-name flag should exist")
+	assert.Equal(t, "Priority class name for the Velero server deployment. Optional.", serverFlag.Usage)
+
+	// Verify the node agent priority class flag exists
+	nodeAgentFlag := flags.Lookup("node-agent-priority-class-name")
+	assert.NotNil(t, nodeAgentFlag, "node-agent-priority-class-name flag should exist")
+	assert.Equal(t, "Priority class name for the node agent daemonset. Optional.", nodeAgentFlag.Usage)
+
+	// Test with values for both server and node agent
+	testCases := []struct {
+		name                       string
+		serverPriorityClassName    string
+		nodeAgentPriorityClassName string
+		expectedServerValue        string
+		expectedNodeAgentValue     string
+	}{
+		{
+			name:                       "with both priority class names",
+			serverPriorityClassName:    "high-priority",
+			nodeAgentPriorityClassName: "medium-priority",
+			expectedServerValue:        "high-priority",
+			expectedNodeAgentValue:     "medium-priority",
+		},
+		{
+			name:                       "with only server priority class name",
+			serverPriorityClassName:    "high-priority",
+			nodeAgentPriorityClassName: "",
+			expectedServerValue:        "high-priority",
+			expectedNodeAgentValue:     "",
+		},
+		{
+			name:                       "with only node agent priority class name",
+			serverPriorityClassName:    "",
+			nodeAgentPriorityClassName: "medium-priority",
+			expectedServerValue:        "",
+			expectedNodeAgentValue:     "medium-priority",
+		},
+		{
+			name:                       "without priority class names",
+			serverPriorityClassName:    "",
+			nodeAgentPriorityClassName: "",
+			expectedServerValue:        "",
+			expectedNodeAgentValue:     "",
+		},
+	}
+
+	for _, tc := range testCases {
+		t.Run(tc.name, func(t *testing.T) {
+			o := NewInstallOptions()
+			o.ServerPriorityClassName = tc.serverPriorityClassName
+			o.NodeAgentPriorityClassName = tc.nodeAgentPriorityClassName
+
+			veleroOptions, err := o.AsVeleroOptions()
+			require.NoError(t, err)
+			assert.Equal(t, tc.expectedServerValue, veleroOptions.ServerPriorityClassName)
+			assert.Equal(t, tc.expectedNodeAgentValue, veleroOptions.NodeAgentPriorityClassName)
+		})
+	}
+}

pkg/cmd/cli/nodeagent/server.go

@@ -340,6 +340,7 @@ func (s *nodeAgentServer) run() {
 		s.config.dataMoverPrepareTimeout,
 		s.logger,
 		s.metrics,
+		s.config.nodeAgentConfig,
 	)
 	if err := dataUploadReconciler.SetupWithManager(s.mgr); err != nil {
 		s.logger.WithError(err).Fatal("Unable to create the data upload controller")
@@ -364,6 +365,7 @@ func (s *nodeAgentServer) run() {
 		s.config.dataMoverPrepareTimeout,
 		s.logger,
 		s.metrics,
+		s.config.nodeAgentConfig,
 	)
 
 	if err := dataDownloadReconciler.SetupWithManager(s.mgr); err != nil {

pkg/controller/data_download_controller.go

@@ -71,6 +71,7 @@ type DataDownloadReconciler struct {
 	preparingTimeout      time.Duration
 	metrics               *metrics.ServerMetrics
 	cancelledDataDownload map[string]time.Time
+	nodeAgentConfigMap    string
 }
 
 func NewDataDownloadReconciler(
@@ -86,6 +87,7 @@ func NewDataDownloadReconciler(
 	preparingTimeout time.Duration,
 	logger logrus.FieldLogger,
 	metrics *metrics.ServerMetrics,
+	nodeAgentConfigMap string,
 ) *DataDownloadReconciler {
 	return &DataDownloadReconciler{
 		client:                client,
@@ -103,6 +105,7 @@ func NewDataDownloadReconciler(
 		preparingTimeout:      preparingTimeout,
 		metrics:               metrics,
 		cancelledDataDownload: make(map[string]time.Time),
+		nodeAgentConfigMap:    nodeAgentConfigMap,
 	}
 }
 
@@ -892,6 +895,8 @@ func (r *DataDownloadReconciler) setupExposeParam(dd *velerov2alpha1api.DataDown
 		NodeOS:                nodeOS,
 		RestorePVCConfig:      r.restorePVCConfig,
 		LoadAffinity:          affinity,
+		NodeAgentNamespace:    dd.Namespace,
+		NodeAgentConfigMap:    r.nodeAgentConfigMap,
 	}, nil
 }
 

pkg/controller/data_download_controller_test.go

@@ -130,19 +130,7 @@ func initDataDownloadReconcilerWithError(t *testing.T, objects []any, needError
 
 	dataPathMgr := datapath.NewManager(1)
 
-	return NewDataDownloadReconciler(
-		&fakeClient,
-		nil,
-		fakeKubeClient,
-		dataPathMgr,
-		nil,
-		nil,
-		nodeagent.RestorePVC{},
-		corev1api.ResourceRequirements{},
-		"test-node",
-		time.Minute*5,
-		velerotest.NewLogger(),
-		metrics.NewServerMetrics()), nil
+	return NewDataDownloadReconciler(&fakeClient, nil, fakeKubeClient, dataPathMgr, nil, nil, nodeagent.RestorePVC{}, corev1api.ResourceRequirements{}, "test-node", time.Minute*5, velerotest.NewLogger(), metrics.NewServerMetrics(), ""), nil
 }
 
 func TestDataDownloadReconcile(t *testing.T) {

pkg/controller/data_upload_controller.go

@@ -81,6 +81,7 @@ type DataUploadReconciler struct {
 	preparingTimeout    time.Duration
 	metrics             *metrics.ServerMetrics
 	cancelledDataUpload map[string]time.Time
+	nodeAgentConfigMap  string
 }
 
 func NewDataUploadReconciler(
@@ -98,6 +99,7 @@ func NewDataUploadReconciler(
 	preparingTimeout time.Duration,
 	log logrus.FieldLogger,
 	metrics *metrics.ServerMetrics,
+	nodeAgentConfigMap string,
 ) *DataUploadReconciler {
 	return &DataUploadReconciler{
 		client:            client,
@@ -122,6 +124,7 @@ func NewDataUploadReconciler(
 		preparingTimeout:    preparingTimeout,
 		metrics:             metrics,
 		cancelledDataUpload: make(map[string]time.Time),
+		nodeAgentConfigMap:  nodeAgentConfigMap,
 	}
 }
 
@@ -973,6 +976,8 @@ func (r *DataUploadReconciler) setupExposeParam(du *velerov2alpha1api.DataUpload
 			BackupPVCConfig:       r.backupPVCConfig,
 			Resources:             r.podResources,
 			NodeOS:                nodeOS,
+			NodeAgentNamespace:    du.Namespace,
+			NodeAgentConfigMap:    r.nodeAgentConfigMap,
 		}, nil
 	}
 

pkg/controller/data_upload_controller_test.go

@@ -249,6 +249,7 @@ func initDataUploaderReconcilerWithError(needError ...error) (*DataUploadReconci
 		time.Minute*5,
 		velerotest.NewLogger(),
 		metrics.NewServerMetrics(),
+		"",
 	), nil
 }
 

pkg/exposer/csi_snapshot.go

@@ -82,6 +82,12 @@ type CSISnapshotExposeParam struct {
 
 	// NodeOS specifies the OS of node that the source volume is attaching
 	NodeOS string
+
+	// NodeAgentNamespace is the namespace where the node agent is running
+	NodeAgentNamespace string
+
+	// NodeAgentConfigMap is the name of the ConfigMap containing node agent configurations
+	NodeAgentConfigMap string
 }
 
 // CSISnapshotExposeWaitParam define the input param for WaitExposed of CSI snapshots
@@ -224,6 +230,8 @@ func (e *csiSnapshotExposer) Expose(ctx context.Context, ownerObject corev1api.O
 		backupPVCReadOnly,
 		spcNoRelabeling,
 		csiExposeParam.NodeOS,
+		csiExposeParam.NodeAgentNamespace,
+		csiExposeParam.NodeAgentConfigMap,
 	)
 	if err != nil {
 		return errors.Wrap(err, "error to create backup pod")
@@ -538,6 +546,8 @@ func (e *csiSnapshotExposer) createBackupPod(
 	backupPVCReadOnly bool,
 	spcNoRelabeling bool,
 	nodeOS string,
+	nodeAgentNamespace string,
+	nodeAgentConfigMap string,
 ) (*corev1api.Pod, error) {
 	podName := ownerObject.Name
 
@@ -549,6 +559,16 @@ func (e *csiSnapshotExposer) createBackupPod(
 		return nil, errors.Wrap(err, "error to get inherited pod info from node-agent")
 	}
 
+	// Get the priority class name from node-agent-configmap if available
+	priorityClassName, err := kube.GetDataMoverPriorityClassName(ctx, nodeAgentNamespace, e.kubeClient, nodeAgentConfigMap)
+	if err != nil {
+		e.log.WithError(err).Warn("Failed to get priority class name from node-agent-configmap, using empty value")
+		priorityClassName = ""
+	}
+	if priorityClassName != "" {
+		e.log.Debugf("Setting priority class %q for data mover pod %s", priorityClassName, podName)
+	}
+
 	var gracePeriod int64
 	volumeMounts, volumeDevices, volumePath := kube.MakePodPVCAttachment(volumeName, backupPVC.Spec.VolumeMode, backupPVCReadOnly)
 	volumeMounts = append(volumeMounts, podInfo.volumeMounts...)
@@ -679,6 +699,7 @@ func (e *csiSnapshotExposer) createBackupPod(
 					Resources:     resources,
 				},
 			},
+			PriorityClassName:             priorityClassName,
 			ServiceAccountName:            podInfo.serviceAccount,
 			TerminationGracePeriodSeconds: &gracePeriod,
 			Volumes:                       volumes,