Skip to content

Commit

Permalink
fix chart readme. (#396)
Browse files Browse the repository at this point in the history
To work webhooks properly, adding a label to the namespace is required.
helm can not create a namespace with labels, create the namespace and
attach a label before helm install.
related issue: #395
  • Loading branch information
toshipp committed Nov 4, 2021
1 parent 65702ea commit 73653dd
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 8 deletions.
14 changes: 10 additions & 4 deletions charts/topolvm/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,18 +37,24 @@ Also, [lvmd](../../deploy/README.md#lvmd) is run in a DaemonSet by default.

> :memo: NOTE: This installation method requires cert-manger to be installed beforehand.
To install the chart with the release name `topolvm` using a dedicated namespace(recommended):
To work webhooks properly, add a label to the target namespace. We also recommend to use a dedicated namespace.

```sh
helm install --create-namespace --namespace=topolvm-system topolvm topolvm/topolvm
kubectl label namespace topolvm-system topolvm.cybozu.com/webhook=ignore
```

Install the chart with the release name `topolvm` into the namespace:

```sh
helm install --namespace=topolvm-system topolvm topolvm/topolvm
```

Specify parameters using `--set key=value[,key=value]` argument to `helm install`.

Alternatively a YAML file that specifies the values for the parameters can be provided like this:

```sh
helm upgrade --create-namespace --namespace=topolvm-system -f values.yaml -i topolvm topolvm/topolvm
helm upgrade --namespace=topolvm-system -f values.yaml -i topolvm topolvm/topolvm
```

### Install together with cert-manager
Expand All @@ -62,7 +68,7 @@ kubectl apply -f https://github.com/jetstack/cert-manager/releases/download/v1.3
Set the `cert-manager.enabled=true` parameter when installing topolvm chart:

```sh
helm install --create-namespace --namespace=topolvm-system topolvm topolvm/topolvm --set cert-manager.enabled=true
helm install --namespace=topolvm-system topolvm topolvm/topolvm --set cert-manager.enabled=true
```

## Configure kube-scheduler
Expand Down
14 changes: 10 additions & 4 deletions charts/topolvm/README.md.gotmpl
Original file line number Diff line number Diff line change
Expand Up @@ -37,18 +37,24 @@ Also, [lvmd](../../deploy/README.md#lvmd) is run in a DaemonSet by default.

> :memo: NOTE: This installation method requires cert-manger to be installed beforehand.

To install the chart with the release name `topolvm` using a dedicated namespace(recommended):
To work webhooks properly, add a label to the target namespace. We also recommend to use a dedicated namespace.

```sh
helm install --create-namespace --namespace=topolvm-system topolvm topolvm/topolvm
kubectl label namespace topolvm-system topolvm.cybozu.com/webhook=ignore
```

Install the chart with the release name `topolvm` into the namespace:

```sh
helm install --namespace=topolvm-system topolvm topolvm/topolvm
```

Specify parameters using `--set key=value[,key=value]` argument to `helm install`.

Alternatively a YAML file that specifies the values for the parameters can be provided like this:

```sh
helm upgrade --create-namespace --namespace=topolvm-system -f values.yaml -i topolvm topolvm/topolvm
helm upgrade --namespace=topolvm-system -f values.yaml -i topolvm topolvm/topolvm
```

### Install together with cert-manager
Expand All @@ -62,7 +68,7 @@ kubectl apply -f https://github.com/jetstack/cert-manager/releases/download/v1.3
Set the `cert-manager.enabled=true` parameter when installing topolvm chart:

```sh
helm install --create-namespace --namespace=topolvm-system topolvm topolvm/topolvm --set cert-manager.enabled=true
helm install --namespace=topolvm-system topolvm topolvm/topolvm --set cert-manager.enabled=true
```

## Configure kube-scheduler
Expand Down

0 comments on commit 73653dd

Please sign in to comment.