Skip to content

Commit 3d8d5a5

Browse files
k8s-ci-robotk8s-ci-robot
authored
Merge pull request #166 from Sakuralbj/helm-doc
Charts: refine helm installation
2 parents a8aaf2d + 07df02a commit 3d8d5a5

File tree

4 files changed

+83
-7
lines changed

4 files changed

+83
-7
lines changed

‎charts/README.md

Lines changed: 55 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,71 @@
1-
# Installation with Helm
1+
# Installation with Helm 3
22

33
Quick start instructions for the setup and configuration of blobfuse CSI driver using Helm.
44

55
## Prerequisites
66

7-
1. [install Helm Client](https://helm.sh/docs/using_helm/#installing-the-helm-client)
7+
1. [install Helm Client 3.0+ ](https://helm.sh/docs/intro/quickstart/#install-helm)
88

9-
2. [initialize Helm and install Tiller](https://helm.sh/docs/using_helm/#initialize-helm-and-install-tiller)
10-
11-
## Install BlobFuse via `helm install`
9+
## Install latest CSI Driver via `helm install`
1210

1311
```console
1412
$ cd $GOPATH/src/sigs.k8s.io/blobfuse-csi-driver/charts/latest
1513
$ helm package blobfuse-csi-driver
1614
$ helm install blobfuse-csi-driver blobfuse-csi-driver-latest.tgz --namespace kube-system
1715
```
16+
17+
## Install CSI Driver released version using Helm repository
18+
19+
```console
20+
$ helm repo add blobfuse-csi-driver https://raw.githubusercontent.com/kubernetes-sigs/blobfuse-csi-driver/master/charts
21+
$ helm install --name blobfuse-csi-driver blobfuse-csi-driver/blobfuse-csi-driver --namespace kube-system
22+
```
23+
24+
### Search for different versions of charts available
25+
```console
26+
$ helm search -l blobfuse-csi-driver/
27+
```
28+
### Install a specific version of Helm chart
29+
Specify the version of the chart to be installed using the `--version` parameter.
30+
```console
31+
helm install --name blobfuse-csi-driver blobfuse-csi-driver/blobfuse-csi-driver --namespace kube-system --version v0.5.0
32+
```
1833

1934
## Uninstall
2035

2136
```console
22-
$ helm delete --purge blobfuse-csi-driver
23-
```
37+
$ helm uninstall blobfuse-csi-driver -n kube-system
38+
```
39+
## The Latest Helm Chart Configuration
40+
41+
The following table lists the configurable parameters of the latest Blobfuse CSI Driver chart and their default values.
42+
43+
| Parameter | Description | Default |
44+
|---------------------------------------------------|------------------------------------------------------------|-------------------------------------------------------------------|
45+
| `image.blobfuse.repository` | blobfuse-csi-driver docker image | mcr.microsoft.com/k8s/csi/blobfuse-csi |
46+
| `image.blobfuse.tag` | blobfuse-csi-driver docker image tag | latest |
47+
| `image.blobfuse.pullPolicy` | blobfuse-csi-driver image pull policy | IfNotPresent |
48+
| `image.csiProvisioner.repository` | csi-provisioner docker image | mcr.microsoft.com/oss/kubernetes-csi/csi-provisioner |
49+
| `image.csiProvisioner.tag` | csi-provisioner docker image tag | v1.4.0 |
50+
| `image.csiProvisioner.pullPolicy` | csi-provisioner image pull policy | IfNotPresent |
51+
| `image.csiAttacher.repository` | csi-attacher docker image | mcr.microsoft.com/oss/kubernetes-csi/csi-attacher |
52+
| `image.csiAttacher.tag` | csi-attacher docker image tag | v2.2.0 |
53+
| `image.csiAttacher.pullPolicy` | csi-attacher image pull policy | IfNotPresent | |
54+
| `image.livenessProbe.repository` | liveness-probe docker image | mcr.microsoft.com/oss/kubernetes-csi/livenessprobe |
55+
| `image.livenessProbe.tag` | liveness-probe docker image tag | v1.1.0 |
56+
| `image.livenessProbe.pullPolicy` | liveness-probe image pull policy | IfNotPresent |
57+
| `image.nodeDriverRegistrar.repository` | csi-node-driver-registrar docker image | mcr.microsoft.com/oss/kubernetes-csi/csi-node-driver-registrar |
58+
| `image.nodeDriverRegistrar.tag` | csi-node-driver-registrar docker image tag | v1.2.0 |
59+
| `image.nodeDriverRegistrar.pullPolicy` | csi-node-driver-registrar image pull policy | IfNotPresent |
60+
| `serviceAccount.create` | whether create service account of csi-blobfuse-controller | true |
61+
| `rbac.create` | whether create rbac of csi-blobfuse-controller | true |
62+
| `controller.replicas` | the replicas of csi-blobfuse-controller | 2 |
63+
## Troubleshooting
64+
65+
If there are some errors when using helm to install, follow the steps to debug:
66+
67+
1. Add `--wait -v=5 --debug` in `helm install` command.
68+
2. Then the error pods can be located.
69+
3. Use `kubectl describe ` to acquire more info.
70+
4. Check the related resource of the pod, such as serviceaacount, rbac, etc.
71+

‎charts/index.yaml

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
apiVersion: v1
2+
entries:
3+
blobfuse-csi-driver:
4+
- apiVersion: v1
5+
appVersion: v0.5.0
6+
created: "2020-06-11T14:00:53.498198+08:00"
7+
description: BlobFuse Container Storage Interface (CSI) Storage Plugin
8+
digest: 4b2a8c9900f1ab5e5c30ee8195543fd65b6d25d53e5acf93519b46a416197baf
9+
maintainers:
10+
- email: [email protected]
11+
name: andyzhangx
12+
name: blobfuse-csi-driver
13+
urls:
14+
- https://raw.githubusercontent.com/kubernetes-sigs/blobfuse-csi-driver/master/charts/v0.5.0/blobfuse-csi-driver-v0.5.0.tgz
15+
version: v0.5.0
16+
- apiVersion: v1
17+
appVersion: v0.4.0
18+
created: "2020-06-11T14:00:53.497736+08:00"
19+
description: BlobFuse Container Storage Interface (CSI) Storage Plugin
20+
digest: f29d8d474b8a52f569081ae0d1e32c68c35cc684c0f3cbfa9541d160ae17352f
21+
maintainers:
22+
- email: [email protected]
23+
name: andyzhangx
24+
name: blobfuse-csi-driver
25+
urls:
26+
- https://raw.githubusercontent.com/kubernetes-sigs/blobfuse-csi-driver/master/charts/v0.4.0/blobfuse-csi-driver-v0.4.0.tgz
27+
version: v0.4.0
28+
generated: "2020-06-11T14:00:53.495846+08:00"

‎charts/v0.4.0/blobfuse-csi-driver-v0.4.0.tgz

3.35 KB
Binary file not shown.

‎charts/v0.5.0/blobfuse-csi-driver-v0.5.0.tgz

3.35 KB
Binary file not shown.

0 commit comments

Comments
 (0)