janitor

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

type Deps struct {
	Store  Store
	Docker Docker
	// DiskFree reports free and total bytes of the volume Docker data lives on.
	DiskFree func(ctx context.Context) (free, total int64, err error)
	// DesiredContainers lists container names the reconciler still wants, which a prune must keep.
	DesiredContainers func(ctx context.Context) ([]string, error)
	// OrphanVolumes lists named volumes no desired state or container references.
	OrphanVolumes func(ctx context.Context) ([]docker.NamedVolume, error)
	RemoveVolume  func(ctx context.Context, name string) error
	// TokenWindows reads the live token retention settings; nil skips the tokens stage.
	TokenWindows func(ctx context.Context) TokenWindows
	// TokenBatch and TokenMaxBatches bound one pass; zero uses the defaults.
	TokenBatch, TokenMaxBatches int
	// Audit records a system audit row with a JSON detail.
	Audit  func(ctx context.Context, action, detail string)
	Logger *slog.Logger
	Now    func() time.Time
}

type Docker interface {
	DiskUsage(ctx context.Context) (docker.DiskUsage, error)
	ListAllImages(ctx context.Context) ([]docker.ImageRecord, error)
	PruneContainers(ctx context.Context, keep []string) (docker.PruneContainersResult, error)
	PruneDanglingImages(ctx context.Context) (docker.PruneImagesResult, error)
	PruneAnonymousVolumes(ctx context.Context) (docker.PruneVolumesResult, error)
	BuildCacheRecords(ctx context.Context) ([]docker.BuildCacheRecord, error)
	PruneBuildCacheOlderThan(ctx context.Context, olderThan time.Duration) (docker.PruneBuildCacheResult, error)
}

type Engine struct {
	Deps
	// contains filtered or unexported fields
}

type Item struct {
	Name      string `json:"name"`
	Detail    string `json:"detail,omitempty"`
	SizeBytes int64  `json:"size_bytes"`
	// Count is how many rows the item covers, for stages that remove rows rather than bytes.
	Count  int    `json:"count,omitempty"`
	Action string `json:"action"`
}

type Options struct {
	Trigger string
	DryRun  bool
	// Force runs the size-driven stages even when free space is above budget.
	Force bool
	// Stages limits the pass to these stages; empty runs every stage the policy enables.
	Stages []Stage
}

type Policy struct {
	Enabled bool `json:"enabled"`
	// DryRun makes scheduled passes report without removing anything.
	DryRun          bool `json:"dry_run"`
	IntervalMinutes int  `json:"interval_minutes"`
	// DiskFreeBudgetPercent is the free space below which size-driven stages run on a schedule.
	DiskFreeBudgetPercent float64 `json:"disk_free_budget_percent"`
	BuildCacheBudgetMB    int64   `json:"build_cache_budget_mb"`
	BuildCacheMaxAgeHours int     `json:"build_cache_max_age_hours"`
	// VolumeQuarantineDays is how long an orphaned volume is held before it may be deleted.
	VolumeQuarantineDays int `json:"volume_quarantine_days"`
	// DeleteOrphanVolumes lets a pass delete volumes whose quarantine ended; off keeps them listed only.
	DeleteOrphanVolumes  bool    `json:"delete_orphan_volumes"`
	AttemptRetentionDays int     `json:"attempt_retention_days"`
	AttemptKeepPerApp    int     `json:"attempt_keep_per_app"`
	DisabledStages       []Stage `json:"disabled_stages"`
}

type PolicyStore interface {
	GetJanitorPolicy(ctx context.Context) (string, bool, error)
	SetJanitorPolicy(ctx context.Context, body, actor string, now time.Time) error
}

type Report struct {
	ID             string        `json:"id"`
	StartedAt      time.Time     `json:"started_at"`
	Trigger        string        `json:"trigger"`
	DryRun         bool          `json:"dry_run"`
	FreePercent    float64       `json:"free_percent"`
	Pressure       bool          `json:"pressure"`
	Stages         []StageResult `json:"stages"`
	ReclaimedBytes int64         `json:"reclaimed_bytes"`
	Error          string        `json:"error,omitempty"`
}

type Stage string

type StageResult struct {
	Stage          Stage  `json:"stage"`
	Status         string `json:"status"`
	Reason         string `json:"reason,omitempty"`
	Items          []Item `json:"items"`
	ReclaimedBytes int64  `json:"reclaimed_bytes"`
	Error          string `json:"error,omitempty"`
}

type Store interface {
	PolicyStore
	InsertJanitorRun(ctx context.Context, r store.JanitorRun, keep int) error
	ListJanitorRuns(ctx context.Context, limit int) ([]store.JanitorRun, error)
	UpsertJanitorQuarantine(ctx context.Context, q store.JanitorQuarantine) error
	ListJanitorQuarantine(ctx context.Context, kind string) ([]store.JanitorQuarantine, error)
	DeleteJanitorQuarantine(ctx context.Context, kind, name string) error
	ListPrunableDeployAttempts(ctx context.Context, cutoff time.Time, keep, limit int) ([]store.PrunableAttempt, error)
	DeleteDeployAttempts(ctx context.Context, ids []string) error
	TokenPurger
}

type TokenPurger interface {
	PurgeInactiveAPITokens(ctx context.Context, kind store.TokenPurgeKind, cutoff time.Time, limit int, dryRun bool) (int, error)
}

type TokenWindows struct{ Revoked, Expired int }