Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: refine doc #574

Merged
merged 1 commit into from
Jan 25, 2023
Merged

doc: refine doc #574

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ This driver allows Kubernetes to access [SMB](https://wiki.wireshark.org/SMB) se
Please refer to `smb.csi.k8s.io` [driver parameters](./docs/driver-parameters.md)

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

### Examples
- [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/)
Expand Down
6 changes: 5 additions & 1 deletion deploy/example/e2e_usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,8 @@ Filesystem Size Used Avail Use% Mounted on
apiVersion: v1
kind: PersistentVolume
metadata:
annotations:
pv.kubernetes.io/provisioned-by: smb.csi.k8s.io
name: pv-smb
spec:
capacity:
Expand All @@ -103,7 +105,9 @@ spec:
csi:
driver: smb.csi.k8s.io
readOnly: false
volumeHandle: unique-volumeid # make sure it's a unique id in the cluster
# volumeHandle format: {smb-server-address}#{sub-dir-name}#{share-name}
# make sure this value is unique for every share in the cluster
volumeHandle: smb-server.default.svc.cluster.local/share##
volumeAttributes:
source: "//smb-server-address/sharename"
nodeStageSecretRef:
Expand Down
6 changes: 5 additions & 1 deletion deploy/example/smb-provisioner/pv-smb-csi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
apiVersion: v1
kind: PersistentVolume
metadata:
annotations:
pv.kubernetes.io/provisioned-by: smb.csi.k8s.io
name: pv-smb
spec:
capacity:
Expand All @@ -16,7 +18,9 @@ spec:
csi:
driver: smb.csi.k8s.io
readOnly: false
volumeHandle: unique-volumeid # make sure it's a unique id in the cluster
# volumeHandle format: {smb-server-address}#{sub-dir-name}#{share-name}
# make sure this value is unique for every share in the cluster
volumeHandle: smb-server.default.svc.cluster.local/share##
volumeAttributes:
source: "//smb-server.default.svc.cluster.local/share"
nodeStageSecretRef:
Expand Down