readiness

Documentation

Index

• Constants
• func DecodeProbes(jsonProbe string, multiContainerProbes bool) ([]*corev1.Probe, error)
• func EncodeMultipleProbes(rps []*corev1.Probe) (string, error)
• func EncodeSingleProbe(rp *corev1.Probe) (string, error)
• type Probe
  • func NewProbe(probes []*corev1.Probe) *Probe
  • func NewProbeWithHTTP2AutoDetection(probes []*corev1.Probe) *Probe
  • func (p *Probe) ProbeContainer() bool

Constants

const (

	// PollTimeout is set equal to the queue-proxy's ExecProbe timeout to take
	// advantage of the full window
	PollTimeout = 10 * time.Second
)

Functions

func DecodeProbes

func DecodeProbes(jsonProbe string, multiContainerProbes bool) ([]*corev1.Probe, error)

DecodeProbes takes a json serialised *corev1.Probe OR []*corev1.Probe (depending on multiContainerProbes) and returns a slice of probes or an error.

func EncodeMultipleProbes

func EncodeMultipleProbes(rps []*corev1.Probe) (string, error)

EncodeMultipleProbes takes []*corev1.Probe slice and returns marshalled slice of Probe JSON string and an error.

func EncodeSingleProbe

func EncodeSingleProbe(rp *corev1.Probe) (string, error)

EncodeSingleProbe takes a single *corev1.Probe object and returns marshalled Probe JSON string and an error.

Types

type Probe

type Probe struct {
	// contains filtered or unexported fields
}

Probe holds all wrapped *corev1.Probe along with a barrier to sync single probing execution

func NewProbe

func NewProbe(probes []*corev1.Probe) *Probe

NewProbe returns a pointer to a new Probe.

func NewProbeWithHTTP2AutoDetection

func NewProbeWithHTTP2AutoDetection(probes []*corev1.Probe) *Probe

NewProbeWithHTTP2AutoDetection returns a pointer to a new Probe that has HTTP2 auto-detection enabled.

func (*Probe) ProbeContainer

func (p *Probe) ProbeContainer() bool

ProbeContainer executes the defined Probe against the user-container