Skip to content

Commit 46cbae5

Browse files
authored
Update readme with new install steps (#19)
* Update readme with new install steps * Update README.md
1 parent f72af90 commit 46cbae5

File tree

1 file changed

+26
-8
lines changed

1 file changed

+26
-8
lines changed

README.md

Lines changed: 26 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@
33
[Verdaccio](https://www.verdaccio.org) is a lightweight private
44
[NPM](https://www.npmjs.com) proxy registry.
55

6-
> ⚠️ This repo is in construction [more info here](https://github.com/verdaccio/verdaccio/issues/1767).
7-
86
## TL;DR;
97

108
```
@@ -13,6 +11,8 @@ $ helm repo update
1311
$ helm install verdaccio/verdaccio
1412
```
1513

14+
> ⚠️ If you are using **stable/verdaccio** chart, [be aware is deprecated](https://github.com/helm/charts/pull/21929), forward all new PR and or issues to this repository.
15+
1616
## Introduction
1717

1818
This chart bootstraps a [Verdaccio](https://github.com/verdaccio/verdaccio)
@@ -26,10 +26,28 @@ deployment on a [Kubernetes](https://kubernetes.io) cluster using the
2626

2727
## Installing the Chart
2828

29-
To install the chart with the release name `my-release`:
29+
### Add repository
3030

3131
```
32-
$ helm install --name my-release verdaccio/verdaccio
32+
helm repo add verdaccio https://charts.verdaccio.org
33+
```
34+
35+
In this example we use `npm` as release name:
36+
37+
```bash
38+
helm install --name npm verdaccio/verdaccio
39+
```
40+
41+
### Deploy a specific version
42+
43+
```bash
44+
helm install --name npm --set image.tag=3.13.1 verdaccio/verdaccio
45+
```
46+
47+
### Upgrading Verdaccio
48+
49+
```bash
50+
helm upgrade npm verdaccio/verdaccio
3351
```
3452

3553
The command deploys Verdaccio on the Kubernetes cluster in the default
@@ -40,10 +58,10 @@ that can be configured during installation.
4058
4159
## Uninstalling the Chart
4260

43-
To uninstall/delete the `my-release` deployment:
61+
To uninstall/delete the `npm` deployment:
4462

4563
```
46-
$ helm delete my-release
64+
$ helm delete npm
4765
```
4866

4967
The command removes all the Kubernetes components associated with the chart and
@@ -99,7 +117,7 @@ Alternatively, a YAML file that specifies the values for the above parameters
99117
can be provided while installing the chart. For example,
100118

101119
```
102-
$ helm install --name my-release -f values.yaml verdaccio/verdaccio
120+
$ helm install --name npm -f values.yaml verdaccio/verdaccio
103121
```
104122

105123
> **Tip**: You can use the default [values.yaml](values.yaml)
@@ -130,7 +148,7 @@ It is possible to mount several volumes using `Persistence.volumes` and
130148
1. Install the chart
131149

132150
```bash
133-
$ helm install --name my-release \
151+
$ helm install --name npm \
134152
--set persistence.existingClaim=PVC_NAME \
135153
verdaccio/verdaccio
136154
```

0 commit comments

Comments
 (0)