Skip to main content
Module

x/helmet/mod.ts>IoK8sApiCoreV1Probe

Type-safe Helm - the right way to do Infrastructure as Code in Kubernetes
shopstic/helmet
Go to Latest
class IoK8sApiCoreV1Probe
Re-export
import { IoK8sApiCoreV1Probe } from "https://deno.land/x/helmet@1.14.0/mod.ts";

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

Constructors

new
IoK8sApiCoreV1Probe()

Properties

optional
exec: IoK8sApiCoreV1ExecAction
optional
failureThreshold: number

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

optional
httpGet: IoK8sApiCoreV1HTTPGetAction
optional
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

optional
periodSeconds: number

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

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

optional
tcpSocket: IoK8sApiCoreV1TCPSocketAction
optional
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.

optional
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

Static Properties

readonly
attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string; }>
readonly
discriminator: string | undefined