org.eclipse.jkube.vertx.enricher

Class VertxHealthCheckEnricher

java.lang.Object

org.eclipse.jkube.kit.enricher.api.BaseEnricher

org.eclipse.jkube.kit.enricher.specific.AbstractHealthCheckEnricher

org.eclipse.jkube.vertx.enricher.VertxHealthCheckEnricher

All Implemented Interfaces:

org.eclipse.jkube.kit.common.Named, org.eclipse.jkube.kit.enricher.api.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
protected static String[]	JKUBE_PLUGINS

Fields inherited from class org.eclipse.jkube.kit.enricher.specific.AbstractHealthCheckEnricher

ENRICH_ALL_CONTAINERS, ENRICH_CONTAINERS

Fields inherited from class org.eclipse.jkube.kit.enricher.api.BaseEnricher

CREATE_EXTERNAL_URLS, ENRICH_ALL_WITH_IMAGE_TRIGGERS, enricherContext, FABRIC8_GENERATED_CONTAINERS, IMAGE_CHANGE_TRIGGERS, JKUBE_DEFAULT_IMAGE_PULL_POLICY, JKUBE_DOMAIN, JKUBE_ENFORCED_IMAGE_PULL_POLICY, JKUBE_ENFORCED_REPLICAS, log, NEED_IMAGECHANGE_TRIGGERS, OPENSHIFT_DEPLOY_TIMEOUT_SECONDS, OPENSHIFT_ENABLE_AUTOMATIC_TRIGGER, OPENSHIFT_TRIM_IMAGE_IN_CONTAINER_SPEC, SIDECAR

Fields inherited from interface org.eclipse.jkube.kit.enricher.api.Enricher

INTERNAL_ANNOTATION_PREFIX

Constructor Summary

Constructors

Constructor and Description
VertxHealthCheckEnricher(org.eclipse.jkube.kit.enricher.api.JKubeEnricherContext buildContext)

Method Summary

Modifier and Type	Method and Description
protected io.fabric8.kubernetes.api.model.Probe	getLivenessProbe()
protected io.fabric8.kubernetes.api.model.Probe	getReadinessProbe()

Methods inherited from class org.eclipse.jkube.kit.enricher.specific.AbstractHealthCheckEnricher

create, getContainersToEnrich, getLivenessProbe, getReadinessProbe, getStartupProbe, getStartupProbe

Methods inherited from class org.eclipse.jkube.kit.enricher.api.BaseEnricher

enrich, getConfig, getConfig, getConfiguration, getConfigWithFallback, getContext, getControllerName, getControllerResourceConfig, getCreateExternalUrls, getImagePullPolicy, getImages, getLog, getName, getNamespace, getOpenshiftDeployTimeoutInSeconds, getProcessingInstructionViaKey, getReplicaCount, getValueFromConfig, getValueFromConfig, hasImageConfiguration, isOpenShiftMode, setProcessingInstruction, shouldUseLegacyJKubePrefix, useDeploymentForOpenShift

Methods inherited from class java.lang.Object

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

Field Detail

JKUBE_PLUGINS

protected static final String[] JKUBE_PLUGINS

ERROR_MESSAGE

public static final String ERROR_MESSAGE

See Also:

Constant Field Values

Constructor Detail

VertxHealthCheckEnricher

public VertxHealthCheckEnricher(org.eclipse.jkube.kit.enricher.api.JKubeEnricherContext buildContext)

Method Detail

getReadinessProbe

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

Overrides:

getReadinessProbe in class AbstractHealthCheckEnricher

getLivenessProbe

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

Overrides:

getLivenessProbe in class AbstractHealthCheckEnricher