Skip to content

Commit 68587f9

Browse files
andyzhangxandyzhangx
authored
Update README.md
1 parent 205a1fa commit 68587f9

File tree

1 file changed

+40
-35
lines changed

1 file changed

+40
-35
lines changed

‎charts/README.md‎

Lines changed: 40 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,6 @@
77
- make controller only run on master node: `--set controller.runOnMaster=true`
88
- set replica of controller as `1`: `--set controller.replicas=1`
99

10-
## install latest version
11-
```console
12-
helm repo add csi-driver-smb https://raw.githubusercontent.com/kubernetes-csi/csi-driver-smb/master/charts
13-
helm install csi-driver-smb csi-driver-smb/csi-driver-smb --namespace kube-system
14-
```
15-
1610
### install a specific version
1711
```console
1812
helm repo add csi-driver-smb https://raw.githubusercontent.com/kubernetes-csi/csi-driver-smb/master/charts
@@ -59,61 +53,72 @@ The following table lists the configurable parameters of the latest SMB CSI Driv
5953
| `serviceAccount.create` | whether create service account of csi-smb-controller | `true` |
6054
| `rbac.create` | whether create rbac of csi-smb-controller | `true` |
6155
| `rbac.name` | driver name in rbac role | `true` |
56+
| `podAnnotations` | collection of annotations to add to all the pods | `{}` |
57+
| `podLabels` | collection of labels to add to all the pods | `{}` |
58+
| `priorityClassName` | priority class name to be added to pods | `system-cluster-critical` |
59+
| `securityContext` | security context to be added to pods | `{}` |
6260
| `controller.name` | name of driver deployment | `csi-smb-controller`
6361
| `controller.replicas` | the replicas of csi-smb-controller | `2` |
6462
| `controller.metricsPort` | metrics port of csi-smb-controller |`29644` |
6563
| `controller.livenessProbe.healthPort ` | health check port for liveness probe | `29642` |
6664
| `controller.logLevel` | controller driver log level |`5` |
67-
| `node.maxUnavailable` | `maxUnavailable` value of csi-smb-node daemonset |`1`
68-
| `node.metricsPort` | metrics port of csi-smb-node |`29645`
69-
| `node.logLevel` | node driver log level |`5` |
70-
| `linux.enabled` | whether enable linux feature |`true` |
71-
| `linux.dsName` | name of driver daemonset on linux |`csi-smb-node` |
72-
| `linux.kubelet` | configure kubelet directory path on Linux agent node node | `/var/lib/kubelet` |
73-
| `windows.enabled` | whether enable windows feature | `false` |
74-
| `windows.dsName` | name of driver daemonset on windows |`csi-smb-node-win` |
75-
| `windows.kubelet` | configure kubelet directory path on Windows agent node | `'C:\var\lib\kubelet'` |
7665
| `controller.runOnMaster` | run controller on master node | `false` |
7766
| `node.livenessProbe.healthPort ` | health check port for liveness probe | `29643` |
78-
| `controller.resources.csiProvisioner.limits.cpu` | csi-provisioner cpu limits | `100m` |
67+
| `controller.resources.csiProvisioner.limits.cpu` | csi-provisioner cpu limits | `1` |
7968
| `controller.resources.csiProvisioner.limits.memory` | csi-provisioner memory limits | `100Mi` |
8069
| `controller.resources.csiProvisioner.requests.cpu` | csi-provisioner cpu requests limits | `10m` |
8170
| `controller.resources.csiProvisioner.requests.memory` | csi-provisioner memory requests limits | `20Mi` |
82-
| `controller.resources.livenessProbe.limits.cpu` | liveness-probe cpu limits | `100m` |
71+
| `controller.resources.livenessProbe.limits.cpu` | liveness-probe cpu limits | `1` |
8372
| `controller.resources.livenessProbe.limits.memory` | liveness-probe memory limits | `300Mi` |
8473
| `controller.resources.livenessProbe.requests.cpu` | liveness-probe cpu requests limits | `10m` |
8574
| `controller.resources.livenessProbe.requests.memory` | liveness-probe memory requests limits | `20Mi` |
86-
| `controller.resources.smb.limits.cpu` | smb-csi-driver cpu limits | `200m` |
75+
| `controller.resources.smb.limits.cpu` | smb-csi-driver cpu limits | `1` |
8776
| `controller.resources.smb.limits.memory` | smb-csi-driver memory limits | `200Mi` |
8877
| `controller.resources.smb.requests.cpu` | smb-csi-driver cpu requests limits | `10m` |
8978
| `controller.resources.smb.requests.memory` | smb-csi-driver memory requests limits | `20Mi` |
90-
| `controller.resources.csiResizer.limits.cpu` | csi-resizer cpu limits | `100m` |
79+
| `controller.resources.csiResizer.limits.cpu` | csi-resizer cpu limits | `1` |
9180
| `controller.resources.csiResizer.limits.memory` | csi-resizer memory limits | `300Mi` |
9281
| `controller.resources.csiResizer.requests.cpu` | csi-resizer cpu requests limits | `10m` |
9382
| `controller.resources.csiResizer.requests.memory` | csi-resizer memory requests limits | `20Mi` |
9483
| `controller.affinity` | controller pod affinity | `{}` |
9584
| `controller.nodeSelector` | controller pod node selector | `{}` |
9685
| `controller.tolerations` | controller pod tolerations | `[]` |
86+
| `node.maxUnavailable` | `maxUnavailable` value of csi-smb-node daemonset |`1`
9787
| `node.metricsPort` | metrics port of csi-smb-node |`29645` |
9888
| `node.livenessProbe.healthPort ` | health check port for liveness probe | `29643` |
99-
| `node.resources.livenessProbe.limits.cpu` | liveness-probe cpu limits | `100m` |
100-
| `node.resources.livenessProbe.limits.memory` | liveness-probe memory limits | `100Mi` |
101-
| `node.resources.livenessProbe.requests.cpu` | liveness-probe cpu requests limits | `10m` |
102-
| `node.resources.livenessProbe.requests.memory` | liveness-probe memory requests limits | `20Mi` |
103-
| `node.resources.nodeDriverRegistrar.limits.cpu` | csi-node-driver-registrar cpu limits | `100m` |
104-
| `node.resources.nodeDriverRegistrar.limits.memory` | csi-node-driver-registrar memory limits | `100Mi` |
105-
| `node.resources.nodeDriverRegistrar.requests.cpu` | csi-node-driver-registrar cpu requests limits | `10m` |
106-
| `node.resources.nodeDriverRegistrar.requests.memory` | csi-node-driver-registrar memory requests limits | `20Mi` |
107-
| `node.resources.smb.limits.cpu` | smb-csi-driver cpu limits | `2` |
108-
| `node.resources.smb.limits.memory` | smb-csi-driver memory limits | `2100Mi` |
109-
| `node.resources.smb.requests.cpu` | smb-csi-driver cpu requests limits | `10m` |
110-
| `node.resources.smb.requests.memory` | smb-csi-driver memory requests limits | `20Mi` |
89+
| `node.logLevel` | node driver log level |`5` |
11190
| `node.affinity` | node pod affinity | {} |
11291
| `node.nodeSelector` | node pod node selector | `{}` |
113-
| `podAnnotations` | collection of annotations to add to all the pods | `{}` |
114-
| `podLabels` | collection of labels to add to all the pods | `{}` |
115-
| `priorityClassName` | priority class name to be added to pods | `system-cluster-critical` |
116-
| `securityContext` | security context to be added to pods | `{}` |
92+
| `linux.enabled` | whether enable linux feature |`true` |
93+
| `linux.dsName` | name of driver daemonset on linux |`csi-smb-node` |
94+
| `linux.kubelet` | configure kubelet directory path on Linux agent node node | `/var/lib/kubelet` |
95+
| `linux.resources.livenessProbe.limits.cpu` | liveness-probe cpu limits | `1` |
96+
| `linux.resources.livenessProbe.limits.memory` | liveness-probe memory limits | `100Mi` |
97+
| `linux.resources.livenessProbe.requests.cpu` | liveness-probe cpu requests limits | `10m` |
98+
| `linux.resources.livenessProbe.requests.memory` | liveness-probe memory requests limits | `20Mi` |
99+
| `linux.resources.nodeDriverRegistrar.limits.cpu` | csi-node-driver-registrar cpu limits | `1` |
100+
| `linux.resources.nodeDriverRegistrar.limits.memory` | csi-node-driver-registrar memory limits | `100Mi` |
101+
| `linux.resources.nodeDriverRegistrar.requests.cpu` | csi-node-driver-registrar cpu requests limits | `10m` |
102+
| `linux.resources.nodeDriverRegistrar.requests.memory` | csi-node-driver-registrar memory requests limits | `20Mi` |
103+
| `linux.resources.smb.limits.cpu` | smb-csi-driver cpu limits | `1` |
104+
| `linux.resources.smb.limits.memory` | smb-csi-driver memory limits | `200Mi` |
105+
| `linux.resources.smb.requests.cpu` | smb-csi-driver cpu requests limits | `10m` |
106+
| `linux.resources.smb.requests.memory` | smb-csi-driver memory requests limits | `20Mi`
107+
| `windows.enabled` | whether enable windows feature | `false` |
108+
| `windows.dsName` | name of driver daemonset on windows |`csi-smb-node-win` |
109+
| `windows.resources.livenessProbe.limits.cpu` | liveness-probe cpu limits | `1` |
110+
| `windows.resources.livenessProbe.limits.memory` | liveness-probe memory limits | `200Mi` |
111+
| `windows.resources.livenessProbe.requests.cpu` | liveness-probe cpu requests limits | `10m` |
112+
| `windows.resources.livenessProbe.requests.memory` | liveness-probe memory requests limits | `20Mi` |
113+
| `windows.resources.nodeDriverRegistrar.limits.cpu` | csi-node-driver-registrar cpu limits | `1` |
114+
| `windows.resources.nodeDriverRegistrar.limits.memory` | csi-node-driver-registrar memory limits | `200Mi` |
115+
| `windows.resources.nodeDriverRegistrar.requests.cpu` | csi-node-driver-registrar cpu requests limits | `10m` |
116+
| `windows.resources.nodeDriverRegistrar.requests.memory` | csi-node-driver-registrar memory requests limits | `20Mi` |
117+
| `windows.resources.smb.limits.cpu` | smb-csi-driver cpu limits | `1` |
118+
| `windows.resources.smb.limits.memory` | smb-csi-driver memory limits | `400Mi` |
119+
| `windows.resources.smb.requests.cpu` | smb-csi-driver cpu requests limits | `10m` |
120+
| `windows.resources.smb.requests.memory` | smb-csi-driver memory requests limits | `20Mi` |
121+
| `windows.kubelet` | configure kubelet directory path on Windows agent node | `'C:\var\lib\kubelet'` |
117122

118123
## troubleshooting
119124
- Add `--wait -v=5 --debug` in `helm install` command to get detailed error

0 commit comments

Comments
 (0)