mirror of
https://github.com/TECHNOFAB11/zfs-localpv.git
synced 2025-12-12 06:20:11 +01:00
This commits support snapshot and clone commands via CSI driver. User can create snap and clone using the following steps.
Note:
- Snapshot is created via reconciliation CR
- Cloned volume will be on the same zpool where the snapshot is taken
- Cloned volume will have same properties as source volume.
-----------------------------------
Create a Snapshotclass
```
kind: VolumeSnapshotClass
apiVersion: snapshot.storage.k8s.io/v1beta1
metadata:
name: zfspv-snapclass
annotations:
snapshot.storage.kubernetes.io/is-default-class: "true"
driver: zfs.csi.openebs.io
deletionPolicy: Delete
```
Once snapshotclass is created, we can use this class to create a Snapshot
```
apiVersion: snapshot.storage.k8s.io/v1beta1
kind: VolumeSnapshot
metadata:
name: zfspv-snap
spec:
volumeSnapshotClassName: zfspv-snapclass
source:
persistentVolumeClaimName: csi-zfspv
```
```
$ kubectl get volumesnapshot
NAME AGE
zfspv-snap 7m52s
```
```
$ kubectl get volumesnapshot -o yaml
apiVersion: v1
items:
- apiVersion: snapshot.storage.k8s.io/v1beta1
kind: VolumeSnapshot
metadata:
annotations:
kubectl.kubernetes.io/last-applied-configuration: |
{"apiVersion":"snapshot.storage.k8s.io/v1beta1","kind":"VolumeSnapshot","metadata":{"annotations":{},"name":"zfspv-snap","namespace":"default"},"spec":{"source":{"persistentVolumeClaimName":"csi-zfspv"},"volumeSnapshotClassName":"zfspv-snapclass"}}
creationTimestamp: "2020-01-30T10:31:24Z"
finalizers:
- snapshot.storage.kubernetes.io/volumesnapshot-as-source-protection
- snapshot.storage.kubernetes.io/volumesnapshot-bound-protection
generation: 1
name: zfspv-snap
namespace: default
resourceVersion: "30040"
selfLink: /apis/snapshot.storage.k8s.io/v1beta1/namespaces/default/volumesnapshots/zfspv-snap
uid: 1a5cf166-c599-4f58-9f3c-f1148be47fca
spec:
source:
persistentVolumeClaimName: csi-zfspv
volumeSnapshotClassName: zfspv-snapclass
status:
boundVolumeSnapshotContentName: snapcontent-1a5cf166-c599-4f58-9f3c-f1148be47fca
creationTime: "2020-01-30T10:31:24Z"
readyToUse: true
restoreSize: "0"
kind: List
metadata:
resourceVersion: ""
selfLink: ""
```
Openebs resource for the created snapshot
```
$ kubectl get snap -n openebs -o yaml
apiVersion: v1
items:
- apiVersion: openebs.io/v1alpha1
kind: ZFSSnapshot
metadata:
creationTimestamp: "2020-01-30T10:31:24Z"
finalizers:
- zfs.openebs.io/finalizer
generation: 2
labels:
kubernetes.io/nodename: pawan-2
openebs.io/persistent-volume: pvc-18cab7c3-ec5e-4264-8507-e6f7df4c789a
name: snapshot-1a5cf166-c599-4f58-9f3c-f1148be47fca
namespace: openebs
resourceVersion: "30035"
selfLink: /apis/openebs.io/v1alpha1/namespaces/openebs/zfssnapshots/snapshot-1a5cf166-c599-4f58-9f3c-f1148be47fca
uid: e29d571c-42b5-4fb7-9110-e1cfc9b96641
spec:
capacity: "4294967296"
fsType: zfs
ownerNodeID: pawan-2
poolName: zfspv-pool
status: Ready
volumeType: DATASET
kind: List
metadata:
resourceVersion: ""
selfLink: ""
```
Create a clone volume
We can provide a datasource as snapshot name to create a clone volume
```yaml
kind: PersistentVolumeClaim
apiVersion: v1
metadata:
name: zfspv-clone
spec:
storageClassName: openebs-zfspv
dataSource:
name: zfspv-snap
kind: VolumeSnapshot
apiGroup: snapshot.storage.k8s.io
accessModes:
- ReadWriteOnce
resources:
requests:
storage: 4Gi
```
It will create a ZFS clone volume from the mentioned snapshot and create the PV on the same node where original volume is there.
Here, As resize is not supported yet, the clone PVC size should match the size of the snapshot.
Also, all the properties from the storageclass will not be considered for the clone case, it will take the properties from the snapshot and create the clone volume. One thing to note here is that, the storageclass in clone PVC should have the same poolname as that of the original volume as across the pool, clone is not supported.
Signed-off-by: Pawan <pawan@mayadata.io>
127 lines
3.6 KiB
Go
127 lines
3.6 KiB
Go
/*
|
|
Copyright © 2019 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 v1alpha1
|
|
|
|
import (
|
|
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
|
|
)
|
|
|
|
// +genclient
|
|
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
|
|
// +resource:path=zfsvolume
|
|
|
|
// ZFSVolume represents a ZFS based volume
|
|
type ZFSVolume struct {
|
|
metav1.TypeMeta `json:",inline"`
|
|
metav1.ObjectMeta `json:"metadata,omitempty"`
|
|
|
|
Spec VolumeInfo `json:"spec"`
|
|
}
|
|
|
|
// MountInfo contains the volume related info
|
|
// for all types of volumes in ZFSVolume
|
|
type MountInfo struct {
|
|
// FSType of a volume will specify the
|
|
// format type - ext4(default), xfs of PV
|
|
FSType string `json:"fsType"`
|
|
|
|
// AccessMode of a volume will hold the
|
|
// access mode of the volume
|
|
AccessModes []string `json:"accessModes"`
|
|
|
|
// MountPath of the volume will hold the
|
|
// path on which the volume is mounted
|
|
// on that node
|
|
MountPath string `json:"mountPath"`
|
|
|
|
// ReadOnly specifies if the volume needs
|
|
// to be mounted in ReadOnly mode
|
|
ReadOnly bool `json:"readOnly"`
|
|
|
|
// MountOptions specifies the options with
|
|
// which mount needs to be attempted
|
|
MountOptions []string `json:"mountOptions"`
|
|
}
|
|
|
|
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
|
|
// +resource:path=zfsvolumes
|
|
|
|
// ZFSVolumeList is a list of ZFSVolume resources
|
|
type ZFSVolumeList struct {
|
|
metav1.TypeMeta `json:",inline"`
|
|
metav1.ListMeta `json:"metadata"`
|
|
|
|
Items []ZFSVolume `json:"items"`
|
|
}
|
|
|
|
// VolumeInfo contains the volume related info
|
|
// for all types of volumes in ZFSVolume
|
|
type VolumeInfo struct {
|
|
// OwnerNodeID is the Node ID which
|
|
// is the owner of this Volume
|
|
OwnerNodeID string `json:"ownerNodeID"`
|
|
|
|
// poolName specifies the name of the
|
|
// pool where this volume should be created
|
|
PoolName string `json:"poolName"`
|
|
|
|
// SnapName specifies the name of the
|
|
// snapshot where this volume should be cloned
|
|
SnapName string `json:"snapname,omitempty"`
|
|
|
|
// Capacity of the volume
|
|
Capacity string `json:"capacity"`
|
|
|
|
// RecordSize specifies the record size
|
|
// for the zfs dataset
|
|
RecordSize string `json:"recordsize,omitempty"`
|
|
|
|
// VolBlockSize specifies the block size for the zvol
|
|
VolBlockSize string `json:"volblocksize,omitempty"`
|
|
|
|
// Compression specifies if the it should
|
|
// enabled on the zvol
|
|
Compression string `json:"compression,omitempty"`
|
|
|
|
// Dedup specifies the deduplication
|
|
// should be enabled on the zvol
|
|
Dedup string `json:"dedup,omitempty"`
|
|
|
|
// Encryption specifies the encryption
|
|
// should be enabled on the zvol
|
|
Encryption string `json:"encryption,omitempty"`
|
|
|
|
// KeyLocation is the location of key
|
|
// for the encryption
|
|
KeyLocation string `json:"keylocation,omitempty"`
|
|
|
|
// KeyFormat specifies format of the
|
|
// encryption key
|
|
KeyFormat string `json:"keyformat,omitempty"`
|
|
|
|
// Thinprovision specifies if we should
|
|
// thin provisioned the volume or not
|
|
ThinProvision string `json:"thinProvision,omitempty"`
|
|
|
|
// VolumeType specifies whether the volume is
|
|
// zvol or a dataset
|
|
VolumeType string `json:"volumeType"`
|
|
|
|
// FsType specifies filesystem type for the
|
|
// zfs volume/dataset
|
|
FsType string `json:"fsType,omitempty"`
|
|
}
|