Skip to content

Commit 9cf4684

Browse files
authored
Remove name flag from helm install command for helm v3 (#35)
* docs: remove name flag from `helm install` command for helm v3 * docs: redo #34 * docs: make install command for helm v3 more clear * docs: list `helm install` in both helm v3+ and v2
1 parent 14a9a19 commit 9cf4684

File tree

1 file changed

+28
-2
lines changed

1 file changed

+28
-2
lines changed

README.md

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,15 +32,25 @@ deployment on a [Kubernetes](https://kubernetes.io) cluster using the
3232
helm repo add verdaccio https://charts.verdaccio.org
3333
```
3434

35+
### Install Verdaccio chart
36+
3537
In this example we use `npm` as release name:
3638

3739
```bash
40+
# Helm v3+
41+
helm install npm verdaccio/verdaccio
42+
43+
# Helm v2 or older
3844
helm install --name npm verdaccio/verdaccio
3945
```
4046

4147
### Deploy a specific version
4248

4349
```bash
50+
# Helm v3+
51+
helm install npm --set image.tag=4.6.2 verdaccio/verdaccio
52+
53+
# Helm v2 or older
4454
helm install --name npm --set image.tag=4.6.2 verdaccio/verdaccio
4555
```
4656

@@ -107,7 +117,13 @@ and their default values.
107117

108118
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example,
109119

110-
```
120+
```bash
121+
# Helm v3+
122+
$ helm install my-release \
123+
--set service.type=LoadBalancer \
124+
verdaccio/verdaccio
125+
126+
# Helm v2 or older
111127
$ helm install --name my-release \
112128
--set service.type=LoadBalancer \
113129
verdaccio/verdaccio
@@ -118,7 +134,11 @@ The above command sets the service type LoadBalancer.
118134
Alternatively, a YAML file that specifies the values for the above parameters
119135
can be provided while installing the chart. For example,
120136

121-
```
137+
```bash
138+
# Helm v3+
139+
$ helm install npm -f values.yaml verdaccio/verdaccio
140+
141+
# Helm v2 or older
122142
$ helm install --name npm -f values.yaml verdaccio/verdaccio
123143
```
124144

@@ -150,6 +170,12 @@ It is possible to mount several volumes using `Persistence.volumes` and
150170
1. Install the chart
151171

152172
```bash
173+
# Helm v3+
174+
$ helm install npm \
175+
--set persistence.existingClaim=PVC_NAME \
176+
verdaccio/verdaccio
177+
178+
# Helm v2 or older
153179
$ helm install --name npm \
154180
--set persistence.existingClaim=PVC_NAME \
155181
verdaccio/verdaccio

0 commit comments

Comments
 (0)