doc: example of StorageClass for NFS-provisioning

Signed-off-by: Niels de Vos <ndevos@redhat.com>
This commit is contained in:
Niels de Vos 2022-03-25 15:16:32 +01:00 committed by mergify[bot]
parent 885295fcc9
commit 2743510009

View File

@ -0,0 +1,49 @@
---
apiVersion: storage.k8s.io/v1
kind: StorageClass
metadata:
name: csi-nfs-sc
provisioner: nfs.csi.ceph.com
parameters:
# (required) Name of the NFS-cluster as managed by Ceph.
nfsCluster: <nfs-cluster>
# (required) Hostname, ip-address or service that points to the Ceph managed
# NFS-server that will be used for mounting the NFS-export.
server: <nfs-server>
#
# The parameters below are standard CephFS options, these are used for
# managing the underlying CephFS volume.
#
# (required) String representing a Ceph cluster to provision storage from.
# Should be unique across all Ceph clusters in use for provisioning,
# cannot be greater than 36 bytes in length, and should remain immutable for
# the lifetime of the StorageClass in use.
# Ensure to create an entry in the configmap named ceph-csi-config, based on
# csi-config-map-sample.yaml, to accompany the string chosen to
# represent the Ceph cluster in clusterID below
clusterID: <cluster-id>
# (required) CephFS filesystem name into which the volume shall be created
# eg: fsName: myfs
fsName: <cephfs-name>
# (optional) Ceph pool into which volume data shall be stored
# pool: <cephfs-data-pool>
# The secrets have to contain user and/or Ceph admin credentials.
csi.storage.k8s.io/provisioner-secret-name: csi-cephfs-secret
csi.storage.k8s.io/provisioner-secret-namespace: default
csi.storage.k8s.io/controller-expand-secret-name: csi-cephfs-secret
csi.storage.k8s.io/controller-expand-secret-namespace: default
csi.storage.k8s.io/node-stage-secret-name: csi-cephfs-secret
csi.storage.k8s.io/node-stage-secret-namespace: default
# (optional) Prefix to use for naming subvolumes.
# If omitted, defaults to "csi-vol-".
volumeNamePrefix: nfs-export-
reclaimPolicy: Delete
allowVolumeExpansion: false