doc : documentation for Helm Install feature

Signed-off-by: Rohan Kumar <[email protected]>

CHANGELOG.md

@@ -39,6 +39,8 @@ Usage:
 * Fix #2110: Add new helm dependency update goal task (`k8s:helm-dependency-update` for maven and `k8sHelmDependencyUpdate` for gradle)
 * Fix #3122: JKube should also pass project directory in `buildpacks` build strategy
 * Fix #2467: Add support for specifying imagePullSecrets via resource configuration
+* Fix #2663: Add new helm install goal task (`k8s:helm-install` for maven and `k8sHelmInstall` for gradle)
+
 ### 1.16.2 (2024-03-27)
 * Fix #2461: `k8s:watch`/`k8sWatch` should throw error in `buildpacks` build strategy
 * Fix #2852: Bump version.kubernetes-client from 6.10.0 to 6.11.0

gradle-plugin/doc/src/main/asciidoc/inc/tasks/build/_index.adoc

@@ -16,3 +16,5 @@ include::{kitdoc-path}/inc/helm/_jkube_helm_push.adoc[]
 include::{kitdoc-path}/inc/helm/_jkube_helm_lint.adoc[]
 
 include::{kitdoc-path}/inc/helm/_jkube_helm_dependency_update.adoc[]
+
+include::{kitdoc-path}/inc/helm/_jkube_helm_install.adoc[]

jkube-kit/doc/src/main/asciidoc/inc/helm/_jkube_helm_install.adoc

@@ -0,0 +1,45 @@
+ifeval::["{plugin-type}" == "maven"]
+[[jkube:helm-install]]
+== *{goal-prefix}:helm-install*
+endif::[]
+ifeval::["{plugin-type}" == "gradle"]
+[[jkubeHelmInstall]]
+=== *{task-prefix}HelmInstall*
+endif::[]
+
+This feature allows you to install your Eclipse JKube-generated
+https://helm.sh/docs/topics/charts[Helm charts]
+
+ifeval::["{plugin-type}" == "maven"]
+include::maven/_mvn_helm_install.adoc[]
+endif::[]
+ifeval::["{plugin-type}" == "gradle"]
+include::gradle/_gradle_helm_install.adoc[]
+endif::[]
+
+.Helm Install configuration
+[cols="1,5,1"]
+|===
+| Element | Description | Property
+
+| *releaseName*
+| Name of Helm Release (instance of a chart running in a Kubernetes cluster).
+| `jkube.helm.release.name`
+
+| *installDependencyUpdate*
+| update dependencies if they are missing before installing the chart
+| `jkube.helm.install.dependencyUpdate`
+
+| *installWaitReady*
+| if set, will wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment, StatefulSet, or ReplicaSet are in a ready state before marking the release as successful.
+| `jkube.helm.install.waitReady`
+
+|===
+
+.Example Helm Install configuration
+ifeval::["{plugin-type}" == "maven"]
+include::maven/_example_helm_install_config.adoc[]
+endif::[]
+ifeval::["{plugin-type}" == "gradle"]
+include::gradle/_example_helm_install_config.adoc[]
+endif::[]

jkube-kit/doc/src/main/asciidoc/inc/helm/gradle/_example_helm_install_config.adoc

@@ -0,0 +1,10 @@
+[source,groovy,indent=0,subs="verbatim,quotes,attributes"]
+----
+kubernetes {
+  helm {
+    releaseName = "test-release"
+    installWaitReady = false
+    installDependencyUpdate = false
+  }
+}
+----

jkube-kit/doc/src/main/asciidoc/inc/helm/gradle/_gradle_helm_install.adoc

@@ -0,0 +1,10 @@
+To install Helm chart you need to invoke the `{task-prefix}HelmInstall` Gradle task on the command line:
+
+[source, sh, subs="+attributes"]
+----
+gradle {task-prefix}Resource {task-prefix}Helm {task-prefix}HelmInstall
+----
+
+[NOTE]
+The `{task-prefix}Resource` and the `{task-prefix}Helm` tasks are required to create the resource descriptors which are included in the Helm chart and the Helm chart itself.
+If you have already built the resource and created the chart, then you can omit these tasks.

jkube-kit/doc/src/main/asciidoc/inc/helm/maven/_example_helm_install_config.adoc

@@ -0,0 +1,12 @@
+[source,xml,indent=0,subs="verbatim,quotes,attributes"]
+----
+<plugin>
+  <configuration>
+    <helm>
+      <releaseName>test-release</dependencySkipRefresh>
+      <installDependencyUpdate>false</dependencyVerify>
+      <installWaitReady>false</installWaitReady>
+    </helm>
+  </configuration>
+</plugin>
+----

jkube-kit/doc/src/main/asciidoc/inc/helm/maven/_mvn_helm_install.adoc

@@ -0,0 +1,10 @@
+To install a Helm chart you need to invoke the `{goal-prefix}:helm-install` Maven goal on the command line:
+
+[source, sh, subs="+attributes"]
+----
+mvn {goal-prefix}:resource {goal-prefix}:helm {goal-prefix}:helm-install
+----
+
+[NOTE]
+The `{goal-prefix}:resource` and the `{goal-prefix}:helm` goals are required to create the resource descriptors which are included in the Helm chart and the Helm chart itself.
+If you have already built the resource and created the chart, then you can omit these goals.

kubernetes-maven-plugin/doc/src/main/asciidoc/inc/goals/build/_goals.adoc

@@ -10,3 +10,4 @@ include::{kitdoc-path}/inc/helm/_jkube_helm.adoc[]
 include::{kitdoc-path}/inc/helm/_jkube_helm_push.adoc[]
 include::{kitdoc-path}/inc/helm/_jkube_helm_lint.adoc[]
 include::{kitdoc-path}/inc/helm/_jkube_helm_dependency_update.adoc[]
+include::{kitdoc-path}/inc/helm/_jkube_helm_install.adoc[]