Skip to content

Commit

Permalink
doc(helm): replace references to the helm install CLI command with …
Browse files Browse the repository at this point in the history
…the new `helm-install` goal/task.

Signed-off-by: Rohan Kumar <[email protected]>
  • Loading branch information
rohanKanojia authored Jul 17, 2024
1 parent d8db3e6 commit b594cb1
Show file tree
Hide file tree
Showing 5 changed files with 8 additions and 17 deletions.
3 changes: 2 additions & 1 deletion jkube-kit/doc/src/main/asciidoc/inc/helm/_jkube_helm.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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 <<jkube:helm-install, {goal-prefix}:helm-install>> 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 <<jkubeHelmInstall, {task-prefix}HelmInstall>> 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.
Expand Down
Original file line number Diff line number Diff line change
@@ -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
----
Original file line number Diff line number Diff line change
@@ -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
----
2 changes: 1 addition & 1 deletion quickstarts/kit/helm/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions quickstarts/maven/spring-boot-helm/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit b594cb1

Please sign in to comment.