healthchecks

Documentation

Overview

Package healthchecks run kstatus style health checks on a list of objects

Index

• func Run(ctx context.Context, watcher watcher.StatusWatcher, ...) error
• func WaitForReady(ctx context.Context, sw watcher.StatusWatcher, objs []object.ObjMetadata) error
• func WaitForReadyRuntime(ctx context.Context, sw watcher.StatusWatcher, robjs []runtime.Object) error
• type ImmediateWatcher
  • func NewImmediateWatcher(status status.Status) *ImmediateWatcher
  • func (w *ImmediateWatcher) Watch(_ context.Context, objs object.ObjMetadataSet, _ watcher.Options) <-chan event.Event

Functions

func Run

func Run(ctx context.Context, watcher watcher.StatusWatcher, healthChecks []v1alpha1.NamespacedObjectKindReference) error

Run waits for a list of Zarf healthchecks to reach a ready state.

func WaitForReady

func WaitForReady(ctx context.Context, sw watcher.StatusWatcher, objs []object.ObjMetadata) error

WaitForReady waits for all of the objects to reach a ready state.

func WaitForReadyRuntime

func WaitForReadyRuntime(ctx context.Context, sw watcher.StatusWatcher, robjs []runtime.Object) error

WaitForReadyRuntime waits for all of the objects to reach a ready state.

Types

type ImmediateWatcher

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

ImmediateWatcher should only be used for testing and returns the set status immediately.

func NewImmediateWatcher

func NewImmediateWatcher(status status.Status) *ImmediateWatcher

NewImmediateWatcher returns a ImmediateWatcher.

func (*ImmediateWatcher) Watch

func (w *ImmediateWatcher) Watch(_ context.Context, objs object.ObjMetadataSet, _ watcher.Options) <-chan event.Event

Watch watches the given objects and immediately returns the configured status.