chore(velero): bump velero client to latest 1.15.0 #5066

JGAntunes · 2024-12-20T19:44:28Z

What this PR does / why we need it:

This PR bumps the velero client to the latest version (and the one we use in embedded cluster) v1.15.0.

The biggest change for our side is the deprecation of the generated client via:

Delete the pkg/generated directory. vmware-tanzu/velero#8114

It's now expected that we use the controller-runtime client instead. There's an opportunity to simplify the clients we rely on a in a couple of places (we have methods using both clientset k8s go-client and the controller-runtime client) however I've opted to leave it out of scope for this set of changes to not aggravate an already large PR.

Which issue(s) this PR fixes:

https://app.shortcut.com/replicated/story/117774/bump-velero-to-the-latest-version-v1-15-0-on-kots

Does this PR require a test?

I've run some manual tests locally, creating backups and listing them, both in EC and existing cluster. Nevertheless there's a large set of code branches we're touching here so if folks could also do some smoke tests on specific paths you deem tricky I would appreciate it.

Does this PR require a release note?

NONE

Does this PR require documentation?

NONE

…t-version-v1-15-0

JGAntunes · 2024-12-24T13:00:41Z

pkg/handlers/handlers.go

@@ -35,7 +35,7 @@ func NewHandler() *Handler {
 func init() {
 	kotsscheme.AddToScheme(scheme.Scheme)
 	troubleshootscheme.AddToScheme(scheme.Scheme)
-	veleroscheme.AddToScheme(scheme.Scheme)
+	velerov1.AddToScheme(scheme.Scheme)


Since all the velero object interactions now rely on:

kots/pkg/k8sutil/clientset.go

Lines 157 to 171 in a422a55

func GetKubeClient(ctx context.Context) (kbclient.WithWatch, error) {

k8slogger := zap.New(func(o *zap.Options) {

o.DestWriter = io.Discard

})

log.SetLogger(k8slogger)

cfg, err := GetClusterConfig()

if err != nil {

return nil, errors.Wrap(err, "failed to get cluster config")

}

kcli, err := kbclient.NewWithWatch(cfg, kbclient.Options{})

if err != nil {

return nil, errors.Wrap(err, "failed to create kubebuilder client")

}

return kcli, nil

}

Which has the scheme set via:

kots/pkg/k8sutil/clientset.go

Lines 36 to 40 in a422a55

func init() {

kubernetesConfigFlags = genericclioptions.NewConfigFlags(false)

embeddedclusterv1beta1.AddToScheme(scheme.Scheme)

velerov1.AddToScheme(scheme.Scheme)

}

We probably don't need this anymore. Nevertheless keeping it for now just be cautious. Once we refactor our client usage across the board and drop a lof of our clientset usages we can take care of removing these.

JGAntunes · 2024-12-24T13:02:24Z

pkg/k8sutil/clientset.go

-	kcli, err := kbclient.New(cfg, kbclient.Options{
-		Scheme: scheme,
-	})
+	kcli, err := kbclient.NewWithWatch(cfg, kbclient.Options{})


We need the watch interface for our informer:

kots/pkg/informers/informers.go

Lines 48 to 50 in a422a55

backupWatch, err := veleroClient.Watch(context.TODO(), &backupList, kbclient.InNamespace(veleroNamespace), &kbclient.ListOptions{

Raw: &metav1.ListOptions{ResourceVersion: "0"},

})

JGAntunes · 2024-12-24T13:04:58Z

pkg/kotsadmsnapshot/backup.go

@@ -194,12 +193,12 @@ func CreateApplicationBackup(ctx context.Context, a *apptypes.App, isScheduled b
 		logger.Error(errors.Wrap(err, "failed to exclude shutdown pods from backup"))
 	}

-	backup, err := veleroClient.Backups(kotsadmVeleroBackendStorageLocation.Namespace).Create(ctx, veleroBackup, metav1.CreateOptions{})
+	err = veleroClient.Create(ctx, veleroBackup)


Namespace is already set above -

kots/pkg/kotsadmsnapshot/backup.go

Line 153 in a422a55

veleroBackup.Namespace = kotsadmVeleroBackendStorageLocation.Namespace

JGAntunes · 2024-12-24T13:06:35Z

pkg/kotsadmsnapshot/backup.go

@@ -275,20 +269,20 @@ func CreateInstanceBackup(ctx context.Context, cluster *downstreamtypes.Downstre
 	}

 	logger.Infof("Creating instance backup CR %s", veleroBackup.GenerateName)
-	backup, err := veleroClient.Backups(metadata.backupStorageLocationNamespace).Create(ctx, veleroBackup, metav1.CreateOptions{})
+	err = ctrlClient.Create(ctx, veleroBackup)


Namespace needs to be set in getInfrastructureInstanceBackupSpec:

kots/pkg/kotsadmsnapshot/backup.go

Line 435 in a422a55

Namespace: metadata.backupStorageLocationNamespace,

JGAntunes · 2024-12-24T13:08:00Z

pkg/kotsadmsnapshot/backup.go

@@ -438,6 +432,7 @@ func getInfrastructureInstanceBackupSpec(ctx context.Context, k8sClient kubernet
 	veleroBackup := &velerov1.Backup{
 		ObjectMeta: metav1.ObjectMeta{
 			Name:         "",
+			Namespace:    metadata.backupStorageLocationNamespace,


Namespace needs to be set given the client changes.

JGAntunes · 2024-12-24T13:08:30Z

pkg/kotsadmsnapshot/backup.go

@@ -543,8 +538,10 @@ func getAppInstanceBackupSpec(k8sClient kubernetes.Interface, metadata instanceB

 		appVeleroBackup = appMeta.kotsKinds.Backup.DeepCopy()
 		restore = appMeta.kotsKinds.Restore.DeepCopy()
+		restore.Namespace = metadata.backupStorageLocationNamespace


We also set the namespace for the restore spec that's added as annotation.

JGAntunes · 2024-12-24T13:08:35Z

pkg/kotsadmsnapshot/backup.go


 		appVeleroBackup.Name = ""
+		appVeleroBackup.Namespace = metadata.backupStorageLocationNamespace


Namespace needs to be set given the client changes.

JGAntunes · 2024-12-24T13:09:30Z

pkg/kotsadmsnapshot/backup.go

+			startedAt := veleroBackup.Status.StartTimestamp.Time.UTC()
+			backup.StartedAt = &startedAt


Seems like timestamps are now being returned unmarshalled with time.Local

JGAntunes · 2024-12-24T13:12:10Z

pkg/snapshot/store.go

-	_, err = veleroClient.BackupStorageLocations(bsl.Namespace).Get(ctx, bsl.Name, metav1.GetOptions{})
-	if err == nil {
-		updated, err := veleroClient.BackupStorageLocations(bsl.Namespace).Update(ctx, bsl, metav1.UpdateOptions{})
+	if err := veleroClient.Update(ctx, bsl); err == nil {


We can just attempt to update and fallback to creation if the object does not exist.

chore(velero): bump velero client to latest 1.15.0

fcedcc3

laverya added the type::chore label Dec 20, 2024

chore: should be building now

b4e81ee

JGAntunes self-assigned this Dec 23, 2024

JGAntunes added 4 commits December 23, 2024 20:23

chore: timestamp tests are driving me nuts

74ecee5

chore: fixup more tests

7af9f23

chore: make k8sutil use a single client

58f9f86

Merge branch 'main' into jgantunes/sc-117774/bump-velero-to-the-lates…

a422a55

…t-version-v1-15-0

JGAntunes commented Dec 24, 2024

View reviewed changes

JGAntunes marked this pull request as ready for review December 24, 2024 13:17

JGAntunes requested review from emosbaugh, sgalsaleh and laverya December 24, 2024 13:17

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore(velero): bump velero client to latest 1.15.0 #5066

chore(velero): bump velero client to latest 1.15.0 #5066

JGAntunes commented Dec 20, 2024 •

edited

Loading

JGAntunes Dec 24, 2024

JGAntunes Dec 24, 2024

JGAntunes Dec 24, 2024

JGAntunes Dec 24, 2024

JGAntunes Dec 24, 2024

JGAntunes Dec 24, 2024

JGAntunes Dec 24, 2024

JGAntunes Dec 24, 2024

JGAntunes Dec 24, 2024

	func GetKubeClient(ctx context.Context) (kbclient.WithWatch, error) {
	k8slogger := zap.New(func(o *zap.Options) {
	o.DestWriter = io.Discard
	})
	log.SetLogger(k8slogger)
	cfg, err := GetClusterConfig()
	if err != nil {
	return nil, errors.Wrap(err, "failed to get cluster config")
	}
	kcli, err := kbclient.NewWithWatch(cfg, kbclient.Options{})
	if err != nil {
	return nil, errors.Wrap(err, "failed to create kubebuilder client")
	}
	return kcli, nil
	}

	func init() {
	kubernetesConfigFlags = genericclioptions.NewConfigFlags(false)
	embeddedclusterv1beta1.AddToScheme(scheme.Scheme)
	velerov1.AddToScheme(scheme.Scheme)
	}

	backupWatch, err := veleroClient.Watch(context.TODO(), &backupList, kbclient.InNamespace(veleroNamespace), &kbclient.ListOptions{
	Raw: &metav1.ListOptions{ResourceVersion: "0"},
	})


		appVeleroBackup.Name = ""
		appVeleroBackup.Namespace = metadata.backupStorageLocationNamespace

		startedAt := veleroBackup.Status.StartTimestamp.Time.UTC()
		backup.StartedAt = &startedAt

chore(velero): bump velero client to latest 1.15.0 #5066

Are you sure you want to change the base?

chore(velero): bump velero client to latest 1.15.0 #5066

Conversation

JGAntunes commented Dec 20, 2024 • edited Loading

What this PR does / why we need it:

Which issue(s) this PR fixes:

Does this PR require a test?

Does this PR require a release note?

Does this PR require documentation?

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JGAntunes commented Dec 20, 2024 •

edited

Loading