Skip to content

Commit b57b7a9

Browse files
committed
doc: refine doc
1 parent 7b40b4c commit b57b7a9

File tree

3 files changed

+12
-4
lines changed

3 files changed

+12
-4
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ This driver allows Kubernetes to access [SMB](https://wiki.wireshark.org/SMB) se
2020
Please refer to `smb.csi.k8s.io` [driver parameters](./docs/driver-parameters.md)
2121

2222
### Install driver on a Kubernetes cluster
23-
- install by [kubectl](./docs/install-smb-csi-driver.md)
24-
- install by [helm charts](./charts)
23+
- install via [helm charts](./charts)
24+
- install via [kubectl](./docs/install-smb-csi-driver.md)
2525

2626
### Examples
2727
- [How to Use the Windows CSI Proxy and CSI SMB Driver for Kubernetes](https://www.phillipsj.net/posts/how-to-use-the-windows-csi-proxy-and-csi-smb-driver-for-kubernetes/)

deploy/example/e2e_usage.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,8 @@ Filesystem Size Used Avail Use% Mounted on
8989
apiVersion: v1
9090
kind: PersistentVolume
9191
metadata:
92+
annotations:
93+
pv.kubernetes.io/provisioned-by: smb.csi.k8s.io
9294
name: pv-smb
9395
spec:
9496
capacity:
@@ -103,7 +105,9 @@ spec:
103105
csi:
104106
driver: smb.csi.k8s.io
105107
readOnly: false
106-
volumeHandle: unique-volumeid # make sure it's a unique id in the cluster
108+
# volumeHandle format: {smb-server-address}#{sub-dir-name}#{share-name}
109+
# make sure this value is unique for every share in the cluster
110+
volumeHandle: smb-server.default.svc.cluster.local/share##
107111
volumeAttributes:
108112
source: "//smb-server-address/sharename"
109113
nodeStageSecretRef:

deploy/example/smb-provisioner/pv-smb-csi.yaml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
apiVersion: v1
33
kind: PersistentVolume
44
metadata:
5+
annotations:
6+
pv.kubernetes.io/provisioned-by: smb.csi.k8s.io
57
name: pv-smb
68
spec:
79
capacity:
@@ -16,7 +18,9 @@ spec:
1618
csi:
1719
driver: smb.csi.k8s.io
1820
readOnly: false
19-
volumeHandle: unique-volumeid # make sure it's a unique id in the cluster
21+
# volumeHandle format: {smb-server-address}#{sub-dir-name}#{share-name}
22+
# make sure this value is unique for every share in the cluster
23+
volumeHandle: smb-server.default.svc.cluster.local/share##
2024
volumeAttributes:
2125
source: "//smb-server.default.svc.cluster.local/share"
2226
nodeStageSecretRef:

0 commit comments

Comments
 (0)