Skip to content

Commit f26f9a1

Browse files
committed
docs: consistent StorageClass names, multiple provisioners installation
1 parent 65ce889 commit f26f9a1

File tree

5 files changed

+18
-6
lines changed

5 files changed

+18
-6
lines changed

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ This is `deploy/class.yaml` which defines the NFS subdir external provisioner's
127127
apiVersion: storage.k8s.io/v1
128128
kind: StorageClass
129129
metadata:
130-
name: managed-nfs-storage
130+
name: nfs-client
131131
provisioner: k8s-sigs.io/nfs-subdir-external-provisioner # or choose another name, must match deployment's env PROVISIONER_NAME'
132132
parameters:
133133
pathPattern: "${.PVC.namespace}/${.PVC.annotations.nfs.io/storage-path}" # waits for nfs.io/storage-path annotation, if not specified will accept as empty string.
@@ -166,7 +166,7 @@ metadata:
166166
annotations:
167167
nfs.io/storage-path: "test-path" # not required, depending on whether this annotation was shown in the storage class description
168168
spec:
169-
storageClassName: managed-nfs-storage
169+
storageClassName: nfs-client
170170
accessModes:
171171
- ReadWriteMany
172172
resources:

charts/nfs-subdir-external-provisioner/README.md

+13-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ $ helm install my-release nfs-subdir-external-provisioner/nfs-subdir-external-pr
3030
--set nfs.path=/exported/path
3131
```
3232

33-
The command deploys the given storage class in the default configuration. It can be used afterswards to provision persistent volumes. The [configuration](#configuration) section lists the parameters that can be configured during installation.
33+
The command deploys the given storage class in the default configuration. It can be used afterwards to provision persistent volumes. The [configuration](#configuration) section lists the parameters that can be configured during installation.
3434

3535
> **Tip**: List all releases using `helm list`
3636
@@ -83,3 +83,15 @@ The following tables lists the configurable parameters of this chart and their d
8383
| `affinity` | Affinity settings | `{}` |
8484
| `tolerations` | List of node taints to tolerate | `[]` |
8585
| `labels` | Additional labels for any resource created | `{}` |
86+
87+
## Install Multiple Provisioners
88+
89+
It is possible to install more than one provisioner in your cluster to have access to multiple nfs servers and/or multiple exports from a single nfs server. Each provisioner must have a different `storageClass.provisionerName` and therefore a different `storageClass.name`. For example:
90+
91+
```console
92+
helm install second-nfs-subdir-external-provisioner nfs-subdir-external-provisioner/nfs-subdir-external-provisioner \
93+
--set nfs.server=y.y.y.y \
94+
--set nfs.path=/other/exported/path \
95+
--set storageClass.name=second-nfs-client \
96+
--set storageClass.provisionerName=k8s-sigs.io/second-nfs-subdir-external-provisioner
97+
```

deploy/class.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
apiVersion: storage.k8s.io/v1
22
kind: StorageClass
33
metadata:
4-
name: managed-nfs-storage
4+
name: nfs-client
55
provisioner: k8s-sigs.io/nfs-subdir-external-provisioner # or choose another name, must match deployment's env PROVISIONER_NAME'
66
parameters:
77
archiveOnDelete: "false"

deploy/objects/class.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
apiVersion: storage.k8s.io/v1
22
kind: StorageClass
33
metadata:
4-
name: managed-nfs-storage
4+
name: nfs-client
55
provisioner: k8s-sigs.io/nfs-subdir-external-provisioner # or choose another name, must match deployment's env PROVISIONER_NAME'
66
parameters:
77
archiveOnDelete: "false"

deploy/test-claim.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ apiVersion: v1
33
metadata:
44
name: test-claim
55
spec:
6-
storageClassName: managed-nfs-storage
6+
storageClassName: nfs-client
77
accessModes:
88
- ReadWriteMany
99
resources:

0 commit comments

Comments
 (0)