io.fabric8.maven.enricher.fabric8

Class VertxHealthCheckEnricher

java.lang.Object

io.fabric8.maven.enricher.api.BaseEnricher

io.fabric8.maven.enricher.fabric8.AbstractHealthCheckEnricher

io.fabric8.maven.enricher.fabric8.VertxHealthCheckEnricher

All Implemented Interfaces:

io.fabric8.maven.core.config.Named, Enricher

public class VertxHealthCheckEnricher
extends AbstractHealthCheckEnricher

Configures the health checks for a Vert.x project. Unlike other enricher this enricher extract the configuration from the following project properties: `vertx.health.port`, `vertx.health.path`.

It builds a liveness probe and a readiness probe using:

• `vertx.health.port` - the port, 8080 by default, a negative number disables the health check
• `vertx.health.path` - the path, / by default, an empty (non null) value disables the health check
• `vertx.health.scheme` - the scheme, HTTP by default, can be set to HTTPS (adjusts the port accordingly)

Author:

Clement Escoffier

Field Summary

Fields

Modifier and Type	Field and Description
static String	ERROR_MESSAGE

Fields inherited from class io.fabric8.maven.enricher.fabric8.AbstractHealthCheckEnricher

ENRICH_ALL_CONTAINERS, ENRICH_CONTAINERS

Fields inherited from class io.fabric8.maven.enricher.api.BaseEnricher

enricherContext, FABRIC8_GENERATED_CONTAINERS, log, NEED_IMAGECHANGE_TRIGGERS

Constructor Summary

Constructors

Constructor and Description
VertxHealthCheckEnricher(MavenEnricherContext buildContext)

Method Summary

Modifier and Type	Method and Description
protected io.fabric8.kubernetes.api.model.Probe	getLivenessProbe() Override this method to create a generic liveness probe.
protected io.fabric8.kubernetes.api.model.Probe	getReadinessProbe() Override this method to create a generic readiness probe.

Methods inherited from class io.fabric8.maven.enricher.fabric8.AbstractHealthCheckEnricher

checkIfHealthChecksDisabled, create, getContainersToEnrich, getLivenessProbe, getReadinessProbe

Methods inherited from class io.fabric8.maven.enricher.api.BaseEnricher

enrich, getConfig, getConfig, getConfiguration, getContext, getImageChangeTriggerFlag, getImages, getLog, getName, getOpenshiftDeployTimeoutInSeconds, getProcessingInstructionViaKey, getRawConfig, getReplicaCount, getTrimImageInContainerSpecFlag, hasConfig, hasImageConfiguration, isAutomaticTriggerEnabled, isOpenShiftMode, setProcessingInstruction

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ERROR_MESSAGE

public static final String ERROR_MESSAGE

See Also:

Constant Field Values

Constructor Detail

VertxHealthCheckEnricher

public VertxHealthCheckEnricher(MavenEnricherContext buildContext)

Method Detail

getReadinessProbe

protected io.fabric8.kubernetes.api.model.Probe getReadinessProbe()

Description copied from class: AbstractHealthCheckEnricher

Override this method to create a generic readiness probe.

Overrides:

getReadinessProbe in class AbstractHealthCheckEnricher

getLivenessProbe

protected io.fabric8.kubernetes.api.model.Probe getLivenessProbe()

Description copied from class: AbstractHealthCheckEnricher

Override this method to create a generic liveness probe.

Overrides:

getLivenessProbe in class AbstractHealthCheckEnricher