-
Notifications
You must be signed in to change notification settings - Fork 184
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add VolumeGroupSnapshotClass for CephFS and RBD
CSI-drivers requires VolumeGroupSnapshotClass for VolumeGroupSnapshot. Signed-off-by: ShravaniVangur <[email protected]>
- Loading branch information
1 parent
1d6235c
commit bedc668
Showing
10 changed files
with
266 additions
and
4 deletions.
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
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/v1beta1" | ||
| 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 { | ||
| paramKey, paramValue := setParameterBasedOnSnapshotterType(instance, groupSnaphotterType) | ||
| groupSnapClass := &groupsnapapi.VolumeGroupSnapshotClass{ | ||
| ObjectMeta: metav1.ObjectMeta{ | ||
| Name: generateNameForGroupSnapshotClass(instance, groupSnaphotterType), | ||
| }, | ||
| Driver: generateNameForSnapshotClassDriver(SnapshotterType(groupSnaphotterType)), | ||
| Parameters: map[string]string{ | ||
| "clusterID": instance.Namespace, | ||
| paramKey: paramValue, | ||
| 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{}, err | ||
| } | ||
|
|
||
| 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/v1beta1" | ||
| "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