feat(zfspv): adding backup and restore support (#162)

This commit adds support for Backup and Restore controller, which will be watching for
the events. The velero plugin will create a Backup CR to create a backup
with the remote location information, the controller will send the data
to that remote location.

In the same way, the velero plugin will create a Restore CR to restore the
volume from the the remote location and the restore controller will restore
the data.

Steps to use velero plugin for ZFS-LocalPV are :

1. install velero

2. add openebs plugin

velero plugin add openebs/velero-plugin:latest

3. Create the volumesnapshot location :

for full backup :-

```yaml
apiVersion: velero.io/v1
kind: VolumeSnapshotLocation
metadata:
  name: default
  namespace: velero
spec:
  provider: openebs.io/zfspv-blockstore
  config:
    bucket: velero
    prefix: zfs
    namespace: openebs
    provider: aws
    region: minio
    s3ForcePathStyle: "true"
    s3Url: http://minio.velero.svc:9000
```

for incremental backup :-

```yaml
apiVersion: velero.io/v1
kind: VolumeSnapshotLocation
metadata:
  name: default
  namespace: velero
spec:
  provider: openebs.io/zfspv-blockstore
  config:
    bucket: velero
    prefix: zfs
    backup: incremental
    namespace: openebs
    provider: aws
    region: minio
    s3ForcePathStyle: "true"
    s3Url: http://minio.velero.svc:9000
```

4. Create backup

velero backup create my-backup --snapshot-volumes --include-namespaces=velero-ns --volume-snapshot-locations=aws-cloud-default --storage-location=default

5. Create Schedule

velero create schedule newschedule  --schedule="*/1 * * * *" --snapshot-volumes --include-namespaces=velero-ns --volume-snapshot-locations=aws-local-default --storage-location=default

6. Restore from backup

velero restore create --from-backup my-backup --restore-volumes=true --namespace-mappings velero-ns:ns1



Signed-off-by: Pawan <pawan@mayadata.io>

pkg/apis/openebs.io/zfs/v1/register.go

@@ -73,6 +73,10 @@ func addKnownTypes(scheme *runtime.Scheme) error {
 		&ZFSVolumeList{},
 		&ZFSSnapshot{},
 		&ZFSSnapshotList{},
+		&ZFSBackup{},
+		&ZFSBackupList{},
+		&ZFSRestore{},
+		&ZFSRestoreList{},
 	)
 	metav1.AddToGroupVersion(scheme, SchemeGroupVersion)
 	return nil

pkg/apis/openebs.io/zfs/v1/zfsbackup.go

@@ -0,0 +1,103 @@
+/*
+Copyright 2020 The OpenEBS Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package v1
+
+import (
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+)
+
+// +genclient
+// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
+// +resource:path=zfsbackup
+
+// ZFSBackup describes a zfs backup resource created as a custom resource
+// +kubebuilder:object:root=true
+// +kubebuilder:storageversion
+// +kubebuilder:resource:scope=Namespaced,shortName=zb
+// +kubebuilder:printcolumn:name="PrevSnap",type=string,JSONPath=`.spec.prevSnapName`,description="Previous snapshot for backup"
+// +kubebuilder:printcolumn:name="Status",type=string,JSONPath=`.status`,description="Backup status"
+// +kubebuilder:printcolumn:name="Age",type=date,JSONPath=`.metadata.creationTimestamp`,description="Age of the volume"
+type ZFSBackup struct {
+	metav1.TypeMeta   `json:",inline"`
+	metav1.ObjectMeta `json:"metadata,omitempty"`
+	Spec              ZFSBackupSpec   `json:"spec"`
+	Status            ZFSBackupStatus `json:"status"`
+}
+
+// ZFSBackupSpec is the spec for a ZFSBackup resource
+type ZFSBackupSpec struct {
+	// VolumeName is a name of the volume for which this backup is destined
+	// +kubebuilder:validation:Required
+	// +kubebuilder:validation:MinLength=1
+	VolumeName string `json:"volumeName"`
+
+	// OwnerNodeID is a name of the nodes where the source volume is
+	// +kubebuilder:validation:Required
+	// +kubebuilder:validation:MinLength=1
+	OwnerNodeID string `json:"ownerNodeID"`
+
+	// SnapName is the snapshot name for backup
+	// +kubebuilder:validation:Required
+	// +kubebuilder:validation:MinLength=1
+	SnapName string `json:"snapName,omitempty"`
+
+	// PrevSnapName is the last completed-backup's snapshot name
+	PrevSnapName string `json:"prevSnapName,omitempty"`
+
+	// BackupDest is the remote address for backup transfer
+	// +kubebuilder:validation:Required
+	// +kubebuilder:validation:MinLength=1
+	BackupDest string `json:"backupDest"`
+}
+
+// ZFSBackupStatus is to hold status of backup
+type ZFSBackupStatus string
+
+// Status written onto ZFSBackup objects.
+const (
+	// BKPZFSStatusEmpty ensures the create operation is to be done, if import fails.
+	BKPZFSStatusEmpty ZFSBackupStatus = ""
+
+	// BKPZFSStatusDone , backup is completed.
+	BKPZFSStatusDone ZFSBackupStatus = "Done"
+
+	// BKPZFSStatusFailed , backup is failed.
+	BKPZFSStatusFailed ZFSBackupStatus = "Failed"
+
+	// BKPZFSStatusInit , backup is initialized.
+	BKPZFSStatusInit ZFSBackupStatus = "Init"
+
+	// BKPZFSStatusPending , backup is pending.
+	BKPZFSStatusPending ZFSBackupStatus = "Pending"
+
+	// BKPZFSStatusInProgress , backup is in progress.
+	BKPZFSStatusInProgress ZFSBackupStatus = "InProgress"
+
+	// BKPZFSStatusInvalid , backup operation is invalid.
+	BKPZFSStatusInvalid ZFSBackupStatus = "Invalid"
+)
+
+// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
+// +resource:path=zfsbackups
+
+// ZFSBackupList is a list of ZFSBackup resources
+type ZFSBackupList struct {
+	metav1.TypeMeta `json:",inline"`
+	metav1.ListMeta `json:"metadata"`
+
+	Items []ZFSBackup `json:"items"`
+}

pkg/apis/openebs.io/zfs/v1/zfsrestore.go

@@ -0,0 +1,88 @@
+/*
+Copyright 2020 The OpenEBS Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package v1
+
+import (
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+)
+
+// +genclient
+// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
+// +resource:path=zfsrestore
+
+// ZFSRestore describes a cstor restore resource created as a custom resource
+type ZFSRestore struct {
+	metav1.TypeMeta   `json:",inline"`
+	metav1.ObjectMeta `json:"metadata,omitempty"` // set name to restore name + volume name + something like csp tag
+	Spec              ZFSRestoreSpec              `json:"spec"`
+	Status            ZFSRestoreStatus            `json:"status"`
+}
+
+// ZFSRestoreSpec is the spec for a ZFSRestore resource
+type ZFSRestoreSpec struct {
+	// volume name to where restore has to be performed
+	// +kubebuilder:validation:Required
+	// +kubebuilder:validation:MinLength=1
+	VolumeName string `json:"volumeName"`
+	// owner node name where restore volume is present
+	// +kubebuilder:validation:Required
+	// +kubebuilder:validation:MinLength=1
+	OwnerNodeID string `json:"ownerNodeID"`
+
+	// it can be ip:port in case of restore from remote or volumeName in case of local restore
+	// +kubebuilder:validation:Required
+	// +kubebuilder:validation:MinLength=1
+	RestoreSrc string `json:"restoreSrc"`
+}
+
+// ZFSRestoreStatus is to hold result of action.
+type ZFSRestoreStatus string
+
+// Status written onto CStrorRestore object.
+const (
+	// RSTZFSStatusEmpty ensures the create operation is to be done, if import fails.
+	RSTZFSStatusEmpty ZFSRestoreStatus = ""
+
+	// RSTZFSStatusDone , restore operation is completed.
+	RSTZFSStatusDone ZFSRestoreStatus = "Done"
+
+	// RSTZFSStatusFailed , restore operation is failed.
+	RSTZFSStatusFailed ZFSRestoreStatus = "Failed"
+
+	// RSTZFSStatusInit , restore operation is initialized.
+	RSTZFSStatusInit ZFSRestoreStatus = "Init"
+
+	// RSTZFSStatusPending , restore operation is pending.
+	RSTZFSStatusPending ZFSRestoreStatus = "Pending"
+
+	// RSTZFSStatusInProgress , restore operation is in progress.
+	RSTZFSStatusInProgress ZFSRestoreStatus = "InProgress"
+
+	// RSTZFSStatusInvalid , restore operation is invalid.
+	RSTZFSStatusInvalid ZFSRestoreStatus = "Invalid"
+)
+
+// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
+// +resource:path=zfsrestores
+
+// ZFSRestoreList is a list of ZFSRestore resources
+type ZFSRestoreList struct {
+	metav1.TypeMeta `json:",inline"`
+	metav1.ListMeta `json:"metadata"`
+
+	Items []ZFSRestore `json:"items"`
+}

pkg/apis/openebs.io/zfs/v1/zz_generated.deepcopy.go

@@ -98,6 +98,158 @@ func (in *VolumeInfo) DeepCopy() *VolumeInfo {
 	return out
 }
 
+// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
+func (in *ZFSBackup) DeepCopyInto(out *ZFSBackup) {
+	*out = *in
+	out.TypeMeta = in.TypeMeta
+	in.ObjectMeta.DeepCopyInto(&out.ObjectMeta)
+	out.Spec = in.Spec
+	return
+}
+
+// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ZFSBackup.
+func (in *ZFSBackup) DeepCopy() *ZFSBackup {
+	if in == nil {
+		return nil
+	}
+	out := new(ZFSBackup)
+	in.DeepCopyInto(out)
+	return out
+}
+
+// DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
+func (in *ZFSBackup) DeepCopyObject() runtime.Object {
+	if c := in.DeepCopy(); c != nil {
+		return c
+	}
+	return nil
+}
+
+// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
+func (in *ZFSBackupList) DeepCopyInto(out *ZFSBackupList) {
+	*out = *in
+	out.TypeMeta = in.TypeMeta
+	in.ListMeta.DeepCopyInto(&out.ListMeta)
+	if in.Items != nil {
+		in, out := &in.Items, &out.Items
+		*out = make([]ZFSBackup, len(*in))
+		for i := range *in {
+			(*in)[i].DeepCopyInto(&(*out)[i])
+		}
+	}
+	return
+}
+
+// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ZFSBackupList.
+func (in *ZFSBackupList) DeepCopy() *ZFSBackupList {
+	if in == nil {
+		return nil
+	}
+	out := new(ZFSBackupList)
+	in.DeepCopyInto(out)
+	return out
+}
+
+// DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
+func (in *ZFSBackupList) DeepCopyObject() runtime.Object {
+	if c := in.DeepCopy(); c != nil {
+		return c
+	}
+	return nil
+}
+
+// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
+func (in *ZFSBackupSpec) DeepCopyInto(out *ZFSBackupSpec) {
+	*out = *in
+	return
+}
+
+// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ZFSBackupSpec.
+func (in *ZFSBackupSpec) DeepCopy() *ZFSBackupSpec {
+	if in == nil {
+		return nil
+	}
+	out := new(ZFSBackupSpec)
+	in.DeepCopyInto(out)
+	return out
+}
+
+// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
+func (in *ZFSRestore) DeepCopyInto(out *ZFSRestore) {
+	*out = *in
+	out.TypeMeta = in.TypeMeta
+	in.ObjectMeta.DeepCopyInto(&out.ObjectMeta)
+	out.Spec = in.Spec
+	return
+}
+
+// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ZFSRestore.
+func (in *ZFSRestore) DeepCopy() *ZFSRestore {
+	if in == nil {
+		return nil
+	}
+	out := new(ZFSRestore)
+	in.DeepCopyInto(out)
+	return out
+}
+
+// DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
+func (in *ZFSRestore) DeepCopyObject() runtime.Object {
+	if c := in.DeepCopy(); c != nil {
+		return c
+	}
+	return nil
+}
+
+// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
+func (in *ZFSRestoreList) DeepCopyInto(out *ZFSRestoreList) {
+	*out = *in
+	out.TypeMeta = in.TypeMeta
+	in.ListMeta.DeepCopyInto(&out.ListMeta)
+	if in.Items != nil {
+		in, out := &in.Items, &out.Items
+		*out = make([]ZFSRestore, len(*in))
+		for i := range *in {
+			(*in)[i].DeepCopyInto(&(*out)[i])
+		}
+	}
+	return
+}
+
+// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ZFSRestoreList.
+func (in *ZFSRestoreList) DeepCopy() *ZFSRestoreList {
+	if in == nil {
+		return nil
+	}
+	out := new(ZFSRestoreList)
+	in.DeepCopyInto(out)
+	return out
+}
+
+// DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
+func (in *ZFSRestoreList) DeepCopyObject() runtime.Object {
+	if c := in.DeepCopy(); c != nil {
+		return c
+	}
+	return nil
+}
+
+// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
+func (in *ZFSRestoreSpec) DeepCopyInto(out *ZFSRestoreSpec) {
+	*out = *in
+	return
+}
+
+// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ZFSRestoreSpec.
+func (in *ZFSRestoreSpec) DeepCopy() *ZFSRestoreSpec {
+	if in == nil {
+		return nil
+	}
+	out := new(ZFSRestoreSpec)
+	in.DeepCopyInto(out)
+	return out
+}
+
 // DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
 func (in *ZFSSnapshot) DeepCopyInto(out *ZFSSnapshot) {
 	*out = *in