config

type Agent struct {
	// Hub is the address of the hub's agent listener, "host:port".
	Hub string `yaml:"hub"`
	// Token is the one-time enrollment token. It is only needed the first
	// time; once the agent is enrolled it is ignored.
	Token string `yaml:"token"`
	// CAFingerprint is the fingerprint of the hub's CA, shown with the token.
	// The agent only trusts a hub that has this CA.
	CAFingerprint string `yaml:"ca_fingerprint"`
	// DataDir holds the agent's key and certificates.
	DataDir string `yaml:"data_dir"`
	Log     Log    `yaml:"log"`
	// Updates lets the hub update this agent: the agent fetches the release the
	// hub offers and leaves it to the installer unit that runs as root
	// (regulus-agent-update.path, enabled by the installer). On its own the
	// setting does nothing.
	Updates bool `yaml:"updates"`
	// EnrollOnly enrolls and exits without connecting. The installer uses it
	// to enroll as the service user before the service starts. Command line
	// only.
	EnrollOnly bool `yaml:"-"`
}

type Config struct {
	// Listen is the address the HTTP server listens on.
	Listen string `yaml:"listen"`
	// AgentListen is the address where remote agents connect (gRPC over TLS
	// with client certificates). Empty keeps remote agents off: only the
	// built-in agent can then connect.
	AgentListen string `yaml:"agent_listen"`
	// DataDir is the directory where the hub stores its database.
	DataDir string `yaml:"data_dir"`
	// BuiltinAgent runs an agent inside the hub, so the hub's own server is
	// managed like any other.
	BuiltinAgent bool `yaml:"builtin_agent"`
	// MetricsInterval is how often agents report their metrics to the hub.
	MetricsInterval time.Duration `yaml:"metrics_interval"`
	Log             Log           `yaml:"log"`
	Console         Console       `yaml:"console"`
	Updates         Updates       `yaml:"updates"`
}

type Console struct {
	// TUI turns the full-screen console on. When false, `regulus` prints the
	// same information as plain text.
	TUI bool `yaml:"tui"`
}

type Entry struct {
	Setting
	Value  string
	Origin string
}

type Log struct {
	// Level is one of debug, info, warn, error.
	Level string `yaml:"level"`
	// Format is one of text, json.
	Format string `yaml:"format"`
}

type Setting struct {
	// Key is the dotted YAML path, such as log.level.
	Key string
	// Env is the environment variable that overrides it, if any.
	Env         string
	Description string
	// Choices lists the accepted values when there is a fixed set.
	Choices []string
	// Restart is true when the hub reads the setting only at start.
	Restart bool
	// contains filtered or unexported fields
}

type Updates struct {
	// Check lets the hub ask GitHub for new releases every few hours. Turn it
	// off on a hub that must not contact the internet.
	Check bool `yaml:"check"`
	// Apply lets the hub ask for a downloaded release to be installed, by the
	// root-owned helper that systemd starts (regulus-update.path). The
	// installer turns it on together with that unit; without the unit nothing
	// would pick the request up.
	Apply bool `yaml:"apply"`
}