Health Trait

The health trait is responsible for configuring the health probes on the integration container.

It’s disabled by default.

This trait is available in the following profiles: Kubernetes, Knative, OpenShift.

Configuration

Trait properties can be specified when running any integration with the CLI:

$ kamel run --trait health.[key]=[value] --trait health.[key2]=[value2] integration.groovy

The following configuration options are available:

Property Type Description

Property	Type	Description
`health.enabled`	`bool`	Can be used to enable or disable a trait. All traits share this common property.
`health.liveness-probe-enabled`	`bool`	Configures the liveness probe for the integration container (default `false`).
`health.liveness-scheme`	`string`	Scheme to use when connecting to the liveness probe (default `HTTP`).
`health.liveness-initial-delay`	`int32`	Number of seconds after the container has started before the liveness probe is initiated.
`health.liveness-timeout`	`int32`	Number of seconds after which the liveness probe times out.
`health.liveness-period`	`int32`	How often to perform the liveness probe.
`health.liveness-success-threshold`	`int32`	Minimum consecutive successes for the liveness probe to be considered successful after having failed.
`health.liveness-failure-threshold`	`int32`	Minimum consecutive failures for the liveness probe to be considered failed after having succeeded.
`health.readiness-probe-enabled`	`bool`	Configures the readiness probe for the integration container (default `true`).
`health.readiness-scheme`	`string`	Scheme to use when connecting to the readiness probe (default `HTTP`).
`health.readiness-initial-delay`	`int32`	Number of seconds after the container has started before the readiness probe is initiated.
`health.readiness-timeout`	`int32`	Number of seconds after which the readiness probe times out.
`health.readiness-period`	`int32`	How often to perform the readiness probe.
`health.readiness-success-threshold`	`int32`	Minimum consecutive successes for the readiness probe to be considered successful after having failed.
`health.readiness-failure-threshold`	`int32`	Minimum consecutive failures for the readiness probe to be considered failed after having succeeded.

health.enabled

bool

Can be used to enable or disable a trait. All traits share this common property.

health.liveness-probe-enabled

bool

Configures the liveness probe for the integration container (default false).

health.liveness-scheme

string

Scheme to use when connecting to the liveness probe (default HTTP).

health.liveness-initial-delay

int32

Number of seconds after the container has started before the liveness probe is initiated.

health.liveness-timeout

int32

Number of seconds after which the liveness probe times out.

health.liveness-period

int32

How often to perform the liveness probe.

health.liveness-success-threshold

int32

Minimum consecutive successes for the liveness probe to be considered successful after having failed.

health.liveness-failure-threshold

int32

Minimum consecutive failures for the liveness probe to be considered failed after having succeeded.

health.readiness-probe-enabled

bool

Configures the readiness probe for the integration container (default true).

health.readiness-scheme

string

Scheme to use when connecting to the readiness probe (default HTTP).

health.readiness-initial-delay

int32

Number of seconds after the container has started before the readiness probe is initiated.

health.readiness-timeout

int32

Number of seconds after which the readiness probe times out.

health.readiness-period

int32

How often to perform the readiness probe.

health.readiness-success-threshold

int32

Minimum consecutive successes for the readiness probe to be considered successful after having failed.

health.readiness-failure-threshold

int32

Minimum consecutive failures for the readiness probe to be considered failed after having succeeded.