preflight

type Checker ¶

type Checker interface {
	Name() string
	Check(ctx context.Context) []Result
}

Checker is a non-mutating preflight validation unit.

func Flatten(groups ...[]Checker) []Checker

type Options ¶

type Options struct {
	IgnoreErrors   []string
	FailOnWarnings bool
}

Options controls preflight result handling.

type Report ¶

type Report struct {
	Status  string   `json:"status"`
	Checks  []Result `json:"checks"`
	Summary Summary  `json:"summary"`
}

Report is the complete preflight output for both text and JSON consumers.

func Run(ctx context.Context, checks []Checker, opts Options) Report

func (r Report) Err(failOnWarnings bool) error

func (r Report) HasErrors() bool

func (r Report) HasWarnings() bool

type Result ¶

type Result struct {
	Name     string   `json:"name"`
	Target   string   `json:"target"`
	Severity Severity `json:"severity"`
	Message  string   `json:"message"`
	Ignored  bool     `json:"ignored"`
}

Result describes one preflight check outcome. Message and Target must not include raw configured values such as URLs, tokens, image references, or file contents.

func Error(name, target, message string, args ...any) Result

func OK(name, target, message string) Result

func Results(results ...Result) []Result

func ResultsError(name, target, message string, args ...any) []Result

func ResultsOK(name, target, message string) []Result

func ResultsWarning(name, target, message string, args ...any) []Result

func Warning(name, target, message string, args ...any) Result

type Severity ¶

type Severity string

const (
	// SeverityOK indicates the check completed successfully.
	SeverityOK Severity = "ok"
	// SeverityWarning indicates the check found a condition that bootstrap can
	// usually remediate or that does not necessarily block bootstrap.
	SeverityWarning Severity = "warning"
	// SeverityError indicates the check found a fatal condition that should block
	// bootstrap unless explicitly ignored.
	SeverityError Severity = "error"
)

type Summary ¶

type Summary struct {
	OK       int `json:"ok"`
	Warnings int `json:"warnings"`
	Errors   int `json:"errors"`
}

Summary contains aggregate result counts after ignore handling is applied.