mirrors/ceph-csi
1
0
Fork 0
mirror of https://github.com/ceph/ceph-csi.git synced 2024-12-02 03:00:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc: fix fsName details in PV object

Browse Source 
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>
(cherry picked from commit 200fbdbf28)
This commit is contained in:
Madhu Rajanna 2024-01-12 10:12:16 +01:00 committed by mergify[bot]
parent 1481045ca2
commit e4f2c43031
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/static-pvc.md
View File

@ -202,9 +202,10 @@ spec:
# node stage secret namespace where above secret is created # node stage secret namespace where above secret is created
namespace: default namespace: default
volumeAttributes: volumeAttributes:
# optional file system to be mounted
"fsName": "myfs"
# Required options from storageclass parameters need to be added in volumeAttributes # Required options from storageclass parameters need to be added in volumeAttributes
"clusterID": "ba68226a-672f-4ba5-97bc-22840318b2ec" "clusterID": "ba68226a-672f-4ba5-97bc-22840318b2ec"
"fsName": "myfs"
"staticVolume": "true" "staticVolume": "true"
"rootPath": /volumes/testGroup/testSubVolume "rootPath": /volumes/testGroup/testSubVolume
# volumeHandle can be anything, need not to be same # volumeHandle can be anything, need not to be same
@ -228,7 +229,7 @@ static CephFS PV
| Attributes | Description | Required | | 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 | | 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 | | 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 | | rootPath | Actual path of the subvolume in ceph cluster, can be retrieved by issuing getpath command as described above | Yes |