health

type Checker interface {
	// Name returns the name of the Checker.
	Name() string
	// Check executes a health check.
	Check(ctx context.Context, project, stage string, criteria Criteria) Result
}

type Criteria struct {
	// Kind identifies a registered Checker that implements the logic
	// for the health check process.
	Kind string
	// Input is an opaque map of values to be passed to the Checker.
	Input Input
}

type Input map[string]any

type Result struct {
	// Status is the high-level outcome of the HealthCheck executed by a
	// Checker.
	Status kargoapi.HealthState
	// Output is the opaque output of a HealthCheck executed by a
	// Checker. The Engine will aggregate this output and include it
	// in the final results of the health check, which will ultimately be included
	// in StageStatus.
	Output map[string]any
	// Issues is a list of issues that were encountered during the execution of
	// the health check by a Checker.
	Issues []string
}