This document will show you how to create cloud snapshots of Portworx volumes and how you can clone those snapshots to use them in pods.
This requires that you already have STORK installed and running on your Kubernetes cluster. If you fetched the Portworx specs from https://install.portworx.com and used the default options, STORK is already installed.
Group snapshots are supported in Portworx version 1.4 and above.
Configuring cloud secrets
To create a cloud snapshot, one needs to setup secrets with Portworx which will get used to connect and authenticate with the configured cloud provider.
Follow instructions on the pxctl credentials page to setup secrets.
Creating cloud snapshots
The cloud snapshot method supports the following annotations:
- portworx/snapshot-type: Indicates the type of snapshot. For cloud snapshots, the value should be cloud.
- portworx/cloud-cred-id: (Optional) This specifies the credentials UUID if you have configured credentials for multiple cloud providers. In a situation where a single cloud provider is configured, this is not required.
In below example, we create a cloud snapshot for a PVC called mysql-data backed by a Portworx volume.
apiVersion: volumesnapshot.external-storage.k8s.io/v1 kind: VolumeSnapshot metadata: name: mysql-snapshot namespace: default annotations: portworx/snapshot-type: cloud spec: persistentVolumeClaimName: mysql-data
Once you apply the above object you can check the status of the snapshots using
$ kubectl get volumesnapshot NAME AGE volumesnapshots/mysql-snapshot 2s
$ kubectl get volumesnapshotdatas NAME AGE volumesnapshotdatas/k8s-volume-snapshot-2bc36c2d-227f-11e8-a3d4-5a34ec89e61c 1s
The creation of the volumesnapshotdatas object indicates that the snapshot has been created. If you describe the volumesnapshotdatas object you can see the Portworx Cloud Snapshot ID and the PVC for which the snapshot was created.
$ kubectl describe volumesnapshotdatas Name: k8s-volume-snapshot-2bc36c2d-227f-11e8-a3d4-5a34ec89e61c Namespace: Labels: <none> Annotations: <none> API Version: volumesnapshot.external-storage.k8s.io/v1 Kind: VolumeSnapshotData Metadata: Cluster Name: Creation Timestamp: 2018-03-08T03:17:02Z Deletion Grace Period Seconds: <nil> Deletion Timestamp: <nil> Resource Version: 29989636 Self Link: /apis/volumesnapshot.external-storage.k8s.io/v1/k8s-volume-snapshot-2bc36c2d-227f-11e8-a3d4-5a34ec89e61c UID: 2bc3a203-227f-11e8-98cc-0214683e8447 Spec: Persistent Volume Ref: Kind: PersistentVolume Name: pvc-f782bf5c-20e7-11e8-931d-0214683e8447 Portworx Volume: Snapshot Id: 687c60d0-73cb-4055-a08f-33c5ab8d4d8e/149813028909420894-125009403033610837-incr Volume Snapshot Ref: Kind: VolumeSnapshot Name: default/mysql-snapshot-2b2150dd-227f-11e8-98cc-0214683e8447 Status: Conditions: Last Transition Time: <nil> Message: Reason: Status: Type: Creation Timestamp: <nil> Events: <none>
Creating PVCs from cloud snapshots
When you install STORK, it also creates a storage class called stork-snapshot-sc. This storage class can be used to create PVCs from snapshots.
To create a PVC from a snapshot, you would add the
snapshot.alpha.kubernetes.io/snapshot annotation to refer to the snapshot name.
For the above snapshot, the spec would like this:
apiVersion: v1 kind: PersistentVolumeClaim metadata: name: mysql-snap-clone annotations: snapshot.alpha.kubernetes.io/snapshot: mysql-snapshot spec: accessModes: - ReadWriteOnce storageClassName: stork-snapshot-sc resources: requests: storage: 2Gi
Once you apply the above spec you will see a PVC created by STORK. This PVC will be backed by a Portworx volume clone of the snapshot created above.
$ kubectl get pvc NAMESPACE NAME STATUS VOLUME CAPACITY ACCESS MODES STORAGECLASS AGE default mysql-data Bound pvc-f782bf5c-20e7-11e8-931d-0214683e8447 2Gi RWO px-mysql-sc 2d default mysql-snap-clone Bound pvc-05d3ce48-2280-11e8-98cc-0214683e8447 2Gi RWO stork-snapshot-sc 2s