config

Documentation

Index

• type Config
  • func Read(path string) (*Config, error)

Types

type Config

type Config struct {
	// AllowedUsers optionally holds a list of names of users allowed to use
	// the service. An empty list means that all users who can authenticate
	// against the controller are allowed. For external users, names must
	// include the "@external" suffix.
	AllowedUsers []string `yaml:"allowed-users"`
	// DNSName optionally holds the DNS name to use for Let's Encrypt.
	DNSName string `yaml:"dns-name"`
	// ImageName holds the name of the LXD image to use to create containers.
	ImageName string `yaml:"image-name"`
	// JujuAddrs holds the addresses of the current Juju controller.
	JujuAddrs []string `yaml:"juju-addrs"`
	// JujuCert holds the CA certificate that will be used to validate the
	// controller's certificate, in PEM format.
	JujuCert string `yaml:"juju-cert"`
	// LogLevel holds the logging level to use when running the server.
	LogLevel zapcore.Level `yaml:"log-level"`
	// LXDSocketPath holds the path to the LXD unix socket.
	LXDSocketPath string `yaml:"lxd-socket-path"`
	// Port holds the port on which the server will start listening.
	Port int `yaml:"port"`
	// Profiles holds the LXD profiles to use when launching containers.
	Profiles []string `yaml:"profiles"`
	// SessionTimeout holds the number of minutes of inactivity to wait before
	// expiring a session and stopping the container instance. A zero value
	// means that the session never expires.
	SessionTimeout int `yaml:"session-timeout"`
	// TLSCert and TLSKey optionally hold TLS info for running the server.
	TLSCert string `yaml:"tls-cert"`
	TLSKey  string `yaml:"tls-key"`
	// WelcomeMessage optionally holds a message to be displayed when users
	// start the shell session.
	WelcomeMessage string `yaml:"welcome-message"`
}

Config holds the server configuration.

func Read

func Read(path string) (*Config, error)

Read reads the configuration options from a file at the given path.