Skip to content

Commit

Permalink
doc: remove storageclass details for shallow volume
Browse files Browse the repository at this point in the history
As shallow volumes are default for ROX pvc from
snapshot, removing the details from doc for better
clarity.

Signed-off-by: Madhu Rajanna <madhupr007@gmail.com>
  • Loading branch information
Madhu-1 committed Sep 14, 2023
1 parent 4560ae8 commit 2e23ed4
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions docs/cephfs-snapshot-backed-volumes.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,17 +18,18 @@ information.
### Provisioning a snapshot-backed volume from a volume snapshot

For provisioning new snapshot-backed volumes, following configuration must be
set for storage class(es) and their PVCs respectively:
set for PVCs:

* StorageClass:
* Specify `backingSnapshot: "true"` parameter.
* PersistentVolumeClaim:
* Set `storageClassName` to point to your storage class with backing
snapshots enabled.
* Set `storageClassName` to point to your existing cephFS storage class.
* Define `spec.dataSource` for your desired source volume snapshot.
* Set `spec.accessModes` to `ReadOnlyMany`. This is the only access mode that
is supported by this feature.

Note:- We can also disable shallowVolume by setting `backingSnapshot: "false"
in cephFS storageclass. If the value is set in the storageclass when requested
for `ReadOnlyMany` PVC a clone will get created in ceph cluster.

### Mounting snapshots from pre-provisioned volumes

Steps for defining a PersistentVolume and PersistentVolumeClaim for
Expand Down

0 comments on commit 2e23ed4

Please sign in to comment.