struct Kubernetes::Probe

Overview

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

Included Modules

Defined in:

generated/models/io_k8s_api_core_v1.cr

Constructors

Macro Summary

Instance Method Summary

Constructor Detail

def self.new(ctx : YAML::ParseContext, node : YAML::Nodes::Node) #

def self.new(pull : ::JSON::PullParser) #

def self.new(*, __pull_for_json_serializable pull : ::JSON::PullParser) #

def self.new(*, __context_for_yaml_serializable ctx : YAML::ParseContext, __node_for_yaml_serializable node : YAML::Nodes::Node) #

Macro Detail

macro field(name, type = nil, **options, &block) #

Helper macro for defining fields with automatic camelCase conversion


Instance Method Detail

def exec : ExecAction | Nil #

Exec specifies a command to execute in the container.


def exec=(exec : ExecAction | Nil) #

Exec specifies a command to execute in the container.


def failure_threshold : Int32 | Nil #

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


def failure_threshold=(failure_threshold : Int32 | Nil) #

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


def grpc : GRPCAction | Nil #

GRPC specifies a GRPC HealthCheckRequest.


def grpc=(grpc : GRPCAction | Nil) #

GRPC specifies a GRPC HealthCheckRequest.


def http_get : HTTPGetAction | Nil #

HTTPGet specifies an HTTP GET request to perform.


def http_get=(http_get : HTTPGetAction | Nil) #

HTTPGet specifies an HTTP GET request to perform.


def initial_delay_seconds : Int32 | Nil #

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


def initial_delay_seconds=(initial_delay_seconds : Int32 | Nil) #

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


def period_seconds : Int32 | Nil #

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


def period_seconds=(period_seconds : Int32 | Nil) #

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


def success_threshold : Int32 | Nil #

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.


def success_threshold=(success_threshold : Int32 | Nil) #

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.


def tcp_socket : TCPSocketAction | Nil #

TCPSocket specifies a connection to a TCP port.


def tcp_socket=(tcp_socket : TCPSocketAction | Nil) #

TCPSocket specifies a connection to a TCP port.


def termination_grace_period_seconds : Int64 | Nil #

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.


def termination_grace_period_seconds=(termination_grace_period_seconds : Int64 | Nil) #

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.


def timeout_seconds : Int32 | Nil #

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


def timeout_seconds=(timeout_seconds : Int32 | Nil) #

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