Skip to main content
Version: 3.1

Cloud backups for single PVCs

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.


Installing Stork

This requires that you already have [Stork] (/operations/operate-kubernetes/storage-operations/stork) installed and running on your Kubernetes cluster. If you fetched the Portworx specs from the Portworx spec generator in Portworx Central and used the default options, Stork is already installed.

Portworx version

Cloud snapshots using below method is supported in Portworx version 1.4 and above. Cloud snapshots (for aggregated volumes) using below method is supported in Portworx version 2.0 and above.

Configuring cloud secrets

To create cloud snapshots, one needs to setup secrets with Portworx which will get used to connect and authenticate with the configured cloud provider.

Follow instructions on the create and configure credentials section 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.
  • This specifies the number of incremental cloud snapshots after which a full backup will be taken.


In below example, we create a cloud snapshot for a PVC called mysql-data backed by a Portworx volume.

kind: VolumeSnapshot
name: mysql-snapshot
namespace: default
portworx/snapshot-type: cloud
persistentVolumeClaimName: mysql-data

Once you apply the above object you can check the status of the snapshots using the kubectl get command with the name of your snapshot appended:

kubectl get
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
Labels: <none>
Annotations: <none>
API Version:
Kind: VolumeSnapshotData
Cluster Name:
Creation Timestamp: 2018-03-08T03:17:02Z
Deletion Grace Period Seconds: <nil>
Deletion Timestamp: <nil>
Resource Version: 29989636
Self Link: /apis/
UID: 2bc3a203-227f-11e8-98cc-0214683e8447
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
Last Transition Time: <nil>
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 annotation to refer to the snapshot name.

For the above snapshot, the spec would like this:

apiVersion: v1
kind: PersistentVolumeClaim
name: mysql-snap-clone
annotations: mysql-snapshot
- ReadWriteOnce
storageClassName: stork-snapshot-sc
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
Was this page helpful?