From b594cb13775dd64d13cbda48314c80f99082ef0f Mon Sep 17 00:00:00 2001 From: Rohan Kumar Date: Wed, 17 Jul 2024 16:08:36 +0530 Subject: [PATCH] doc(helm): replace references to the `helm install` CLI command with the new `helm-install` goal/task. Signed-off-by: Rohan Kumar --- jkube-kit/doc/src/main/asciidoc/inc/helm/_jkube_helm.adoc | 3 ++- .../src/main/asciidoc/inc/helm/gradle/_helm_install.adoc | 8 +------- .../src/main/asciidoc/inc/helm/maven/_helm_install.adoc | 6 +----- quickstarts/kit/helm/README.md | 2 +- quickstarts/maven/spring-boot-helm/README.md | 6 +++--- 5 files changed, 8 insertions(+), 17 deletions(-) diff --git a/jkube-kit/doc/src/main/asciidoc/inc/helm/_jkube_helm.adoc b/jkube-kit/doc/src/main/asciidoc/inc/helm/_jkube_helm.adoc index 0a2e3858f7..11afb1d36b 100644 --- a/jkube-kit/doc/src/main/asciidoc/inc/helm/_jkube_helm.adoc +++ b/jkube-kit/doc/src/main/asciidoc/inc/helm/_jkube_helm.adoc @@ -279,14 +279,15 @@ ifeval::["{plugin-type}" == "gradle"] ==== Installing the generated Helm chart endif::[] -In a next step you can install this via the https://github.com/helm/helm/releases[helm command line tool] as follows: ifeval::["{plugin-type}" == "maven"] +In a next step you can install this via <> goal as follows: include::maven/_helm_install.adoc[] In addition, this goal will also create a tar-archive below `${basedir}/target` which contains the chart with its template. endif::[] ifeval::["{plugin-type}" == "gradle"] +In a next step you can install this via <> task as follows: include::gradle/_helm_install.adoc[] In addition, this task will also create a tar-archive below `outputDir` which contains the chart with its template. diff --git a/jkube-kit/doc/src/main/asciidoc/inc/helm/gradle/_helm_install.adoc b/jkube-kit/doc/src/main/asciidoc/inc/helm/gradle/_helm_install.adoc index 5ab4c75a4d..2b8d605249 100644 --- a/jkube-kit/doc/src/main/asciidoc/inc/helm/gradle/_helm_install.adoc +++ b/jkube-kit/doc/src/main/asciidoc/inc/helm/gradle/_helm_install.adoc @@ -1,10 +1,4 @@ [source, sh, subs="+attributes"] ---- -helm install nameForChartInRepository build/jkube/helm/${chartName}/{cluster} ----- -or - -[source, sh, subs="+attributes"] ----- -helm install build/jkube/helm/${chartName}/{cluster} --generate-name +./gradlew {task-prefix}HelmInstall ---- \ No newline at end of file diff --git a/jkube-kit/doc/src/main/asciidoc/inc/helm/maven/_helm_install.adoc b/jkube-kit/doc/src/main/asciidoc/inc/helm/maven/_helm_install.adoc index 774251e4e1..cab5411613 100644 --- a/jkube-kit/doc/src/main/asciidoc/inc/helm/maven/_helm_install.adoc +++ b/jkube-kit/doc/src/main/asciidoc/inc/helm/maven/_helm_install.adoc @@ -1,8 +1,4 @@ [source, sh, subs="+attributes"] ---- -helm install nameForChartInRepository target/jkube/helm/${chartName}/kubernetes ----- -or ----- -helm install target/jkube/helm/${chartName}/kubernetes --generate-name +mvn {goal-prefix}:helm-install ---- \ No newline at end of file diff --git a/quickstarts/kit/helm/README.md b/quickstarts/kit/helm/README.md index 71c275b5f3..a66e0c030e 100644 --- a/quickstarts/kit/helm/README.md +++ b/quickstarts/kit/helm/README.md @@ -20,7 +20,7 @@ Run the `mvn package` from your terminal. Once the process completes, a success informative message is printed. -You can now install the generated chart using the `helm install jkube-example ./target/helm/kubernetes` command. +You can install the generated chart by invoking `getHelmService().install(helmConfig)` programmatically or using the `helm install jkube-example ./target/helm/kubernetes` command. ```shell script diff --git a/quickstarts/maven/spring-boot-helm/README.md b/quickstarts/maven/spring-boot-helm/README.md index 030ba97ea3..89d1f8d1c0 100644 --- a/quickstarts/maven/spring-boot-helm/README.md +++ b/quickstarts/maven/spring-boot-helm/README.md @@ -93,13 +93,13 @@ mvn -Pprod clean package k8s:build k8s:resource k8s:helm The resulting Helm chart will be located in the `target/jkube/helm/spring-boot-helm` directory. -If you're testing this in Minikube, you can deploy the Helm chart using the following command: +If you're testing this in Minikube, you can deploy the Helm chart using the `k8s:helm-install` goal or `helm CLI`: ```shell -helm install spring-boot-helm target/jkube/helm/spring-boot-helm/kubernetes/ +mvn k8s:helm-install ``` -You can also override some of the values defined in the `values.yaml` file using the `--set` flag: +With `helm` CLI, You can also override some of the values defined in the `values.yaml` file using the `--set` flag: ```shell helm install spring-boot-helm target/jkube/helm/spring-boot-helm/kubernetes/ --set deployment.replicas=5 --set service.spec.type=NodePort