@kubevirt-ui/kubevirt-api
    Preparing search index...

    Interface IoK8sApiCoreV1Probe

    Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.

    interface IoK8sApiCoreV1Probe {
        exec?: IoK8sApiCoreV1ExecAction;
        failureThreshold?: number;
        grpc?: IoK8sApiCoreV1GRPCAction;
        httpGet?: IoK8sApiCoreV1HTTPGetAction;
        initialDelaySeconds?: number;
        periodSeconds?: number;
        successThreshold?: number;
        tcpSocket?: IoK8sApiCoreV1TCPSocketAction;
        terminationGracePeriodSeconds?: number;
        timeoutSeconds?: number;
    }
    Index

    Properties

    exec? failureThreshold? grpc? httpGet? initialDelaySeconds? periodSeconds? successThreshold? tcpSocket? terminationGracePeriodSeconds? timeoutSeconds?

    Properties

    exec?: IoK8sApiCoreV1ExecAction

    Exec specifies a command to execute in the container.

    failureThreshold?: number

    Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

    int32

    grpc?: IoK8sApiCoreV1GRPCAction

    GRPC specifies a GRPC HealthCheckRequest.

    httpGet?: IoK8sApiCoreV1HTTPGetAction

    HTTPGet specifies an HTTP GET request to perform.

    initialDelaySeconds?: number

    Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

    int32

    periodSeconds?: number

    How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

    int32

    successThreshold?: number

    Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.

    int32

    tcpSocket?: IoK8sApiCoreV1TCPSocketAction

    TCPSocket specifies a connection to a TCP port.

    terminationGracePeriodSeconds?: number

    Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.

    int64

    timeoutSeconds?: number

    Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

    int32

    Settings

    Member Visibility

    On This Page

    Properties