93 lines
11 KiB
Markdown
93 lines
11 KiB
Markdown
# Install CSI driver with Helm 3
|
|
|
|
## Prerequisites
|
|
- [install Helm](https://helm.sh/docs/intro/quickstart/#install-helm)
|
|
|
|
### Tips
|
|
- make controller only run on master node: `--set controller.runOnMaster=true`
|
|
- set replica of controller as `1`: `--set controller.replicas=1`
|
|
- enable `fsGroupPolicy` on a k8s 1.20+ cluster (this feature is in beta, check details [here](../deploy/example/fsgroup)): `--set feature.enableFSGroupPolicy=true`
|
|
|
|
### install a specific version
|
|
```console
|
|
helm repo add csi-driver-nfs https://raw.githubusercontent.com/kubernetes-csi/csi-driver-nfs/master/charts
|
|
helm install csi-driver-nfs csi-driver-nfs/csi-driver-nfs --namespace kube-system --version v3.0.0
|
|
```
|
|
|
|
### install driver with customized driver name, deployment name
|
|
> only supported from `v3.0.0`+
|
|
- following example would install a driver with name `nfs2`
|
|
```console
|
|
helm install csi-driver-nfs2 csi-driver-nfs/csi-driver-nfs --namespace kube-system --set driver.name="nfs2.csi.k8s.io" --set controller.name="csi-nfs2-controller" --set rbac.name=nfs2 --set serviceAccount.controller=csi-nfs2-controller-sa --set serviceAccount.node=csi-nfs2-node-sa --set node.name=csi-nfs2-node --set node.livenessProbe.healthPort=39653
|
|
```
|
|
|
|
### search for all available chart versions
|
|
```console
|
|
helm search repo -l csi-driver-nfs
|
|
```
|
|
|
|
## uninstall CSI driver
|
|
```console
|
|
helm uninstall csi-driver-nfs -n kube-system
|
|
```
|
|
|
|
## latest chart configuration
|
|
|
|
The following table lists the configurable parameters of the latest NFS CSI Driver chart and default values.
|
|
|
|
| Parameter | Description | Default |
|
|
|---------------------------------------------------|------------------------------------------------------------|-------------------------------------------------------------------|
|
|
| `driver.name` | alternative driver name | `nfs.csi.k8s.io` |
|
|
| `feature.enableFSGroupPolicy` | enable `fsGroupPolicy` on a k8s 1.20+ cluster | `false` |
|
|
| `image.nfs.repository` | csi-driver-nfs docker image | `gcr.io/k8s-staging-sig-storage/nfsplugin` |
|
|
| `image.nfs.tag` | csi-driver-nfs docker image tag | `amd64-linux-canary` |
|
|
| `image.nfs.pullPolicy` | csi-driver-nfs image pull policy | `IfNotPresent` |
|
|
| `image.csiProvisioner.repository` | csi-provisioner docker image | `k8s.gcr.io/sig-storage/csi-provisioner` |
|
|
| `image.csiProvisioner.tag` | csi-provisioner docker image tag | `v2.0.4` |
|
|
| `image.csiProvisioner.pullPolicy` | csi-provisioner image pull policy | `IfNotPresent` |
|
|
| `image.livenessProbe.repository` | liveness-probe docker image | `k8s.gcr.io/sig-storage/livenessprobe` |
|
|
| `image.livenessProbe.tag` | liveness-probe docker image tag | `v2.5.0` |
|
|
| `image.livenessProbe.pullPolicy` | liveness-probe image pull policy | `IfNotPresent` |
|
|
| `image.nodeDriverRegistrar.repository` | csi-node-driver-registrar docker image | `k8s.gcr.io/sig-storage/csi-node-driver-registrar` |
|
|
| `image.nodeDriverRegistrar.tag` | csi-node-driver-registrar docker image tag | `v2.4.0` |
|
|
| `image.nodeDriverRegistrar.pullPolicy` | csi-node-driver-registrar image pull policy | `IfNotPresent` |
|
|
| `imagePullSecrets` | Specify docker-registry secret names as an array | [] (does not add image pull secrets to deployed pods) |
|
|
| `serviceAccount.create` | whether create service account of csi-nfs-controller | `true` |
|
|
| `rbac.create` | whether create rbac of csi-nfs-controller | `true` |
|
|
| `controller.replicas` | the replicas of csi-nfs-controller | `2` |
|
|
| `controller.runOnMaster` | run controller on master node | `false` |
|
|
| `controller.logLevel` | controller driver log level |`5` |
|
|
| `controller.tolerations` | controller pod tolerations | |
|
|
| `controller.resources.csiProvisioner.limits.cpu` | csi-provisioner cpu limits | 1 |
|
|
| `controller.resources.csiProvisioner.limits.memory` | csi-provisioner memory limits | 100Mi |
|
|
| `controller.resources.csiProvisioner.requests.cpu` | csi-provisioner cpu requests limits | 10m |
|
|
| `controller.resources.csiProvisioner.requests.memory` | csi-provisioner memory requests limits | 20Mi |
|
|
| `controller.resources.livenessProbe.limits.cpu` | liveness-probe cpu limits | 1 |
|
|
| `controller.resources.livenessProbe.limits.memory` | liveness-probe memory limits | 100Mi |
|
|
| `controller.resources.livenessProbe.requests.cpu` | liveness-probe cpu requests limits | 10m |
|
|
| `controller.resources.livenessProbe.requests.memory` | liveness-probe memory requests limits | 20Mi |
|
|
| `controller.resources.nfs.limits.cpu` | csi-driver-nfs cpu limits | 1 |
|
|
| `controller.resources.nfs.limits.memory` | csi-driver-nfs memory limits | 200Mi |
|
|
| `controller.resources.nfs.requests.cpu` | csi-driver-nfs cpu requests limits | 10m |
|
|
| `controller.resources.nfs.requests.memory` | csi-driver-nfs memory requests limits | 20Mi |
|
|
| `node.maxUnavailable` | `maxUnavailable` value of driver node daemonset | `1`
|
|
| `node.logLevel` | node driver log level |`5` |
|
|
| `node.livenessProbe.healthPort ` | the health check port for liveness probe |`29653` |
|
|
| `node.tolerations` | node pod tolerations | |
|
|
| `node.resources.livenessProbe.limits.cpu` | liveness-probe cpu limits | 1 |
|
|
| `node.resources.livenessProbe.limits.memory` | liveness-probe memory limits | 100Mi |
|
|
| `node.resources.livenessProbe.requests.cpu` | liveness-probe cpu requests limits | 10m |
|
|
| `node.resources.livenessProbe.requests.memory` | liveness-probe memory requests limits | 20Mi |
|
|
| `node.resources.nodeDriverRegistrar.limits.cpu` | csi-node-driver-registrar cpu limits | 1 |
|
|
| `node.resources.nodeDriverRegistrar.limits.memory` | csi-node-driver-registrar memory limits | 100Mi |
|
|
| `node.resources.nodeDriverRegistrar.requests.cpu` | csi-node-driver-registrar cpu requests limits | 10m |
|
|
| `node.resources.nodeDriverRegistrar.requests.memory` | csi-node-driver-registrar memory requests limits | 20Mi |
|
|
| `node.resources.nfs.limits.cpu` | csi-driver-nfs cpu limits | 1 |
|
|
| `node.resources.nfs.limits.memory` | csi-driver-nfs memory limits | 300Mi |
|
|
| `node.resources.nfs.requests.cpu` | csi-driver-nfs cpu requests limits | 10m |
|
|
| `node.resources.nfs.requests.memory` | csi-driver-nfs memory requests limits | 20Mi |
|
|
|
|
## troubleshooting
|
|
- Add `--wait -v=5 --debug` in `helm install` command to get detailed error
|
|
- Use `kubectl describe` to acquire more info
|