stack

type APICheck struct {
	URL        string `json:"url"`
	OK         bool   `json:"ok"`
	StatusCode int    `json:"statusCode,omitempty"`
	Error      string `json:"error,omitempty"`
}

type BackupFile struct {
	Name   string `json:"name"`
	Size   int64  `json:"size"`
	SHA256 string `json:"sha256"`
}

type BackupResult struct {
	Path     string   `json:"path"`
	Manifest Manifest `json:"manifest"`
}

type CleanResult struct {
	Workspace string `json:"workspace"`
	// DataFolder is set with storage bind: Clean does not delete it.
	DataFolder string `json:"dataFolder,omitempty"`
}

type DownResult struct {
	Workspace   string `json:"workspace"`
	DataRemoved bool   `json:"dataRemoved"`
}

type Endpoint struct {
	Name string `json:"name"`
	URL  string `json:"url"`
}

type Env struct {
	Compose compose.Exec
	Doctor  func() doctor.Env
	// CheckAPI calls the OpenArch health endpoint of a workspace.
	CheckAPI func(ctx context.Context, dir string, cfg workspace.Config) APICheck
}

type LogLine struct {
	Service   string `json:"service"`
	Container string `json:"container"`
	Text      string `json:"text"`
}

type LogsOptions struct {
	Services []string
	Follow   bool
	Tail     string
	Since    string
	// Stream receives the log lines as text. When nil, Logs returns them parsed.
	Stream io.Writer
	Stderr io.Writer
}

type LogsResult struct {
	Lines []LogLine `json:"lines"`
}

type Manifest struct {
	Format           int          `json:"format"`
	Created          time.Time    `json:"created"`
	Workspace        string       `json:"workspace"`
	OpenArchVersion  string       `json:"openarchVersion"`
	InsecureBackends bool         `json:"insecureBackends,omitempty"`
	Files            []BackupFile `json:"files"`
}

type RestoreResult struct {
	Backup   string   `json:"backup"`
	Manifest Manifest `json:"manifest"`
	Status   Status   `json:"status"`
}

type RotateResult struct {
	Workspace string       `json:"workspace"`
	Rotated   []string     `json:"rotated"`
	Skipped   []RotateSkip `json:"skipped,omitempty"`
	// Applied is false when the stack was not running: the new passwords apply at the next 'openarch up'.
	Applied bool    `json:"applied"`
	Status  *Status `json:"status,omitempty"`
}

type RotateSkip struct {
	Target string `json:"target"`
	Reason string `json:"reason"`
}

type ServiceStatus struct {
	Name string `json:"name"`
	// State is the container state from Docker (running, exited, ...), or "missing".
	State string `json:"state"`
	// Health is the Docker healthcheck result (healthy, starting, unhealthy), or "" when the service has none.
	Health   string `json:"health,omitempty"`
	ExitCode int    `json:"exitCode"`
	OneShot  bool   `json:"oneShot"`
	Ports    []int  `json:"ports,omitempty"`
	// OK reports whether this service is in its expected final state.
	OK bool `json:"ok"`
}

type Status struct {
	Workspace string          `json:"workspace"`
	State     string          `json:"state"`
	Services  []ServiceStatus `json:"services"`
	API       *APICheck       `json:"api,omitempty"`
	Endpoints []Endpoint      `json:"endpoints"`
	AdminUser string          `json:"adminUser,omitempty"`
	// Command is the CLI command that produced the status, for the text form.
	Command string `json:"-"`
}

type UpOptions struct {
	SkipDoctor bool
	Wait       bool
	Timeout    time.Duration
	// Progress receives the output of docker compose.
	Progress io.Writer
}

type UpgradePlan struct {
	Workspace string   `json:"workspace"`
	From      string   `json:"from"`
	To        string   `json:"to"`
	Steps     []string `json:"steps"`
	// Downgrade is true when To is an older version than From.
	Downgrade bool `json:"downgrade"`
}

type Workspace struct {
	Dir     string
	Config  workspace.Config
	Secrets localenv.Env
}