struct

Kubernetes::Probe

Inherits YAML::Serializable < JSON::Serializable < Kubernetes::Serializable < Struct < Value < Object

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

Constructors

new(ctx : YAML::ParseContext, node : YAML::Nodes::Node)
new(pull : ::JSON::PullParser)
new(*, __pull_for_json_serializable pull : ::JSON::PullParser)
new(*, __context_for_yaml_serializable ctx : YAML::ParseContext, __node_for_yaml_serializable node : YAML::Nodes::Node)

Instance methods

exec

Exec specifies a command to execute in the container.

Source
exec=(exec : ExecAction | Nil)

Exec specifies a command to execute in the container.

Source
failure_threshold

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

Source
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.

Source
grpc

GRPC specifies a GRPC HealthCheckRequest.

Source
grpc=(grpc : GRPCAction | Nil)

GRPC specifies a GRPC HealthCheckRequest.

Source
http_get

HTTPGet specifies an HTTP GET request to perform.

Source
http_get=(http_get : HTTPGetAction | Nil)

HTTPGet specifies an HTTP GET request to perform.

Source
initial_delay_seconds

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

Source
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

Source
period_seconds

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

Source
period_seconds=(period_seconds : Int32 | Nil)

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

Source
success_threshold

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.

Source
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.

Source
tcp_socket

TCPSocket specifies a connection to a TCP port.

Source
tcp_socket=(tcp_socket : TCPSocketAction | Nil)

TCPSocket specifies a connection to a TCP port.

Source
termination_grace_period_seconds

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.

Source
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.

Source
timeout_seconds

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

Source
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

Source

Macros

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

Helper macro for defining fields with automatic camelCase conversion

Source