Package io.quarkus.kubernetes.deployment

Interface ProbeConfig

public interface ProbeConfig

  • Method Details

    • httpActionPort

      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

      Optional<String> httpActionPortName()
      The port name for selecting the port of the HTTP get action.

    • httpActionPath

      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

      Optional<String> httpActionScheme()
      The scheme of the HTTP get action. Can be either "HTTP" or "HTTPS".

    • execAction

      Optional<String> execAction()
      The command to use for the probe.

    • tcpSocketAction

      Optional<String> tcpSocketAction()
      The tcp socket to use for the probe (the format is host:port).

    • grpcAction

      Optional<String> grpcAction()
      The gRPC port to use for the probe (the format is either port or port:service).

    • grpcActionEnabled

      @WithDefault("false") boolean grpcActionEnabled()
      If enabled and `grpc-action` is not provided, it will use the generated service name and the gRPC port.

    • initialDelay

      @WithDefault("5") Duration initialDelay()
      The amount of time to wait before starting to probe.

    • period

      @WithDefault("10s") Duration period()
      The period in which the action should be called.

    • timeout

      @WithDefault("10s") Duration timeout()
      The amount of time to wait for each action.

    • successThreshold

      @WithDefault("1") Integer successThreshold()
      The success threshold to use.

    • failureThreshold

      @WithDefault("3") Integer failureThreshold()
      The failure threshold to use.

    • hasUserSuppliedAction

      default boolean hasUserSuppliedAction()