setup

type Detected struct {
	Files      []FileSource
	Journald   bool
	Containers []string
	Lokis      []Loki
}

type FileSource struct {
	Name  string
	Paths []string
}

type Loki struct {
	Container, Service, Project string
	Networks                    []string
}

type LokiSource struct {
	URL, User, CACert string
	// Credentials is "ask" or "vault" (with VaultPath).
	Credentials, VaultPath string
	// Selector is "label=value"; empty writes the profile commented out
	// (a Loki source needs at least one label matcher).
	Selector string
	// Network is the Compose network the console joins.
	Network string
}

type Options struct {
	// Root is the project directory (absolute): .locklog/ is created in it.
	Root string
	// Home is the user's home directory, never a project ("" unknown).
	Home string
	// Facts are the host's.
	Facts hostfacts.Facts
	// Production is the answer when set; nil asks (an unanswered question
	// is yes).
	Production *bool
	// Yes takes the default answer of every other question.
	Yes bool
	// Agent is the placement ("" asks; unanswered: container for a
	// production profile, host otherwise).
	Agent string
	// Agents overrides the detected agents (host placement).
	Agents []string
	// Only limits detection to the log files under these directories: no
	// journal, no container (scripted runs that know their logs).
	Only []string
	// Profile is the main profile's name ("" : prod or staging).
	Profile string
	// LokiProxy is the Compose Loki service (or container) to put behind
	// the authenticating proxy; "" asks when one is detected (and Yes
	// skips it).
	LokiProxy string
	// LokiSelector is the Loki source's "label=value" matcher.
	LokiSelector string
	// ProxyBase is the directory, outside the project, that holds the
	// proxies' directories (created 0700).
	ProxyBase string
	// VaultPath stores the proxy's token in Vault (credentials = "vault");
	// empty: the console asks for it.
	VaultPath string
	// Recipe is the own-container recipe's image and agent uid.
	Recipe RecipeOptions
	// In holds the answers; Out is what setup prints. TTY is the human's
	// terminal, the only place the proxy's token is shown (nil: no
	// terminal, and no proxy is generated).
	In  io.Reader
	Out io.Writer
	TTY io.Writer
}

type Plan struct {
	// Profile is the main profile's name; the containers go to
	// Profile-docker (a docker source needs a console of its own), a
	// proxied Loki to Profile-loki (a console on the Compose network).
	Profile    string
	Production bool
	Detected   Detected
	// LokiProxy, when set, is the proxied Loki's source.
	LokiProxy *LokiSource
}

type RecipeOptions struct {
	// Image is the locklog image to copy from: a digest reference
	// (registry@sha256:...) for a release, or a local tag.
	Image string
	// AgentUID is the agent user's uid in its image (default 10052, the
	// locklog image's agent account, which the console already admits).
	AgentUID int
	// Profile is the profile the console serves (for the run lines).
	Profile string
}

type Result struct {
	Profile    string
	Production bool
	Agent      string
	// ConfigWritten is false when a config was already there (kept).
	ConfigWritten bool
	// Proxy is the generated proxy (its Token is shown on TTY only).
	Proxy *authproxy.Result
}