technofab/zfs-localpv
1
0
Fork 0
mirror of https://github.com/TECHNOFAB11/zfs-localpv.git synced 2025-12-12 06:20:11 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

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

Browse source 
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>
This commit is contained in:
Pawan Prakash Sharma 2020-09-08 13:44:39 +05:30 • committed by GitHub
parent a5e645b43d
commit e40026c98a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
48 changed files with 5148 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

88
pkg/apis/openebs.io/zfs/v1/zfsrestore.go Normal file
View file

@ -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"`
}