mirrors/velero
1
0
Fork 0
mirror of https://github.com/vmware-tanzu/velero.git synced 2026-09-04 07:07:11 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add ConfigMap parameters validation for install CLI and server start.

Browse Source 
Signed-off-by: Xun Jiang <xun.jiang@broadcom.com>
This commit is contained in:
Xun Jiang
2025-08-22 20:31:38 +08:00
parent ab8af5cd34
commit c62a486765
21 changed files with 370 additions and 183 deletions
Download Patch File Download Diff File Expand all files Collapse all files
pkg/cmd/cli/nodeagent/server.go
+14 -12
View File
@@ -26,6 +26,7 @@ import (
"time"
"github.com/bombsimon/logrusr/v3"
snapshotv1client "github.com/kubernetes-csi/external-snapshotter/client/v8/clientset/versioned"
"github.com/pkg/errors"
"github.com/prometheus/client_golang/prometheus/promhttp"
"github.com/sirupsen/logrus"
@@ -39,6 +40,7 @@ import (
"k8s.io/apimachinery/pkg/types"
"k8s.io/apimachinery/pkg/util/sets"
"k8s.io/client-go/kubernetes"
cacheutil "k8s.io/client-go/tools/cache"
"k8s.io/klog/v2"
"k8s.io/utils/clock"
ctrl "sigs.k8s.io/controller-runtime"
@@ -46,8 +48,6 @@ import (
ctrlclient "sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/manager"
snapshotv1client "github.com/kubernetes-csi/external-snapshotter/client/v8/clientset/versioned"
velerov1api "github.com/vmware-tanzu/velero/pkg/apis/velero/v1"
velerov2alpha1api "github.com/vmware-tanzu/velero/pkg/apis/velero/v2alpha1"
"github.com/vmware-tanzu/velero/pkg/buildinfo"
@@ -60,11 +60,10 @@ import (
"github.com/vmware-tanzu/velero/pkg/exposer"
"github.com/vmware-tanzu/velero/pkg/metrics"
"github.com/vmware-tanzu/velero/pkg/nodeagent"
velerotypes "github.com/vmware-tanzu/velero/pkg/types"
"github.com/vmware-tanzu/velero/pkg/util/filesystem"
"github.com/vmware-tanzu/velero/pkg/util/kube"
"github.com/vmware-tanzu/velero/pkg/util/logging"
cacheutil "k8s.io/client-go/tools/cache"
)
var (
@@ -140,7 +139,7 @@ type nodeAgentServer struct {
kubeClient kubernetes.Interface
csiSnapshotClient *snapshotv1client.Clientset
dataPathMgr *datapath.Manager
dataPathConfigs *nodeagent.Configs
dataPathConfigs *velerotypes.NodeAgentConfigs
vgdpCounter *exposer.VgdpCounter
}
@@ -252,7 +251,9 @@ func newNodeAgentServer(logger logrus.FieldLogger, factory client.Factory, confi
return nil, err
}
s.getDataPathConfigs()
if err := s.getDataPathConfigs(); err != nil {
return nil, err
}
s.dataPathMgr = datapath.NewManager(s.getDataPathConcurrentNum(defaultDataPathConcurrentNum))
return s, nil
@@ -301,7 +302,7 @@ func (s *nodeAgentServer) run() {
s.logger.Infof("Using customized loadAffinity %v", loadAffinity)
}
var backupPVCConfig map[string]nodeagent.BackupPVC
var backupPVCConfig map[string]velerotypes.BackupPVC
if s.dataPathConfigs != nil && s.dataPathConfigs.BackupPVCConfig != nil {
backupPVCConfig = s.dataPathConfigs.BackupPVCConfig
s.logger.Infof("Using customized backupPVC config %v", backupPVCConfig)
@@ -361,7 +362,7 @@ func (s *nodeAgentServer) run() {
s.logger.WithError(err).Fatal("Unable to create the data upload controller")
}
var restorePVCConfig nodeagent.RestorePVC
var restorePVCConfig velerotypes.RestorePVC
if s.dataPathConfigs != nil && s.dataPathConfigs.RestorePVCConfig != nil {
restorePVCConfig = *s.dataPathConfigs.RestorePVCConfig
s.logger.Infof("Using customized restorePVC config %v", restorePVCConfig)
@@ -546,19 +547,20 @@ func (s *nodeAgentServer) markLegacyPVRsFailed(client ctrlclient.Client) {
var getConfigsFunc = nodeagent.GetConfigs
func (s *nodeAgentServer) getDataPathConfigs() {
func (s *nodeAgentServer) getDataPathConfigs() error {
if s.config.nodeAgentConfig == "" {
s.logger.Info("No node-agent configMap is specified")
return
return nil
}
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
s.logger.WithError(err).Errorf("Failed to get node agent configs from configMap %s, ignore it", s.config.nodeAgentConfig)
return err
}
s.dataPathConfigs = configs
return nil
}
func (s *nodeAgentServer) getDataPathConcurrentNum(defaultNum int) int {
pkg/cmd/cli/nodeagent/server_test.go
+34 -33
View File
@@ -33,6 +33,7 @@ import (
"github.com/vmware-tanzu/velero/pkg/builder"
"github.com/vmware-tanzu/velero/pkg/nodeagent"
testutil "github.com/vmware-tanzu/velero/pkg/test"
velerotypes "github.com/vmware-tanzu/velero/pkg/types"
)
func Test_validatePodVolumesHostPath(t *testing.T) {
@@ -130,17 +131,17 @@ func Test_validatePodVolumesHostPath(t *testing.T) {
}
func Test_getDataPathConfigs(t *testing.T) {
configs := &nodeagent.Configs{
LoadConcurrency: &nodeagent.LoadConcurrency{
configs := &velerotypes.NodeAgentConfigs{
LoadConcurrency: &velerotypes.LoadConcurrency{
GlobalConfig: -1,
},
}
tests := []struct {
name string
getFunc func(context.Context, string, kubernetes.Interface, string) (*nodeagent.Configs, error)
getFunc func(context.Context, string, kubernetes.Interface, string) (*velerotypes.NodeAgentConfigs, error)
configMapName string
expectConfigs *nodeagent.Configs
expectConfigs *velerotypes.NodeAgentConfigs
expectLog string
}{
{
@@ -150,7 +151,7 @@ func Test_getDataPathConfigs(t *testing.T) {
{
name: "failed to get configs",
configMapName: "node-agent-config",
getFunc: func(context.Context, string, kubernetes.Interface, string) (*nodeagent.Configs, error) {
getFunc: func(context.Context, string, kubernetes.Interface, string) (*velerotypes.NodeAgentConfigs, error) {
return nil, errors.New("fake-get-error")
},
expectLog: "Failed to get node agent configs from configMap node-agent-config, ignore it",
@@ -158,7 +159,7 @@ func Test_getDataPathConfigs(t *testing.T) {
{
name: "configs cm not found",
configMapName: "node-agent-config",
getFunc: func(context.Context, string, kubernetes.Interface, string) (*nodeagent.Configs, error) {
getFunc: func(context.Context, string, kubernetes.Interface, string) (*velerotypes.NodeAgentConfigs, error) {
return nil, errors.New("fake-not-found-error")
},
expectLog: "Failed to get node agent configs from configMap node-agent-config, ignore it",
@@ -167,7 +168,7 @@ func Test_getDataPathConfigs(t *testing.T) {
{
name: "succeed",
configMapName: "node-agent-config",
getFunc: func(context.Context, string, kubernetes.Interface, string) (*nodeagent.Configs, error) {
getFunc: func(context.Context, string, kubernetes.Interface, string) (*velerotypes.NodeAgentConfigs, error) {
return configs, nil
},
expectConfigs: configs,
@@ -226,7 +227,7 @@ func Test_getDataPathConcurrentNum(t *testing.T) {
tests := []struct {
name string
configs nodeagent.Configs
configs velerotypes.NodeAgentConfigs
setKubeClient bool
kubeClientObj []runtime.Object
expectNum int
@@ -239,8 +240,8 @@ func Test_getDataPathConcurrentNum(t *testing.T) {
},
{
name: "global number is invalid",
configs: nodeagent.Configs{
LoadConcurrency: &nodeagent.LoadConcurrency{
configs: velerotypes.NodeAgentConfigs{
LoadConcurrency: &velerotypes.LoadConcurrency{
GlobalConfig: -1,
},
},
@@ -249,8 +250,8 @@ func Test_getDataPathConcurrentNum(t *testing.T) {
},
{
name: "global number is valid",
configs: nodeagent.Configs{
LoadConcurrency: &nodeagent.LoadConcurrency{
configs: velerotypes.NodeAgentConfigs{
LoadConcurrency: &velerotypes.LoadConcurrency{
GlobalConfig: globalNum,
},
},
@@ -258,10 +259,10 @@ func Test_getDataPathConcurrentNum(t *testing.T) {
},
{
name: "node is not found",
configs: nodeagent.Configs{
LoadConcurrency: &nodeagent.LoadConcurrency{
configs: velerotypes.NodeAgentConfigs{
LoadConcurrency: &velerotypes.LoadConcurrency{
GlobalConfig: globalNum,
PerNodeConfig: []nodeagent.RuledConfigs{
PerNodeConfig: []velerotypes.RuledConfigs{
{
Number: 100,
},
@@ -274,10 +275,10 @@ func Test_getDataPathConcurrentNum(t *testing.T) {
},
{
name: "failed to get selector",
configs: nodeagent.Configs{
LoadConcurrency: &nodeagent.LoadConcurrency{
configs: velerotypes.NodeAgentConfigs{
LoadConcurrency: &velerotypes.LoadConcurrency{
GlobalConfig: globalNum,
PerNodeConfig: []nodeagent.RuledConfigs{
PerNodeConfig: []velerotypes.RuledConfigs{
{
NodeSelector: invalidLabelSelector,
Number: 100,
@@ -292,10 +293,10 @@ func Test_getDataPathConcurrentNum(t *testing.T) {
},
{
name: "rule number is invalid",
configs: nodeagent.Configs{
LoadConcurrency: &nodeagent.LoadConcurrency{
configs: velerotypes.NodeAgentConfigs{
LoadConcurrency: &velerotypes.LoadConcurrency{
GlobalConfig: globalNum,
PerNodeConfig: []nodeagent.RuledConfigs{
PerNodeConfig: []velerotypes.RuledConfigs{
{
NodeSelector: validLabelSelector1,
Number: -1,
@@ -310,10 +311,10 @@ func Test_getDataPathConcurrentNum(t *testing.T) {
},
{
name: "label doesn't match",
configs: nodeagent.Configs{
LoadConcurrency: &nodeagent.LoadConcurrency{
configs: velerotypes.NodeAgentConfigs{
LoadConcurrency: &velerotypes.LoadConcurrency{
GlobalConfig: globalNum,
PerNodeConfig: []nodeagent.RuledConfigs{
PerNodeConfig: []velerotypes.RuledConfigs{
{
NodeSelector: validLabelSelector1,
Number: -1,
@@ -328,10 +329,10 @@ func Test_getDataPathConcurrentNum(t *testing.T) {
},
{
name: "match one rule",
configs: nodeagent.Configs{
LoadConcurrency: &nodeagent.LoadConcurrency{
configs: velerotypes.NodeAgentConfigs{
LoadConcurrency: &velerotypes.LoadConcurrency{
GlobalConfig: globalNum,
PerNodeConfig: []nodeagent.RuledConfigs{
PerNodeConfig: []velerotypes.RuledConfigs{
{
NodeSelector: validLabelSelector1,
Number: 66,
@@ -346,10 +347,10 @@ func Test_getDataPathConcurrentNum(t *testing.T) {
},
{
name: "match multiple rules",
configs: nodeagent.Configs{
LoadConcurrency: &nodeagent.LoadConcurrency{
configs: velerotypes.NodeAgentConfigs{
LoadConcurrency: &velerotypes.LoadConcurrency{
GlobalConfig: globalNum,
PerNodeConfig: []nodeagent.RuledConfigs{
PerNodeConfig: []velerotypes.RuledConfigs{
{
NodeSelector: validLabelSelector1,
Number: 66,
@@ -368,10 +369,10 @@ func Test_getDataPathConcurrentNum(t *testing.T) {
},
{
name: "match multiple rules 2",
configs: nodeagent.Configs{
LoadConcurrency: &nodeagent.LoadConcurrency{
configs: velerotypes.NodeAgentConfigs{
LoadConcurrency: &velerotypes.LoadConcurrency{
GlobalConfig: globalNum,
PerNodeConfig: []nodeagent.RuledConfigs{
PerNodeConfig: []velerotypes.RuledConfigs{
{
NodeSelector: validLabelSelector1,
Number: 36,