Skip to content

Commit 9e9854f

Browse files
andyzhangxandyzhangx
authored
Merge pull request #472 from andyzhangx/update-chart-doc
doc: update chart doc
2 parents 6bc0d4b + 7374b85 commit 9e9854f

File tree

2 files changed

+34
-28
lines changed

2 files changed

+34
-28
lines changed

‎charts/README.md

Lines changed: 34 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ From `v0.7.0`, driver name changed from `blobfuse.csi.azure.com` to `blob.csi.az
77
- [install Helm](https://helm.sh/docs/intro/quickstart/#install-helm)
88

99
### Tips
10-
- `--set controller.runOnMaster=true` could make csi-azuredisk-controller only run on master node
11-
- `--set feature.enableFSGroupPolicy=true` could enable `fsGroupPolicy` on a k8s 1.20+ cluster
12-
- `--set controller.replicas=1` could set replica of csi-azuredisk-controller as `1`
10+
- make controller only run on master node: `--set controller.runOnMaster=true`
11+
- enable `fsGroupPolicy` on a k8s 1.20+ cluster: `--set feature.enableFSGroupPolicy=true`
12+
- set replica of controller as `1`: `--set controller.replicas=1`
1313

1414
## install latest version
1515
```console
@@ -33,6 +33,13 @@ helm install blob-csi-driver blob-csi-driver/blob-csi-driver --namespace kube-sy
3333
helm install blob-csi-driver blob-csi-driver/blob-csi-driver --namespace kube-system --set linux.distro=fedora
3434
```
3535

36+
### install driver with customized driver name, deployment name
37+
> only supported from `v1.4.0`+
38+
- following example would install a driver with name `blob2`
39+
```console
40+
helm install blob2-csi-driver blob-csi-driver/blob-csi-driver --namespace kube-system --set driver.name="blob2.csi.azure.com" --set controller.name="csi-blob2-controller" --set rbac.name=blob2 --set serviceAccount.controller=csi-blob2-controller-sa --set serviceAccount.node=csi-blob2-node-sa --set node.name=csi-blob2-node --set node.livenessProbe.healthPort=29633
41+
```
42+
3643
### search for all available chart versions
3744
```console
3845
helm search repo -l blob-csi-driver
@@ -51,31 +58,31 @@ The following table lists the configurable parameters of the latest Azure Blob S
5158
| ----------------------------------------------------- | ----------------------------------------------------- | -------------------------------------------------------------- |
5259
| `driver.name` | alternative driver name | `blob.csi.azure.com` |
5360
| `feature.enableFSGroupPolicy` | enable `fsGroupPolicy` on a k8s 1.20+ cluster | `false` |
54-
| `image.blob.repository` | blob-csi-driver docker image | mcr.microsoft.com/k8s/csi/blob-csi |
55-
| `image.blob.tag` | blob-csi-driver docker image tag | latest |
56-
| `image.blob.pullPolicy` | blob-csi-driver image pull policy | IfNotPresent |
57-
| `image.csiProvisioner.repository` | csi-provisioner docker image | mcr.microsoft.com/oss/kubernetes-csi/csi-provisioner |
58-
| `image.csiProvisioner.tag` | csi-provisioner docker image tag | v2.1.0 |
59-
| `image.csiProvisioner.pullPolicy` | csi-provisioner image pull policy | IfNotPresent |
60-
| `image.livenessProbe.repository` | liveness-probe docker image | mcr.microsoft.com/oss/kubernetes-csi/livenessprobe |
61-
| `image.livenessProbe.tag` | liveness-probe docker image tag | v2.3.0 |
62-
| `image.livenessProbe.pullPolicy` | liveness-probe image pull policy | IfNotPresent |
63-
| `image.nodeDriverRegistrar.repository` | csi-node-driver-registrar docker image | mcr.microsoft.com/oss/kubernetes-csi/csi-node-driver-registrar |
64-
| `image.nodeDriverRegistrar.tag` | csi-node-driver-registrar docker image tag | v2.2.0 |
65-
| `image.nodeDriverRegistrar.pullPolicy` | csi-node-driver-registrar image pull policy | IfNotPresent |
66-
| `image.csiResizer.repository` | csi-resizer docker image | mcr.microsoft.com/oss/kubernetes-csi/csi-resizer |
67-
| `image.csiResizer.tag` | csi-resizer docker image tag | v1.1.0 |
68-
| `image.csiResizer.pullPolicy` | csi-resizer image pull policy | IfNotPresent |
61+
| `image.blob.repository` | blob-csi-driver docker image | `mcr.microsoft.com/k8s/csi/blob-csi` |
62+
| `image.blob.tag` | blob-csi-driver docker image tag | `latest` |
63+
| `image.blob.pullPolicy` | blob-csi-driver image pull policy | `IfNotPresent` |
64+
| `image.csiProvisioner.repository` | csi-provisioner docker image | `mcr.microsoft.com/oss/kubernetes-csi/csi-provisioner` |
65+
| `image.csiProvisioner.tag` | csi-provisioner docker image tag | `v2.1.0` |
66+
| `image.csiProvisioner.pullPolicy` | csi-provisioner image pull policy | `IfNotPresent` |
67+
| `image.livenessProbe.repository` | liveness-probe docker image | `mcr.microsoft.com/oss/kubernetes-csi/livenessprobe` |
68+
| `image.livenessProbe.tag` | liveness-probe docker image tag | `v2.3.0` |
69+
| `image.livenessProbe.pullPolicy` | liveness-probe image pull policy | `IfNotPresent` |
70+
| `image.nodeDriverRegistrar.repository` | csi-node-driver-registrar docker image | `mcr.microsoft.com/oss/kubernetes-csi/csi-node-driver-registrar` |
71+
| `image.nodeDriverRegistrar.tag` | csi-node-driver-registrar docker image tag | `v2.2.0` |
72+
| `image.nodeDriverRegistrar.pullPolicy` | csi-node-driver-registrar image pull policy | `IfNotPresent` |
73+
| `image.csiResizer.repository` | csi-resizer docker image | `mcr.microsoft.com/oss/kubernetes-csi/csi-resizer` |
74+
| `image.csiResizer.tag` | csi-resizer docker image tag | `v1.1.0` |
75+
| `image.csiResizer.pullPolicy` | csi-resizer image pull policy | `IfNotPresent` |
6976
| `imagePullSecrets` | Specify docker-registry secret names as an array | [] (does not add image pull secrets to deployed pods) |
70-
| `serviceAccount.create` | whether create service account of csi-blob-controller | true |
71-
| `serviceAccount.controller` | name of service account for csi-blob-controller | csi-blob-controller-sa |
72-
| `serviceAccount.node` | name of service account for csi-blob-node | csi-blob-node-sa |
73-
| `rbac.create` | whether create rbac of csi-blob-controller | true |
77+
| `serviceAccount.create` | whether create service account of csi-blob-controller | `true` |
78+
| `serviceAccount.controller` | name of service account for csi-blob-controller | `csi-blob-controller-sa` |
79+
| `serviceAccount.node` | name of service account for csi-blob-node | `csi-blob-node-sa` |
80+
| `rbac.create` | whether create rbac of csi-blob-controller | `true` |
7481
| `controller.name` | name of driver deployment | `csi-blob-controller`
75-
| `controller.replicas` | the replicas of csi-blob-controller | 2 |
82+
| `controller.replicas` | the replicas of csi-blob-controller | `2` |
7683
| `controller.metricsPort` | metrics port of csi-blob-controller | `29634` |
7784
| `controller.livenessProbe.healthPort ` | health check port for liveness probe | `29632` |
78-
| `controller.runOnMaster` | run controller on master node | false |
85+
| `controller.runOnMaster` | run controller on master node | `true` |
7986
| `controller.logLevel` | controller driver log level | `5` |
8087
| `controller.resources.csiProvisioner.limits.cpu` | csi-provisioner cpu limits | 100m |
8188
| `controller.resources.csiProvisioner.limits.memory` | csi-provisioner memory limits | 100Mi |
@@ -100,7 +107,7 @@ The following table lists the configurable parameters of the latest Azure Blob S
100107
| `node.metricsPort` | metrics port of csi-blob-node | `29635` |
101108
| `node.livenessProbe.healthPort ` | health check port for liveness probe | `29633` |
102109
| `node.logLevel` | node driver log level | `5` |
103-
| `node.enableBlobfuseProxy` | node enable blobfuse-proxy | false |
110+
| `node.enableBlobfuseProxy` | node enable blobfuse-proxy | `false` |
104111
| `node.blobfuseCachePath` | blobfuse cache path(`tmp-path`) | `/mnt` |
105112
| `node.resources.livenessProbe.limits.cpu` | liveness-probe cpu limits | 100m |
106113
| `node.resources.livenessProbe.limits.memory` | liveness-probe memory limits | 100Mi |
@@ -119,12 +126,11 @@ The following table lists the configurable parameters of the latest Azure Blob S
119126
| `node.tolerations` | node pod tolerations | [] |
120127
| `linux.kubelet` | configure kubelet directory path on Linux agent node node | `/var/lib/kubelet` |
121128
| `linux.distro` | configure ssl certificates for different Linux distribution(available values: `debian`, `fedora`) | `debian`
122-
| `cloud` | the cloud environment the driver is running on | AzurePublicCloud |
129+
| `cloud` | the cloud environment the driver is running on | `AzurePublicCloud` |
123130
| `podAnnotations` | collection of annotations to add to all the pods | {} |
124131
| `podLabels` | collection of labels to add to all the pods | {} |
125-
| `priorityClassName` | priority class name to be added to pods | system-cluster-critical |
132+
| `priorityClassName` | priority class name to be added to pods | `system-cluster-critical` |
126133
| `securityContext` | security context to be added to pods | {} |
127-
| `node.livenessProbe.healthPort ` | the health check port for liveness probe | `29633` |
128134

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

‎charts/latest/blob-csi-driver-v1.4.0.tgz

-1 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)