Skip to content

Commit

Permalink
add helm deployment documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Youka committed Feb 24, 2024
1 parent 2d7c173 commit 8f18286
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 3 deletions.
2 changes: 0 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,6 @@ _TODO_
kubectl apply -f tests/k8s_test_namespaces.yml
kubectl apply -f tests/k8s_test_resources.yml
```
* `helm template deploy/helm`
* `helm upgrade my-release ./deploy/helm --namespace=api-snap --create-namespace --install --atomic`

## References
_TODO_
25 changes: 24 additions & 1 deletion docs/deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,4 +41,27 @@ docker push youkadev/api-snap
Do this for all new tags (in our example we also had `youkadev/api-snap:0.1.0`).

## Helm
_TODO_
You need [helm](https://helm.sh/) to package & index the chart and a **webserver** for sharing.

First package the chart:
```sh
helm package deploy/helm --destination tmp
```
A file `api-snap-<VERSION>.tgz` should be created in temporary directory `tmp`.

Next transform the directory to a helm repository by creating an index:
```sh
helm repo index tmp
```

Move the directory content to a static files webserver (for example `https://charts.youka.dev`). Share the url as your helm chart repository for potential users.

Users can now add the repository to their registry:
```sh
helm repo add youkadev https://charts.youka.dev
```

With the repository in scope the chart is installable to a cluster:
```sh
helm upgrade my-api-snap api-snap --namespace=api-snap --create-namespace --install --atomic
```

0 comments on commit 8f18286

Please sign in to comment.