-
Notifications
You must be signed in to change notification settings - Fork 152
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Snapshot helpers for Kanister (#5012)
Adds helper function to create and manipulate VolumeSnapshots. * Create takes snapshot of PVC by posting a VolumeSnapshot * Clone copies a VolumeSnapshot to another namespace * Delete deletes VolumeSnapshot * CreatePVCFromSnapshot will create a PVC by using the content of VolumeSnapshot
- Loading branch information
Hakan Memisoglu
authored and
Ilya Kislenko
committed
Mar 13, 2019
1 parent
dfd6d4c
commit d990456
Showing
11 changed files
with
609 additions
and
18 deletions.
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,199 @@ | ||
| package snapshot | ||
|
|
||
| import ( | ||
| "context" | ||
|
|
||
| snapshot "github.com/kubernetes-csi/external-snapshotter/pkg/apis/volumesnapshot/v1alpha1" | ||
| snapshotclient "github.com/kubernetes-csi/external-snapshotter/pkg/client/clientset/versioned" | ||
| "github.com/pkg/errors" | ||
| corev1 "k8s.io/api/core/v1" | ||
| k8errors "k8s.io/apimachinery/pkg/api/errors" | ||
| metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" | ||
| "k8s.io/apimachinery/pkg/util/uuid" | ||
| "k8s.io/client-go/kubernetes" | ||
|
|
||
| "github.com/kanisterio/kanister/pkg/poll" | ||
| ) | ||
|
|
||
| const ( | ||
| snapshotKind = "VolumeSnapshot" | ||
| pvcKind = "PersistentVolumeClaim" | ||
| ) | ||
|
|
||
| var snapshotAPIGroup = "snapshot.storage.k8s.io" | ||
|
|
||
| // Create creates a VolumeSnapshot and returns it or any error happened meanwhile. | ||
| // | ||
| // 'name' is the name of the VolumeSnapshot. | ||
| // 'namespace' is namespace of the PVC. VolumeSnapshot will be crated in the same namespace. | ||
| // 'volumeName' is the name of the PVC of which we will take snapshot. It must be in the same namespace 'ns'. | ||
| // 'waitForReady' will block the caller until the snapshot status is 'ReadyToUse'. | ||
| // or 'ctx.Done()' is signalled. Otherwise it will return immediately after the snapshot is cut. | ||
| func Create(ctx context.Context, kubeCli kubernetes.Interface, snapCli snapshotclient.Interface, name, namespace, volumeName string, snapshotClass *string, waitForReady bool) error { | ||
| if _, err := kubeCli.CoreV1().PersistentVolumeClaims(namespace).Get(volumeName, metav1.GetOptions{}); err != nil { | ||
| if k8errors.IsNotFound(err) { | ||
| return errors.Errorf("Failed to find PVC %s, Namespace %s", volumeName, namespace) | ||
| } | ||
| return errors.Errorf("Failed to query PVC %s, Namespace %s: %v", volumeName, namespace, err) | ||
| } | ||
|
|
||
| snap := &snapshot.VolumeSnapshot{ | ||
| ObjectMeta: metav1.ObjectMeta{ | ||
| Name: name, | ||
| Namespace: namespace, | ||
| }, | ||
| Spec: snapshot.VolumeSnapshotSpec{ | ||
| Source: &corev1.TypedLocalObjectReference{ | ||
| Kind: pvcKind, | ||
| Name: volumeName, | ||
| }, | ||
| VolumeSnapshotClassName: snapshotClass, | ||
| }, | ||
| } | ||
|
|
||
| snap, err := snapCli.VolumesnapshotV1alpha1().VolumeSnapshots(namespace).Create(snap) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| if !waitForReady { | ||
| return nil | ||
| } | ||
|
|
||
| err = WaitOnReadyToUse(ctx, snapCli, name, namespace) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| _, err = snapCli.VolumesnapshotV1alpha1().VolumeSnapshots(namespace).Get(name, metav1.GetOptions{}) | ||
| return err | ||
| } | ||
|
|
||
| // Get will return the VolumeSnapshot in the namespace 'namespace' with given 'name'. | ||
| // | ||
| // 'name' is the name of the VolumeSnapshot that will be returned. | ||
| // 'namespace' is the namespace of the VolumeSnapshot that will be returned. | ||
| func Get(ctx context.Context, snapCli snapshotclient.Interface, name, namespace string) (*snapshot.VolumeSnapshot, error) { | ||
| return snapCli.VolumesnapshotV1alpha1().VolumeSnapshots(namespace).Get(name, metav1.GetOptions{}) | ||
| } | ||
|
|
||
| // Delete will delete the VolumeSnapshot and returns any error as a result. | ||
| // | ||
| // 'name' is the name of the VolumeSnapshot that will be deleted. | ||
| // 'namespace' is the namespace of the VolumeSnapshot that will be deleted. | ||
| func Delete(ctx context.Context, snapCli snapshotclient.Interface, name, namespace string) error { | ||
| return snapCli.VolumesnapshotV1alpha1().VolumeSnapshots(namespace).Delete(name, &metav1.DeleteOptions{}) | ||
| } | ||
|
|
||
| // Clone will clone the VolumeSnapshot to namespace 'cloneNamespace'. | ||
| // Underlying VolumeSnapshotContent will be cloned with a different name. | ||
| // | ||
| // 'name' is the name of the VolumeSnapshot that will be cloned. | ||
| // 'namespace' is the namespace of the VolumeSnapshot that will be cloned. | ||
| // 'cloneName' is name of the clone. | ||
| // 'cloneNamespace' is the namespace where the clone will be created. | ||
| // 'waitForReady' will make the function blocks until the clone's status is ready to use. | ||
| func Clone(ctx context.Context, snapCli snapshotclient.Interface, name, namespace, cloneName, cloneNamespace string, waitForReady bool) error { | ||
| snap, err := snapCli.VolumesnapshotV1alpha1().VolumeSnapshots(namespace).Get(name, metav1.GetOptions{}) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| if !snap.Status.ReadyToUse { | ||
| return errors.Errorf("Original snapshot is not ready, VolumeSnapshot: %s, Namespace: %s", cloneName, cloneNamespace) | ||
| } | ||
| if snap.Spec.SnapshotContentName == "" { | ||
| return errors.Errorf("Original snapshot does not have content, VolumeSnapshot: %s, Namespace: %s", cloneName, cloneNamespace) | ||
| } | ||
|
|
||
| _, err = snapCli.VolumesnapshotV1alpha1().VolumeSnapshots(cloneNamespace).Get(cloneName, metav1.GetOptions{}) | ||
| if err == nil { | ||
| return errors.Errorf("Target snapshot already exists in target namespace, Volumesnapshot: %s, Namespace: %s", cloneName, cloneNamespace) | ||
| } | ||
| if !k8errors.IsNotFound(err) { | ||
| return errors.Errorf("Failed to query target Volumesnapshot: %s, Namespace: %s: %v", cloneName, cloneNamespace, err) | ||
| } | ||
|
|
||
| content, err := snapCli.VolumesnapshotV1alpha1().VolumeSnapshotContents().Get(snap.Spec.SnapshotContentName, metav1.GetOptions{}) | ||
| if err != nil { | ||
| return errors.Errorf("Failed to get original snapshot content, VolumesnapshotContent: %s: %v", snap.Spec.SnapshotContentName, err) | ||
| } | ||
|
|
||
| // Create a 'VolumeSnapshotContent' referenced by a 'VolumeSnapshot' 'cloneName' in namespace 'cloneNamespace'. | ||
| clonedSnap, clonedContent := cloneSnapshotAndContent(content, cloneName, cloneNamespace) | ||
|
|
||
| // Create cloned VolumeSnapshotContent first, then cloned VolumeSnapshot. | ||
| // Snapshotter will check the binding and set the status of VolumeSnapshot. | ||
| _, err = snapCli.VolumesnapshotV1alpha1().VolumeSnapshotContents().Create(clonedContent) | ||
| if err != nil { | ||
| return errors.Errorf("Failed to create target snapshot content, VolumeSnapshotContent: %s: %v", clonedContent.Name, err) | ||
| } | ||
|
|
||
| clonedSnap, err = snapCli.VolumesnapshotV1alpha1().VolumeSnapshots(cloneNamespace).Create(clonedSnap) | ||
| if err != nil { | ||
| return errors.Errorf("Failed to create target snapshot, VolumeSnapshot: %s: %v", clonedSnap.Name, err) | ||
| } | ||
|
|
||
| if !waitForReady { | ||
| return nil | ||
| } | ||
|
|
||
| err = WaitOnReadyToUse(ctx, snapCli, clonedSnap.Name, clonedSnap.Namespace) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| // WaitOnReadyToUse will block until the Volumesnapshot in namespace 'namespace' with name 'snapshotName' | ||
| // has status 'ReadyToUse' or 'ctx.Done()' is signalled. | ||
| func WaitOnReadyToUse(ctx context.Context, snapCli snapshotclient.Interface, snapshotName, namespace string) error { | ||
| return poll.Wait(ctx, func(context.Context) (bool, error) { | ||
| snap, err := snapCli.VolumesnapshotV1alpha1().VolumeSnapshots(namespace).Get(snapshotName, metav1.GetOptions{}) | ||
| if err != nil { | ||
| return false, err | ||
| } | ||
| return snap.Status.ReadyToUse, nil | ||
| }) | ||
| } | ||
|
|
||
| // clonedSnapshotAndContent will return a 'VolumeSnapshot' and 'VolumeSnapshotContent' for a snapshot clone. | ||
| // Cloned 'VolumeSnapshotContent' will copy the value for 'Source.CSI.{Driver,SnapshotHandle}' | ||
| // since these are the minimum info for snapshotter to get information from the source. | ||
| // It needs to prepopulate 'VolumeSnapshotRef' field with the values from the 'VolumeSnapshot' | ||
| // that will also be returned. | ||
| func cloneSnapshotAndContent(content *snapshot.VolumeSnapshotContent, clonedName, clonedNamespace string) (*snapshot.VolumeSnapshot, *snapshot.VolumeSnapshotContent) { | ||
| clonedContent := &snapshot.VolumeSnapshotContent{ | ||
| ObjectMeta: metav1.ObjectMeta{ | ||
| Name: clonedContentName(content.Name), | ||
| }, | ||
| Spec: snapshot.VolumeSnapshotContentSpec{ | ||
| VolumeSnapshotSource: snapshot.VolumeSnapshotSource{ | ||
| CSI: &snapshot.CSIVolumeSnapshotSource{ | ||
| Driver: content.Spec.VolumeSnapshotSource.CSI.Driver, | ||
| SnapshotHandle: content.Spec.VolumeSnapshotSource.CSI.SnapshotHandle, | ||
| }, | ||
| }, | ||
| VolumeSnapshotRef: &corev1.ObjectReference{ | ||
| Kind: snapshotKind, | ||
| Namespace: clonedNamespace, | ||
| Name: clonedName, | ||
| }, | ||
| VolumeSnapshotClassName: content.Spec.VolumeSnapshotClassName, | ||
| }, | ||
| } | ||
| clonedSnap := &snapshot.VolumeSnapshot{ | ||
| ObjectMeta: metav1.ObjectMeta{ | ||
| Name: clonedName, | ||
| }, | ||
| Spec: snapshot.VolumeSnapshotSpec{ | ||
| SnapshotContentName: clonedContent.Name, | ||
| VolumeSnapshotClassName: content.Spec.VolumeSnapshotClassName, | ||
| }, | ||
| } | ||
| return clonedSnap, clonedContent | ||
| } | ||
|
|
||
| func clonedContentName(contentName string) string { | ||
| return contentName + "-k10clone-" + string(uuid.NewUUID()) | ||
| } |
Oops, something went wrong.