Resource Type: kubernetes_probe

Defined in:
lib/puppet/type/kubernetes_probe.rb
Providers:
swagger

Overview

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

Properties

  • ensure (defaults to: present)

    The basic property that the resource should be in.

    Supported values:
    • present
    • absent
  • exec

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

  • failure_threshold

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

  • http_get

    HTTPGet specifies the http request to perform.

  • initial_delay_seconds

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

  • period_seconds

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

  • success_threshold

    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

    TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported

  • timeout_seconds

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

Parameters

  • name (namevar)

    Name of the probe.

  • provider

    The specific backend to use for this ‘kubernetes_probe` resource. You will seldom need to specify this — Puppet will usually discover the appropriate provider for your platform.