From 8f18286f3f1fdd847e0d9ec292d9dcacbeb34804 Mon Sep 17 00:00:00 2001 From: Youka Date: Fri, 23 Feb 2024 23:54:50 +0100 Subject: [PATCH] add helm deployment documentation --- README.md | 2 -- docs/deployment.md | 25 ++++++++++++++++++++++++- 2 files changed, 24 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 65df2f5..87aa5cf 100644 --- a/README.md +++ b/README.md @@ -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_ diff --git a/docs/deployment.md b/docs/deployment.md index 0f88b63..ab1c04a 100644 --- a/docs/deployment.md +++ b/docs/deployment.md @@ -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-.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 +```