setup

type AdminPlan struct {
	Username string `yaml:"username"`
	Email    string `yaml:"email"`
	Password Secret `yaml:"password"`
}

type Change struct {
	Step   string `json:"step"`
	Action string `json:"action"`
	Target string `json:"target,omitempty"`
	Backup string `json:"backup,omitempty"`
}

type Check struct {
	Name string
	OK   bool
	// Fatal marks a failure that stops the run; a non-fatal failure is a
	// warning the operator should see but can proceed past.
	Fatal  bool
	Detail string
}

type DatabaseMode string

type DatabasePlan struct {
	Mode     DatabaseMode `yaml:"mode"`
	Host     string       `yaml:"host"`
	Port     int          `yaml:"port"`
	Name     string       `yaml:"name"`
	RoleName string       `yaml:"role_name"`
	Password Secret       `yaml:"password"`
	// SSLMode is forced to at least "require" when Host is not loopback; a
	// remote database over cleartext is not something to allow by accident.
	SSLMode string `yaml:"sslmode"`
	// ManagePgHba is opt-in. Editing pg_hba.conf is the single most effective
	// way to lock an operator out of their own database, so the default is to
	// print the required lines and re-check rather than to write them.
	ManagePgHba bool `yaml:"manage_pg_hba"`
	// NoManagePgHba declines the edit even when this run provisioned the
	// cluster, which is otherwise managed without asking.
	NoManagePgHba bool `yaml:"no_manage_pg_hba,omitempty"`
}

type Family string

type PauseError struct {
	Step   string
	Reason string
}

type Plan struct {
	APIVersion string       `yaml:"apiVersion"`
	Platform   Platform     `yaml:"platform"`
	Database   DatabasePlan `yaml:"database"`
	Service    ServicePlan  `yaml:"service"`
	Admin      AdminPlan    `yaml:"admin"`
	Migrate    bool         `yaml:"migrate"`
}

type PlannedStep struct {
	Step   Step
	Status StepStatus
}

type Platform struct {
	// ID is the os-release ID, e.g. "rhel", "rocky", "almalinux", "ubuntu".
	ID string `yaml:"id"`
	// VersionID is the os-release VERSION_ID, e.g. "9.8".
	VersionID string `yaml:"version_id"`
	// Major is VersionID's leading integer, e.g. 9. Zero when unparseable.
	Major int `yaml:"major"`
	// Family determines package manager and PostgreSQL layout.
	Family Family `yaml:"family"`
	// Arch is the Go architecture, e.g. "amd64".
	Arch string `yaml:"arch"`
	// Support gates the run.
	Support Support `yaml:"support"`
	// SELinux is "enforcing", "permissive", "disabled", or "" when absent.
	SELinux string `yaml:"selinux,omitempty"`
	// FIPS reports the kernel-level FIPS switch (/proc/sys/crypto/fips_enabled).
	FIPS bool `yaml:"fips"`
	// Fapolicyd reports whether the file-access policy daemon is active. It
	// blocks execution of anything absent from its trust database, which is
	// derived from the package database, so a non-packaged install is denied.
	Fapolicyd bool `yaml:"fapolicyd"`
}

type Receipt struct {
	AppliedAt string   `json:"applied_at"`
	Version   string   `json:"openwatch_version"`
	Platform  Platform `json:"platform"`
	Plan      Plan     `json:"plan"`
	Changes   []Change `json:"changes"`
	URL       string   `json:"url"`
}

type Run struct {
	Plan Plan
	// DryRun performs detection and planning but no writes.
	DryRun bool
	// Secrets resolved at apply time. Never serialized anywhere.
	DBPassword    string
	AdminPassword string

	// Changes accumulates what actually happened.
	Changes []Change
	// Out receives progress lines.
	Out func(format string, args ...any)
}

type Secret struct {
	Source SecretSource `yaml:"source"`
	// Ref names the env var or file path for the env/file sources.
	Ref string `yaml:"ref,omitempty"`
	// Length is the generated length; ignored for other sources.
	Length int `yaml:"length,omitempty"`
}

type SecretSource string

type ServicePlan struct {
	ListenHost string `yaml:"listen_host"`
	ListenPort int    `yaml:"listen_port"`
	// BindCapability is DERIVED from ListenPort, never authored: a port below
	// 1024 needs CAP_NET_BIND_SERVICE because the service runs unprivileged.
	BindCapability bool `yaml:"bind_capability"`
	EnableOnBoot   bool `yaml:"enable_on_boot"`
	StartNow       bool `yaml:"start_now"`
	// OpenFirewall allows inbound traffic to ListenPort. Default true: the
	// health check runs over loopback, where the firewall does not apply, so
	// without this an install can report itself healthy while being
	// unreachable from every other machine.
	OpenFirewall bool `yaml:"open_firewall"`
}

type Step interface {
	ID() string
	// Describe says what applying it would do, for the plan.
	Describe(p Plan) string
	// Status reports whether it is already satisfied. Must not mutate.
	Status(ctx context.Context, p Plan) StepStatus
	// Apply performs it.
	Apply(ctx context.Context, r *Run) error
}

type StepStatus struct {
	// Done means the desired state already holds; Apply will be skipped.
	Done bool
	// Detail is shown in the plan, e.g. "already exists" or the version found.
	Detail string
}

type Support string