Package io.quarkus.kubernetes.deployment

Class ProbeConfig

java.lang.Object

io.quarkus.kubernetes.deployment.ProbeConfig

public class ProbeConfig
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
(package private) Optional<String>	execAction	The command to use for the probe.
(package private) Integer	failureThreshold	The failure threshold to use.
(package private) Optional<String>	grpcAction	The gRPC port to use for the probe (the format is either port or port:service).
(package private) boolean	grpcActionEnabled	If enabled and `grpc-action` is not provided, it will use the generated service name and the gRPC port.
(package private) Optional<String>	httpActionPath	The http path to use for the probe.
(package private) Optional<Integer>	httpActionPort	The port number to use when configuring the http get action.
(package private) Optional<String>	httpActionPortName	The port name for selecting the port of the HTTP get action.
(package private) Optional<String>	httpActionScheme	The scheme of the HTTP get action.
(package private) Duration	initialDelay	The amount of time to wait before starting to probe.
(package private) Duration	period	The period in which the action should be called.
(package private) Integer	successThreshold	The success threshold to use.
(package private) Optional<String>	tcpSocketAction	The tcp socket to use for the probe (the format is host:port).
(package private) Duration	timeout	The amount of time to wait for each action.

Constructor Summary

Constructors

Constructor	Description
ProbeConfig()

Method Summary

Modifier and Type	Method	Description
boolean	hasUserSuppliedAction()

Methods inherited from class java.lang.Object

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

Field Details

httpActionPort

@ConfigItem
Optional<Integer> httpActionPort

The port number to use when configuring the http get action. If not configured, the port corresponding to the httpActionPortName will be used.

httpActionPortName

@ConfigItem
Optional<String> httpActionPortName

The port name for selecting the port of the HTTP get action.

httpActionPath

@ConfigItem
Optional<String> httpActionPath

The http path to use for the probe. For this to work, the container port also needs to be set. Assuming the container port has been set (as per above comment), if execAction or tcpSocketAction are not set, an HTTP probe will be used automatically even if no path is set (which will result in the root path being used). If Smallrye Health is used, the path will automatically be set according to the health check path.

httpActionScheme

@ConfigItem
Optional<String> httpActionScheme

The scheme of the HTTP get action. Can be either "HTTP" or "HTTPS".

execAction

@ConfigItem
Optional<String> execAction

The command to use for the probe.

tcpSocketAction

@ConfigItem
Optional<String> tcpSocketAction

The tcp socket to use for the probe (the format is host:port).

grpcAction

@ConfigItem
Optional<String> grpcAction

The gRPC port to use for the probe (the format is either port or port:service).

grpcActionEnabled

@ConfigItem(defaultValue="false")
boolean grpcActionEnabled

If enabled and `grpc-action` is not provided, it will use the generated service name and the gRPC port.

initialDelay

@ConfigItem(defaultValue="5")
Duration initialDelay

The amount of time to wait before starting to probe.

period

@ConfigItem(defaultValue="10s")
Duration period

The period in which the action should be called.

timeout

@ConfigItem(defaultValue="10s")
Duration timeout

The amount of time to wait for each action.

successThreshold

@ConfigItem(defaultValue="1")
Integer successThreshold

The success threshold to use.

failureThreshold

@ConfigItem(defaultValue="3")
Integer failureThreshold

The failure threshold to use.

Constructor Details

ProbeConfig

public ProbeConfig()

Method Details

hasUserSuppliedAction

public boolean hasUserSuppliedAction()