-
Notifications
You must be signed in to change notification settings - Fork 184
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
add VolumeGroupSnapshotClass for CephFS and RBD #2859
Open
ShravaniVangur
wants to merge
2
commits into
red-hat-storage:main
Choose a base branch
from
ShravaniVangur:volgrp-snapclass
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
175 changes: 175 additions & 0 deletions
175
controllers/storagecluster/volumegroupsnapshotterclasses.go
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,175 @@ | ||
| package storagecluster | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "reflect" | ||
|
|
||
| groupsnapapi "github.com/kubernetes-csi/external-snapshotter/client/v8/apis/volumegroupsnapshot/v1alpha1" | ||
| snapapi "github.com/kubernetes-csi/external-snapshotter/client/v8/apis/volumesnapshot/v1" | ||
| ocsv1 "github.com/red-hat-storage/ocs-operator/api/v4/v1" | ||
| "k8s.io/apimachinery/pkg/api/errors" | ||
| metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" | ||
| "k8s.io/apimachinery/pkg/types" | ||
| "k8s.io/klog/v2" | ||
| "sigs.k8s.io/controller-runtime/pkg/reconcile" | ||
| ) | ||
|
|
||
| type GroupSnapshotterType string | ||
|
|
||
| type ocsGroupSnapshotClass struct{} | ||
|
|
||
| const ( | ||
| rbdGroupSnapshotter GroupSnapshotterType = "rbd" | ||
| cephfsGroupSnapshotter GroupSnapshotterType = "cephfs" | ||
| ) | ||
|
|
||
| const ( | ||
| groupSnapshotterSecretName = "csi.storage.k8s.io/group-snapshotter-secret-name" | ||
| groupSnapshotterSecretNamespace = "csi.storage.k8s.io/group-snapshotter-secret-namespace" | ||
| ) | ||
|
|
||
| type GroupSnapshotClassConfiguration struct { | ||
| groupSnapshotClass *groupsnapapi.VolumeGroupSnapshotClass | ||
| reconcileStrategy ReconcileStrategy | ||
| disable bool | ||
| } | ||
|
|
||
| func newVolumeGroupSnapshotClass(instance *ocsv1.StorageCluster, groupSnaphotterType GroupSnapshotterType) *groupsnapapi.VolumeGroupSnapshotClass { | ||
| driverName, driverValue := setParameterBasedOnSnapshotterType(instance, groupSnaphotterType) | ||
| groupSnapClass := &groupsnapapi.VolumeGroupSnapshotClass{ | ||
| ObjectMeta: metav1.ObjectMeta{ | ||
| Name: generateNameForGroupSnapshotClass(instance, groupSnaphotterType), | ||
| }, | ||
| Driver: generateNameForSnapshotClassDriver(SnapshotterType(groupSnaphotterType)), | ||
| Parameters: map[string]string{ | ||
| "clusterID": instance.Namespace, | ||
| driverName: driverValue, | ||
| groupSnapshotterSecretName: generateNameForSnapshotClassSecret(instance, SnapshotterType(groupSnaphotterType)), | ||
| groupSnapshotterSecretNamespace: instance.Namespace, | ||
| }, | ||
| DeletionPolicy: snapapi.VolumeSnapshotContentDelete, | ||
| } | ||
| return groupSnapClass | ||
| } | ||
|
|
||
| func newCephFilesystemGroupSnapshotClassConfiguration(instance *ocsv1.StorageCluster) GroupSnapshotClassConfiguration { | ||
| return GroupSnapshotClassConfiguration{ | ||
| groupSnapshotClass: newVolumeGroupSnapshotClass(instance, cephfsGroupSnapshotter), | ||
| reconcileStrategy: ReconcileStrategy(instance.Spec.ManagedResources.CephFilesystems.ReconcileStrategy), | ||
| } | ||
| } | ||
|
|
||
| func newCephBlockPoolGroupSnapshotClassConfiguration(instance *ocsv1.StorageCluster) GroupSnapshotClassConfiguration { | ||
| return GroupSnapshotClassConfiguration{ | ||
| groupSnapshotClass: newVolumeGroupSnapshotClass(instance, rbdGroupSnapshotter), | ||
| reconcileStrategy: ReconcileStrategy(instance.Spec.ManagedResources.CephBlockPools.ReconcileStrategy), | ||
| } | ||
| } | ||
|
|
||
| func newGroupSnapshotClassConfigurations(instance *ocsv1.StorageCluster) []GroupSnapshotClassConfiguration { | ||
| vsccs := []GroupSnapshotClassConfiguration{ | ||
| newCephFilesystemGroupSnapshotClassConfiguration(instance), | ||
| newCephBlockPoolGroupSnapshotClassConfiguration(instance), | ||
| } | ||
| return vsccs | ||
| } | ||
|
|
||
| func (r *StorageClusterReconciler) createGroupSnapshotClasses(vsccs []GroupSnapshotClassConfiguration) error { | ||
|
|
||
| for _, vscc := range vsccs { | ||
| if vscc.reconcileStrategy == ReconcileStrategyIgnore || vscc.disable { | ||
| continue | ||
| } | ||
|
|
||
| vsc := vscc.groupSnapshotClass | ||
| existing := &groupsnapapi.VolumeGroupSnapshotClass{} | ||
| err := r.Client.Get(r.ctx, types.NamespacedName{Name: vsc.Name, Namespace: vsc.Namespace}, existing) | ||
| if err != nil { | ||
| if errors.IsNotFound(err) { | ||
| // Since the SnapshotClass is not found, we will create a new one | ||
| r.Log.Info("Creating GroupSnapshotClass.", "GroupSnapshotClass", klog.KRef("", vsc.Name)) | ||
| err = r.Client.Create(r.ctx, vsc) | ||
| if err != nil { | ||
| r.Log.Error(err, "Failed to create GroupSnapshotClass.", "GroupSnapshotClass", klog.KRef("", vsc.Name)) | ||
| return err | ||
| } | ||
| // no error, continue with the next iteration | ||
| continue | ||
| } | ||
|
|
||
| r.Log.Error(err, "Failed to 'Get' GroupSnapshotClass.", "GroupSnapshotClass", klog.KRef("", vsc.Name)) | ||
| return err | ||
| } | ||
| if vscc.reconcileStrategy == ReconcileStrategyInit { | ||
| return nil | ||
| } | ||
| if existing.DeletionTimestamp != nil { | ||
| return fmt.Errorf("failed to restore GroupSnapshotClass %q because it is marked for deletion", existing.Name) | ||
| } | ||
| // if there is a mismatch in the parameters of existing vs created resources, | ||
| if !reflect.DeepEqual(vsc.Parameters, existing.Parameters) { | ||
| // we have to update the existing SnapshotClass | ||
| r.Log.Info("GroupSnapshotClass needs to be updated", "GroupSnapshotClass", klog.KRef("", existing.Name)) | ||
| existing.ObjectMeta.OwnerReferences = vsc.ObjectMeta.OwnerReferences | ||
| vsc.ObjectMeta = existing.ObjectMeta | ||
| if err := r.Client.Update(r.ctx, vsc); err != nil { | ||
| r.Log.Error(err, "GroupSnapshotClass updation failed.", "GroupSnapshotClass", klog.KRef("", existing.Name)) | ||
| return err | ||
| } | ||
| } | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| func (obj *ocsGroupSnapshotClass) ensureCreated(r *StorageClusterReconciler, instance *ocsv1.StorageCluster) (reconcile.Result, error) { | ||
| if !r.AvailableCrds[VolumeGroupSnapshotClassCrdName] { | ||
| r.Log.Info("VolumeGroupSnapshotClass CRD is not available") | ||
| return reconcile.Result{}, nil | ||
| } | ||
|
|
||
| vgsc := newGroupSnapshotClassConfigurations(instance) | ||
|
|
||
| err := r.createGroupSnapshotClasses(vgsc) | ||
| if err != nil { | ||
| return reconcile.Result{}, nil | ||
| } | ||
|
|
||
| return reconcile.Result{}, nil | ||
| } | ||
|
|
||
| func (obj *ocsGroupSnapshotClass) ensureDeleted(r *StorageClusterReconciler, instance *ocsv1.StorageCluster) (reconcile.Result, error) { | ||
| if !r.AvailableCrds[VolumeGroupSnapshotClassCrdName] { | ||
| r.Log.Info("VolumeGroupSnapshotClass CRD doesn't exist") | ||
| return reconcile.Result{}, nil | ||
| } | ||
|
|
||
| vgscs := newGroupSnapshotClassConfigurations(instance) | ||
| for _, vgsc := range vgscs { | ||
| sc := vgsc.groupSnapshotClass | ||
| existing := groupsnapapi.VolumeGroupSnapshotClass{} | ||
| err := r.Client.Get(r.ctx, types.NamespacedName{Name: sc.Name, Namespace: sc.Namespace}, &existing) | ||
|
|
||
| switch { | ||
| case err == nil: | ||
| if existing.DeletionTimestamp != nil { | ||
| r.Log.Info("Uninstall: GroupSnapshotClass is already marked for deletion.", "GroupSnapshotClass", klog.KRef("", existing.Name)) | ||
| break | ||
| } | ||
|
|
||
| r.Log.Info("Uninstall: Deleting GroupSnapshotClass.", "GroupSnapshotClass", klog.KRef("", existing.Name)) | ||
| existing.ObjectMeta.OwnerReferences = sc.ObjectMeta.OwnerReferences | ||
| sc.ObjectMeta = existing.ObjectMeta | ||
|
|
||
| err = r.Client.Delete(r.ctx, sc) | ||
| if err != nil && !errors.IsNotFound(err) { | ||
| r.Log.Error(err, "Uninstall: Error deleting the GroupSnapshotClass.", "GroupSnapshotClass", klog.KRef("", existing.Name)) | ||
| return reconcile.Result{}, err | ||
| } | ||
| case errors.IsNotFound(err): | ||
| r.Log.Info("Uninstall: GroupSnapshotClass not found, nothing to do.", "GroupSnapshotClass", klog.KRef("", sc.Name)) | ||
| default: | ||
| r.Log.Error(err, "Uninstall: Error while getting GroupSnapshotClass.", "GroupSnapshotClass", klog.KRef("", sc.Name)) | ||
| } | ||
| } | ||
| return reconcile.Result{}, nil | ||
| } | ||
33 changes: 33 additions & 0 deletions
33
controllers/storagecluster/volumegroupsnapshotterclasses_test.go
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| package storagecluster | ||
|
|
||
| import ( | ||
| "context" | ||
| "testing" | ||
|
|
||
| groupsnapapi "github.com/kubernetes-csi/external-snapshotter/client/v8/apis/volumegroupsnapshot/v1alpha1" | ||
| "github.com/stretchr/testify/assert" | ||
| metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" | ||
| "sigs.k8s.io/controller-runtime/pkg/reconcile" | ||
| ) | ||
|
|
||
| func TestVolumeGroupSnapshotterClasses(t *testing.T) { | ||
| t, reconciler, _, request := initStorageClusterResourceCreateUpdateTest(t, nil, nil) | ||
| assertVolumeGroupSnapshotterClasses(t, reconciler, request) | ||
| } | ||
|
|
||
| func assertVolumeGroupSnapshotterClasses(t *testing.T, reconciler StorageClusterReconciler, | ||
| request reconcile.Request) { | ||
| rbdVSCName := "ocsinit-rbdplugin-groupsnapclass" | ||
| cephfsVSCName := "ocsinit-cephfsplugin-groupsnapclass" | ||
| vscNames := []string{cephfsVSCName, rbdVSCName} | ||
| for _, eachVSCName := range vscNames { | ||
| actualVSC := &groupsnapapi.VolumeGroupSnapshotClass{ | ||
| ObjectMeta: metav1.ObjectMeta{ | ||
| Name: eachVSCName, | ||
| }, | ||
| } | ||
| request.Name = eachVSCName | ||
| err := reconciler.Client.Get(context.TODO(), request.NamespacedName, actualVSC) | ||
| assert.NoError(t, err) | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
where are we setting filesystem name and blockpool in the class?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
it is set by the
driverNameanddriverValuevariables whose values are assigned by thesetParameterBasedOnSnapshotterTypefunction.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Right, this confused me a bit too, it is well hidden.
driverNameis not really a very suitable name, as the parameter is calledfsNamefor CephFS orpoolfor RBD. But, I expect this to work correctly. Having a test that validates these kind of parameters would be nice to have.