config

type Auth struct {
	// Callers with one of these roles are admins (allowed all ops) for all requests.
	AdminRoles []string `yaml:"admin_roles"`

	// Strict requires all requests to have ACLs, else callers are denied unless
	// they have an admin role. Strict is disabled by default which, with the default
	// auth plugin, allows all callers (no auth).
	Strict bool `yaml:"strict"`
}

type HTTPClient struct {
	// ServerURL is the base URL of the destination API (e.g. http://IP:port).
	// For development, this is Server.Addr. But for production, each API is
	// usually behind load balancers or some type of NAT, so this is probably
	// the load balancer/gateway address in front of the destination API.
	//
	// The default is the other API default address: DEFAULT_ADDR_REQUEST_MANAGER
	// or DEFAULT_ADDR_JOB_RUNNER.
	ServerURL string `yaml:"url"`

	// TLS specifies certificate, key, and CA files to enable TLS connections
	// to the destination API. The destation API must also be configured to use
	// TLS by specifying Server.TLS.
	//
	// The default is not using TLS.
	TLS `yaml:"tls"`
}

type JobRunner struct {
	Server   Server     `yaml:"server"`    // API addr and TLS
	RMClient HTTPClient `yaml:"rm_client"` // JR to RM internal communication
}

type MySQL struct {
	// DSN is the data source name for connecting to MySQL. See
	// https://github.com/go-sql-driver/mysql#dsn-data-source-name for the
	// full syntax. The "parseTime=true" parameter is automatically appended
	// to the DSN.
	//
	// The DSN must end with "/db" where db is the database name where the
	// Request Manager schema has been loaded. Full privileges should be granted
	// on this database to the MySQL user specified by the DSN.
	//
	// To enable TLS, configure the TLS options, do not use the "tls" DSN parameter.
	//
	// The default is DEFAULT_MYSQL_DSN.
	DSN string `yaml:"dsn"`

	// TLS specifies certificate, key, and CA files to enable TLS connections
	// to MySQL. If enabled, the "tls" DSN parameter is used automatically.
	//
	// The default is no TLS.
	TLS `yaml:"tls"`

	// Path to mysql CLI. This is only used for testing.
	CLIPath string `yaml:"cli_path"`
}

type RequestManager struct {
	Server   Server     `yaml:"server"`    // API addr and TLS
	MySQL    MySQL      `yaml:"mysql"`     // MySQL database
	Specs    Specs      `yaml:"specs"`     // request specs
	Auth     Auth       `yaml:"auth"`      // auth plugin
	JRClient HTTPClient `yaml:"jr_client"` // RM to JR internal communication
}

type Server struct {
	// Addr is the network address ("IP:port") to listen on. For development,
	// this is the address clients connect to. But for production, the API is
	// usually behind load balancers or some type of NAT, so this is only the
	// local bind address.
	//
	// Specify ":port" to listen on all interface for the given port.
	//
	// The default is DEFAULT_ADDR_REQUEST_MANAGER or DEFAULT_ADDR_JOB_RUNNER.
	Addr string `yaml:"addr"`

	// TLS specifies certificate, key, and CA files to enable TLS connections.
	// If enabled, clients must connect using HTTPS.
	//
	// The default is not using TLS.
	TLS TLS `yaml:"tls"`
}

type Specs struct {
	// Directory where all request specs are located. Subdirectories are ignored.
	//
	// The default is DEFAULT_SPECS_DIR.
	Dir string `yaml:"dir"`
}

type TLS struct {
	// The certificate file to use.
	CertFile string `yaml:"cert_file"`

	// The key file to use.
	KeyFile string `yaml:"key_file"`

	// The CA file to use.
	CAFile string `yaml:"ca_file"`
}