doc (jkube-kit/doc) : Add documentation for SmallRye HealthCheck enri…

…cher

Signed-off-by: Rohan Kumar <rohaan@redhat.com>

jkube-kit/doc/src/main/asciidoc/inc/_enricher.adoc

@@ -252,6 +252,8 @@ include::enricher/quarkus-healthcheck/_jkube_healthcheck_quarkus.adoc[]
 
 include::enricher/_jkube_healthcheck_micronaut.adoc[]
 
+include::enricher/smallrye-healthcheck/_jkube_healthcheck_smallrye.adoc[]
+
 // TODO: At the moment only enrichers listed above have been tested and documented with gradle plugins. Adding the
 // rest of enrichers only in case of maven. We can slowly refactor these to support both maven and gradle configurations.
 ifeval::["{plugin-type}" == "maven"]

jkube-kit/doc/src/main/asciidoc/inc/enricher/smallrye-healthcheck/_jkube_healthcheck_smallrye.adoc

@@ -0,0 +1,116 @@
+[[jkube-healthcheck-smallrye]]
+==== jkube-healthcheck-smallrye
+
+This enricher adds kubernetes readiness and liveness and startup probes for projects which have `io.smallrye:smallrye-health` dependency added for Health management. Note that Kubernetes startup probes are only added in projects using MicroProfile 3.1 and later.
+
+===== Probe configuration
+
+You can configure the different aspects of the probes.
+
+.SmallRye HealthCheck Enricher probe configuration
+[cols="1,5,2"]
+|===
+| Element | Description | Property
+
+| *scheme*
+| Scheme to use for connecting to the host.
+
+  Defaults to `HTTP`.
+| `jkube.enricher.jkube-healthcheck-smallrye.scheme`
+
+| *port*
+| Port number to access the container.
+
+  Defaults to `9080`.
+| `jkube.enricher.jkube-healthcheck-smallrye.port`
+
+| *livenessFailureThreshold*
+| Configures `failureThreshold` field in `.livenessProbe` . Minimum consecutive failures for the probes to be considered failed after having succeeded.
+
+Defaults to `3`.
+| `jkube.enricher.jkube-healthcheck-smallrye.livenessFailureThreshold`
+
+| *livenessSuccessThreshold*
+| Configures `successThreshold` field in `.livenessProbe`. Minimum consecutive successes for the probes to be considered successful after having failed.
+
+  Defaults to `1`.
+| `jkube.enricher.jkube-healthcheck-smallrye.livenessSuccessThreshold`
+
+| *livenessInitialDelay*
+| Configures `initialDelaySeconds` field in `.livenessProbe`. Number of seconds after the container has started before liveness or readiness probes are initiated.
+
+Defaults to `0` seconds.
+| `jkube.enricher.jkube-healthcheck-smallrye.livenessInitialDelay`
+
+| *livenessPeriodSeconds*
+| Configures `periodSeconds` field in `.livenessProbe`. How often (in seconds) to perform the liveness probe.
+
+Defaults to `10`.
+| `jkube.enricher.jkube-healthcheck-smallrye.livenessPeriodSeconds`
+
+| *livenessPath*
+| Path to access on the application server.
+
+Defaults to `/health/live`.
+| `jkube.enricher.jkube-healthcheck-smallrye.livenessPath`
+
+| *readinessFailureThreshold*
+| Configures `failureThreshold` field in `.readinessProbe` . Minimum consecutive failures for the probes to be considered failed after having succeeded.
+
+Defaults to `3`.
+| `jkube.enricher.jkube-healthcheck-smallrye.readinessFailureThreshold`
+
+| *readinessSuccessThreshold*
+| Configures `successThreshold` field in `.readinessProbe`. Minimum consecutive successes for the probes to be considered successful after having failed.
+
+Defaults to `1`.
+| `jkube.enricher.jkube-healthcheck-smallrye.readinessSuccessThreshold`
+
+| *readinessInitialDelay*
+| Configures `initialDelaySeconds` field in `.readinessProbe`. Number of seconds after the container has started before liveness or readiness probes are initiated.
+
+Defaults to `0` seconds.
+| `jkube.enricher.jkube-healthcheck-smallrye.readinessInitialDelay`
+
+| *readinessPeriodSeconds*
+| Configures `periodSeconds` field in `.readinessProbe`. How often (in seconds) to perform the liveness probe.
+
+Defaults to `10`.
+| `jkube.enricher.jkube-healthcheck-smallrye.readinessPeriodSeconds`
+
+| *readinessPath*
+| Path to access on the application server.
+
+Defaults to `/health/ready`.
+| `jkube.enricher.jkube-healthcheck-smallrye.readinessPath`
+
+| *startupFailureThreshold*
+| Configures `failureThreshold` field in `.startupProbe` . Minimum consecutive failures for the probes to be considered failed after having succeeded.
+
+Defaults to `3`.
+| `jkube.enricher.jkube-healthcheck-smallrye.startupFailureThreshold`
+
+| *startupSuccessThreshold*
+| Configures `successThreshold` field in `.startupProbe`. Minimum consecutive successes for the probes to be considered successful after having failed.
+
+Defaults to `1`.
+| `jkube.enricher.jkube-healthcheck-smallrye.startupSuccessThreshold`
+
+| *startupInitialDelay*
+| Configures `initialDelaySeconds` field in `.startupProbe`. Number of seconds after the container has started before liveness or startup probes are initiated.
+
+Defaults to `0` seconds.
+| `jkube.enricher.jkube-healthcheck-smallrye.startupInitialDelay`
+
+| *startupPeriodSeconds*
+| Configures `periodSeconds` field in `.startupProbe`. How often (in seconds) to perform the liveness probe.
+
+Defaults to `10`.
+| `jkube.enricher.jkube-healthcheck-smallrye.startupPeriodSeconds`
+
+| *startupPath*
+| Path to access on the application server.
+
+Defaults to `/health/started`.
+| `jkube.enricher.jkube-healthcheck-smallrye.startupPath`
+|===