Merge pull request #8097 from Lyndon-Li/issue-fix-8032

Issue 8032: make node agent configMap name configurable

pkg/cmd/cli/nodeagent/server.go

@@ -84,6 +84,7 @@ type nodeAgentServerConfig struct {
 	metricsAddress          string
 	resourceTimeout         time.Duration
 	dataMoverPrepareTimeout time.Duration
+	nodeAgentConfig         string
 }
 
 func NewServerCommand(f client.Factory) *cobra.Command {
@@ -120,6 +121,7 @@ func NewServerCommand(f client.Factory) *cobra.Command {
 	command.Flags().DurationVar(&config.resourceTimeout, "resource-timeout", config.resourceTimeout, "How long to wait for resource processes which are not covered by other specific timeout parameters. Default is 10 minutes.")
 	command.Flags().DurationVar(&config.dataMoverPrepareTimeout, "data-mover-prepare-timeout", config.dataMoverPrepareTimeout, "How long to wait for preparing a DataUpload/DataDownload. Default is 30 minutes.")
 	command.Flags().StringVar(&config.metricsAddress, "metrics-address", config.metricsAddress, "The address to expose prometheus metrics")
+	command.Flags().StringVar(&config.nodeAgentConfig, "node-agent-config", config.nodeAgentConfig, "The name of configMap containing node-agent configurations.")
 
 	return command
 }
@@ -456,14 +458,14 @@ func (s *nodeAgentServer) markInProgressPVRsFailed(client ctrlclient.Client) {
 var getConfigsFunc = nodeagent.GetConfigs
 
 func (s *nodeAgentServer) getDataPathConfigs() {
-	configs, err := getConfigsFunc(s.ctx, s.namespace, s.kubeClient)
-	if err != nil {
-		s.logger.WithError(err).Warn("Failed to get node agent configs")
+	if s.config.nodeAgentConfig == "" {
+		s.logger.Info("No node-agent configMap is specified")
 		return
 	}
 
-	if configs == nil {
-		s.logger.Infof("Node agent configs are not found")
+	configs, err := getConfigsFunc(s.ctx, s.namespace, s.kubeClient, s.config.nodeAgentConfig)
+	if err != nil {
+		s.logger.WithError(err).Warnf("Failed to get node agent configs from configMap %s, ignore it", s.config.nodeAgentConfig)
 		return
 	}
 

pkg/cmd/cli/nodeagent/server_test.go

@@ -17,12 +17,12 @@ package nodeagent
 
 import (
 	"context"
+	"errors"
 	"fmt"
 	"os"
 	"path/filepath"
 	"testing"
 
-	"github.com/pkg/errors"
 	"github.com/stretchr/testify/assert"
 	corev1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
@@ -122,28 +122,36 @@ func Test_getDataPathConfigs(t *testing.T) {
 
 	tests := []struct {
 		name          string
-		getFunc       func(context.Context, string, kubernetes.Interface) (*nodeagent.Configs, error)
+		getFunc       func(context.Context, string, kubernetes.Interface, string) (*nodeagent.Configs, error)
+		configMapName string
 		expectConfigs *nodeagent.Configs
 		expectLog     string
 	}{
 		{
-			name: "failed to get configs",
-			getFunc: func(context.Context, string, kubernetes.Interface) (*nodeagent.Configs, error) {
-				return nil, errors.New("fake-get-error")
-			},
-			expectLog: "Failed to get node agent configs",
+			name:      "no config specified",
+			expectLog: "No node-agent configMap is specified",
 		},
 		{
-			name: "configs cm not found",
-			getFunc: func(context.Context, string, kubernetes.Interface) (*nodeagent.Configs, error) {
-				return nil, nil
+			name:          "failed to get configs",
+			configMapName: "node-agent-config",
+			getFunc: func(context.Context, string, kubernetes.Interface, string) (*nodeagent.Configs, error) {
+				return nil, errors.New("fake-get-error")
 			},
-			expectLog: "Node agent configs are not found",
+			expectLog: "Failed to get node agent configs from configMap node-agent-config, ignore it",
+		},
+		{
+			name:          "configs cm not found",
+			configMapName: "node-agent-config",
+			getFunc: func(context.Context, string, kubernetes.Interface, string) (*nodeagent.Configs, error) {
+				return nil, errors.New("fake-not-found-error")
+			},
+			expectLog: "Failed to get node agent configs from configMap node-agent-config, ignore it",
 		},
 
 		{
-			name: "succeed",
-			getFunc: func(context.Context, string, kubernetes.Interface) (*nodeagent.Configs, error) {
+			name:          "succeed",
+			configMapName: "node-agent-config",
+			getFunc: func(context.Context, string, kubernetes.Interface, string) (*nodeagent.Configs, error) {
 				return configs, nil
 			},
 			expectConfigs: configs,
@@ -155,6 +163,9 @@ func Test_getDataPathConfigs(t *testing.T) {
 			logBuffer := ""
 
 			s := &nodeAgentServer{
+				config: nodeAgentServerConfig{
+					nodeAgentConfig: test.configMapName,
+				},
 				logger: testutil.NewSingleLogger(&logBuffer),
 			}
 

pkg/nodeagent/node_agent.go

@@ -34,8 +34,7 @@ import (
 
 const (
 	// daemonSet is the name of the Velero node agent daemonset.
-	daemonSet  = "node-agent"
-	configName = "node-agent-config"
+	daemonSet = "node-agent"
 )
 
 var (
@@ -132,14 +131,10 @@ func GetPodSpec(ctx context.Context, kubeClient kubernetes.Interface, namespace
 	return &ds.Spec.Template.Spec, nil
 }
 
-func GetConfigs(ctx context.Context, namespace string, kubeClient kubernetes.Interface) (*Configs, error) {
+func GetConfigs(ctx context.Context, namespace string, kubeClient kubernetes.Interface, configName string) (*Configs, error) {
 	cm, err := kubeClient.CoreV1().ConfigMaps(namespace).Get(ctx, configName, metav1.GetOptions{})
 	if err != nil {
-		if apierrors.IsNotFound(err) {
-			return nil, nil
-		} else {
-			return nil, errors.Wrapf(err, "error to get node agent configs %s", configName)
-		}
+		return nil, errors.Wrapf(err, "error to get node agent configs %s", configName)
 	}
 
 	if cm.Data == nil {

pkg/nodeagent/node_agent_test.go

@@ -254,10 +254,6 @@ func TestGetConfigs(t *testing.T) {
 		expectResult  *Configs
 		expectErr     string
 	}{
-		{
-			name:      "cm is not found",
-			namespace: "fake-ns",
-		},
 		{
 			name:      "cm get error",
 			namespace: "fake-ns",
@@ -318,7 +314,7 @@ func TestGetConfigs(t *testing.T) {
 				fakeKubeClient.Fake.PrependReactor(reactor.verb, reactor.resource, reactor.reactorFunc)
 			}
 
-			result, err := GetConfigs(context.TODO(), test.namespace, fakeKubeClient)
+			result, err := GetConfigs(context.TODO(), test.namespace, fakeKubeClient, "node-agent-config")
 			if test.expectErr == "" {
 				assert.NoError(t, err)