probing

Documentation

Index

• type Prober
  • func NewConditionProbe(typeName, status string) Prober
  • func Parse(ctx context.Context, packageProbes []corev1alpha1.ObjectSetProbe) (Prober, error)
  • func ParseProbes(_ context.Context, probeSpecs []corev1alpha1.Probe) Prober
  • func ParseSelector(_ context.Context, selector corev1alpha1.ProbeSelector, probe Prober) (Prober, error)

Types

type Prober

type Prober interface {
	Probe(obj *unstructured.Unstructured) (success bool, message string)
}

func NewConditionProbe

func NewConditionProbe(typeName, status string) Prober

func Parse

func Parse(ctx context.Context, packageProbes []corev1alpha1.ObjectSetProbe) (Prober, error)

Parse takes a list of ObjectSetProbes (commonly defined within a ObjectSetPhaseSpec) and compiles a single Prober to test objects with.

func ParseProbes

func ParseProbes(_ context.Context, probeSpecs []corev1alpha1.Probe) Prober

ParseProbes takes a []corev1alpha1.Probe and compiles it into a Prober.

func ParseSelector

func ParseSelector(_ context.Context, selector corev1alpha1.ProbeSelector, probe Prober) (Prober, error)

ParseSelector reads a corev1alpha1.ProbeSelector and wraps a Prober, only executing the Prober when the selector criteria match.