Skip to content

Commit

Permalink
doc: fix fsName details in PV object
Browse files Browse the repository at this point in the history 
fsName is optional and its required
to mount the filesystem incase if we have
multiple filesystem in the cluster.

Signed-off-by: Madhu Rajanna <madhupr007@gmail.com>
  • Loading branch information
@Madhu-1 @mergify
Madhu-1 authored and mergify[bot] committed Jan 12, 2024
1 parent e008e16 commit 200fbdb
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions docs/static-pvc.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -202,9 +202,10 @@ spec:
# node stage secret namespace where above secret is created
namespace: default
volumeAttributes:
# optional file system to be mounted
"fsName": "myfs"
# Required options from storageclass parameters need to be added in volumeAttributes
"clusterID": "ba68226a-672f-4ba5-97bc-22840318b2ec"
"fsName": "myfs"
"staticVolume": "true"
"rootPath": /volumes/testGroup/testSubVolume
# volumeHandle can be anything, need not to be same
Expand All @@ -228,7 +229,7 @@ static CephFS PV
| Attributes | Description | Required |
| :----------: | :--------------------------------------------------------------------------------------------------------------------------------------------------: | :------: |
| clusterID | The clusterID is used by the CSI plugin to uniquely identify and use a Ceph cluster (this is the key in configmap created duing ceph-csi deployment) | Yes |
| fsName | CephFS filesystem name into which the subvolume should be created/present | Yes |
| fsName | CephFS filesystem name to be mounted. Not passing this option mounts the default file system. | No |
| staticVolume | Value must be set to `true` to mount and unmount static cephFS PVC | Yes |
| rootPath | Actual path of the subvolume in ceph cluster, can be retrieved by issuing getpath command as described above | Yes |

Expand Down

0 comments on commit 200fbdb

Please sign in to comment.