From d54a67c90c3d7fdf51e3f64d20603456d8a13ac4 Mon Sep 17 00:00:00 2001 From: Zaza Date: Sun, 9 Feb 2025 23:25:27 +0000 Subject: [PATCH 1/4] Update README.md Minor changes to helm deployment instructions --- charts/kamaji/README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/charts/kamaji/README.md b/charts/kamaji/README.md index 76221358..b67aa20d 100644 --- a/charts/kamaji/README.md +++ b/charts/kamaji/README.md @@ -30,10 +30,13 @@ This Helm Chart starting from v0.1.1 provides the installation of an internal `e > For production use an externally managed `etcd` is highly recommended, the `etcd` addon offered by this Chart is not considered production-grade. ## Install Kamaji +To add the Clastix helm repository: + + helm repo add clastix https://clastix.github.io/charts To install the Chart with the release name `kamaji`: - helm upgrade --install --namespace kamaji-system --create-namespace clastix/kamaji + helm upgrade --install --namespace kamaji-system --create-namespace kamaji clastix/kamaji Show the status: From 107013a26db5b0bd2fa990c7d0d2027735f7840f Mon Sep 17 00:00:00 2001 From: Zaza Date: Wed, 12 Feb 2025 11:30:58 +0000 Subject: [PATCH 2/4] further changes to improve helm deployment instructions --- charts/kamaji/README.md | 29 +++++++++++++++++++++-------- 1 file changed, 21 insertions(+), 8 deletions(-) diff --git a/charts/kamaji/README.md b/charts/kamaji/README.md index b67aa20d..dd5a6a01 100644 --- a/charts/kamaji/README.md +++ b/charts/kamaji/README.md @@ -32,23 +32,32 @@ This Helm Chart starting from v0.1.1 provides the installation of an internal `e ## Install Kamaji To add the Clastix helm repository: - helm repo add clastix https://clastix.github.io/charts +```bash +helm repo add clastix https://clastix.github.io/charts +``` To install the Chart with the release name `kamaji`: - helm upgrade --install --namespace kamaji-system --create-namespace kamaji clastix/kamaji +```bash +helm upgrade --install --namespace kamaji-system --create-namespace kamaji clastix/kamaji +``` Show the status: - - helm status kamaji -n kamaji-system +```bash +helm status kamaji -n kamaji-system +``` Upgrade the Chart - helm upgrade kamaji -n kamaji-system clastix/kamaji +```bash +helm upgrade kamaji -n kamaji-system clastix/kamaji +``` Uninstall the Chart - helm uninstall kamaji -n kamaji-system +```bash +helm uninstall kamaji -n kamaji-system +``` ## Customize the installation @@ -58,13 +67,17 @@ The `--values` option is the preferred method because it allows you to keep your Specify your overrides file when you install the Chart: - helm upgrade kamaji --install --namespace kamaji-system --create-namespace clastix/kamaji --values myvalues.yaml +```bash +helm upgrade kamaji --install --namespace kamaji-system --create-namespace clastix/kamaji --values myvalues.yaml +``` The values in your overrides file `myvalues.yaml` will override their counterparts in the Chart's values.yaml file. Any values in `values.yaml` that weren’t overridden will keep their defaults. If you only need to make minor customizations, you can specify them on the command line by using the `--set` option. For example: - helm upgrade kamaji --install --namespace kamaji-system --create-namespace clastix/kamaji --set etcd.deploy=false +```bash +helm upgrade kamaji --install --namespace kamaji-system --create-namespace clastix/kamaji --set etcd.deploy=false +``` Here the values you can override: From 28d5b4b5c6a3c4376eb7fa6e35979269b39dfe98 Mon Sep 17 00:00:00 2001 From: Zaza Date: Wed, 12 Feb 2025 12:11:10 +0000 Subject: [PATCH 3/4] ran make -C charts/kamaji docs --- charts/kamaji/README.md | 30 +++++++----------------------- 1 file changed, 7 insertions(+), 23 deletions(-) diff --git a/charts/kamaji/README.md b/charts/kamaji/README.md index dd5a6a01..76221358 100644 --- a/charts/kamaji/README.md +++ b/charts/kamaji/README.md @@ -30,34 +30,22 @@ This Helm Chart starting from v0.1.1 provides the installation of an internal `e > For production use an externally managed `etcd` is highly recommended, the `etcd` addon offered by this Chart is not considered production-grade. ## Install Kamaji -To add the Clastix helm repository: - -```bash -helm repo add clastix https://clastix.github.io/charts -``` To install the Chart with the release name `kamaji`: -```bash -helm upgrade --install --namespace kamaji-system --create-namespace kamaji clastix/kamaji -``` + helm upgrade --install --namespace kamaji-system --create-namespace clastix/kamaji Show the status: -```bash -helm status kamaji -n kamaji-system -``` + + helm status kamaji -n kamaji-system Upgrade the Chart -```bash -helm upgrade kamaji -n kamaji-system clastix/kamaji -``` + helm upgrade kamaji -n kamaji-system clastix/kamaji Uninstall the Chart -```bash -helm uninstall kamaji -n kamaji-system -``` + helm uninstall kamaji -n kamaji-system ## Customize the installation @@ -67,17 +55,13 @@ The `--values` option is the preferred method because it allows you to keep your Specify your overrides file when you install the Chart: -```bash -helm upgrade kamaji --install --namespace kamaji-system --create-namespace clastix/kamaji --values myvalues.yaml -``` + helm upgrade kamaji --install --namespace kamaji-system --create-namespace clastix/kamaji --values myvalues.yaml The values in your overrides file `myvalues.yaml` will override their counterparts in the Chart's values.yaml file. Any values in `values.yaml` that weren’t overridden will keep their defaults. If you only need to make minor customizations, you can specify them on the command line by using the `--set` option. For example: -```bash -helm upgrade kamaji --install --namespace kamaji-system --create-namespace clastix/kamaji --set etcd.deploy=false -``` + helm upgrade kamaji --install --namespace kamaji-system --create-namespace clastix/kamaji --set etcd.deploy=false Here the values you can override: From 717db758eeb4c020ef428f7e4dc0db167e9d2293 Mon Sep 17 00:00:00 2001 From: Zaza Date: Thu, 13 Feb 2025 18:19:34 +0000 Subject: [PATCH 4/4] fixed helm deployment instructions --- charts/kamaji/README.md | 6 +++++- charts/kamaji/README.md.gotmpl | 7 ++++++- 2 files changed, 11 insertions(+), 2 deletions(-) diff --git a/charts/kamaji/README.md b/charts/kamaji/README.md index 76221358..c7056b3f 100644 --- a/charts/kamaji/README.md +++ b/charts/kamaji/README.md @@ -31,9 +31,13 @@ This Helm Chart starting from v0.1.1 provides the installation of an internal `e ## Install Kamaji +To add clastix helm repository: + + helm repo add clastix https://clastix.github.io/charts + To install the Chart with the release name `kamaji`: - helm upgrade --install --namespace kamaji-system --create-namespace clastix/kamaji + helm upgrade --install --namespace kamaji-system --create-namespace kamaji clastix/kamaji Show the status: diff --git a/charts/kamaji/README.md.gotmpl b/charts/kamaji/README.md.gotmpl index 709b0eb3..bf43777f 100644 --- a/charts/kamaji/README.md.gotmpl +++ b/charts/kamaji/README.md.gotmpl @@ -18,10 +18,15 @@ This Helm Chart starting from v0.1.1 provides the installation of an internal `e ## Install Kamaji +To add clastix helm repository: + + + helm repo add clastix https://clastix.github.io/charts + To install the Chart with the release name `kamaji`: - helm upgrade --install --namespace kamaji-system --create-namespace clastix/kamaji + helm upgrade --install --namespace kamaji-system --create-namespace kamaji clastix/kamaji Show the status: