package kubecaml

  1. Overview
  2. Docs
package kubecaml
Legend:
Library
Module
Module type
Parameter
Class
Class type

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

type t
val to_yojson : t -> Yojson.Safe.t
val make : ?timeout_seconds:int -> ?tcp_socket:Kubernetes.Definitions.Api.Core.V1.Tcp_socket_action.t -> ?success_threshold:int -> ?period_seconds:int -> ?initial_delay_seconds:int -> ?http_get:Kubernetes.Definitions.Api.Core.V1.Http_get_action.t -> ?failure_threshold:int -> ?exec:Kubernetes.Definitions.Api.Core.V1.Exec_action.t -> unit -> t

One and only one of the following should be specified. Exec specifies the action to take.

val failure_threshold : t -> int option

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

Http_get specifies the http request to perform.

val initial_delay_seconds : t -> int option

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

val period_seconds : t -> int option

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

val success_threshold : t -> int option

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

Tcp_socket specifies an action involving a Tcp port. Tcp hooks not yet supported

val timeout_seconds : t -> int option

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

module Object : Object.S with type value := t
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events Blog Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct