ready

Documentation

Index

• type Ready
  • func NewFileReady() Ready

Types

type Ready

type Ready interface {
	// Set ensures that future readiness probes will indicate that the operator
	// is ready.
	Set() error

	// Unset ensures that future readiness probes will indicate that the
	// operator is not ready.
	Unset() error
}

Ready holds state about whether the operator is ready and communicates that to a Kubernetes readiness probe.

func NewFileReady

func NewFileReady() Ready

NewFileReady returns a Ready that uses the presence of a file on disk to communicate whether the operator is ready. The operator's Pod definition should include a readinessProbe of "exec" type that calls "stat /tmp/operator-sdk-ready".