config

type APIConfig struct {
	Bind       string     `yaml:"bind"`           // bind address:port for api to listen
	Broker     BrokerConn `yaml:"broker"`         // config to reach server
	Prometheus bool       `yaml:"export_metrics"` // enable /metrics endpoint
	Pprof      bool       `yaml:"pprof"`          // Wether to expose pprof endpoints
}

type BrokerConfig struct {
	ServiceConfig  `yaml:"service"`
	Expiry         time.Duration      `yaml:"expiry"`            // max unused time for envs
	SharedPath     string             `yaml:"shared_path"`       // path where tmp directories are created, default `$TMPDIR` or `/tmp`
	Backup         ReplicaConfig      `yaml:"backup"`            // replica configuration
	ProcMountpoint string             `yaml:"procfs_mountpoint"` // (deprecated value) procfs mountpoint
	ID             string             `yaml:"id"`                // broker ID
	Load           LoadFactorConfig   `yaml:"load"`              // type of load factor calculation method
	Limits         BrokerLimitsConfig `yaml:"limits"`            // limits config
}

type BrokerConn struct {
	Server     string                `yaml:"address"` // url for broker server
	Encryption BrokerTransportConfig `yaml:"mtls"`    // transport encryption for api <> broker
}

type BrokerLimitsConfig struct {
	Expiry             time.Duration `yaml:"expiry"`           // max unused time for envs
	MaxConcurrentTasks uint          `yaml:"concurrent_tasks"` // max number of concurrent async tasks
}

type BrokerTransportConfig struct {
	TransportConfig
	ServerName string `yaml:"server_name"` // server name for certificate validation
}

type Config struct {
	Roles       []ISMRole         `yaml:"roles"`       // roles that should be run by this instance
	Monitoring  MonitoringConfig  `yaml:"monitoring"`  // config for the prometheus endpoint of the broker, formerly known as agent
	Coordinator CoordinatorConfig `yaml:"coordinator"` // config for coordinator
	Isabelle    IsabelleConfig    `yaml:"isabelle"`    // config for the isabelle servers run by the executors
	Executor    ExecutorConfig    `yaml:"executor"`    // config for the executors
	API         APIConfig         `yaml:"api"`         // config for the experimental api
	Otel        OtelConfig        `yaml:"otel"`        // configuration for otel
	Broker      BrokerConfig      `yaml:"broker"`      // configuration for broker
	Logging     LoggingConfig     `yaml:"logging"`     // configuration for logging output/level
}

type ConsoleExporterConfig struct {
	Pretty      bool   `yaml:"pretty"`      // whether to pretty print the output
	Destination string `yaml:"destination"` // either "stdin", "stderr" or file path
}

type ContainerConfig struct {
	Image    string `yaml:"image"`               // image alias
	ID       string `yaml:"id,omitempty"`        // isabelle version id in image
	Version  string `yaml:"version,omitempty"`   // isabelle version in image
	Default  bool   `yaml:"default,omitempty"`   // wether this is the default container
	SkipPull bool   `yaml:"skip_pull,omitempty"` // wether to skip the container pull, useful if already in local registry or offline
}

type CoordinatorConfig struct {
	ServiceConfig              `yaml:"service"`            // config for gRPC server
	keepalive.ClientParameters `yaml:"upstream_keepalive"` // config for client keepalive
	Upstreams                  map[string]*BrokerConn      `yaml:"upstreams"`                 // List of upstreams
	Timeouts                   TimeoutConfig               `yaml:"timeout"`                   // timeout configuration, also defined retries etc.
	TickerInterval             int64                       `yaml:"ticker_interval,omitempty"` // Ticker Interval in ms, default 5s
	Encryption                 TransportConfig             `yaml:"mtls"`                      // transport encryption for broker gRPC
}

type DockerConfig struct {
	Enable           bool                       `yaml:"enable,omitempty"`            // Wether to enable the executor
	Name             string                     `yaml:"name"`                        // Name of host container
	Containers       map[string]ContainerConfig `yaml:"containers"`                  // list of container variants
	Prefix           string                     `yaml:"prefix,omitempty"`            // prefix for containers and networks
	NetworkIsolation bool                       `yaml:"network_isolation,omitempty"` // wether to manage networks
	Mode             DockerExecutorMode         `yaml:"operation_mode,omitempty"`
	SpareNetworks    int                        `yaml:"spare_networks,omitempty"` // number of spare networks

}

type DockerExecutorMode = string

type EndpointConfig struct {
	AddrPort string `yaml:"host"`     // host:port of endpoint
	Insecure bool   `yaml:"insecure"` // whether to use http
	Path     string `yaml:"path"`     // path of endpoint
}

type ExecutorConfig struct {
	Local  *LocalConfig  `yaml:"local,omitempty"`  // config for local executor
	Docker *DockerConfig `yaml:"docker,omitempty"` // config for the docker executor
}

type HTTPExporterConfig struct {
	Compression string                     `yaml:"compression"` // compression type, enum of ("", "gzip")
	Endpoint    EndpointConfig             `yaml:"endpoint"`    // otlp endpoint
	Retry       *otlptracehttp.RetryConfig `yaml:"retry"`       // retry config
}

type ISMRole = string

type IsabelleConfig struct {
	ToolOptions                 string        `yaml:"java_options"`                          // ISABELLE_TOOL_JAVA_OPTIONS
	MaxConnections              int32         `yaml:"max_connections"`                       // Allowed clients per instance
	Mounts                      []string      `yaml:"shared_directories"`                    // directories made available to all clients
	Timeouts                    TimeoutConfig `yaml:"timeouts"`                              // timeouts for various actions
	MaxOperations               uint32        `yaml:"max_operations"`                        // maximum amount of operations to perform on a server before recycling it
	MaxTime                     int64         `yaml:"max_lifetime"`                          // maximum amount of time in seconds a server may be alive
	OperationFailureRate        float32       `yaml:"operation_failure_rate"`                // failure rate of operations in window until a server is declared unhealthy
	OperationFailureRateWindow  int64         `yaml:"operation_failure_rate_window_seconds"` // window for `OperationFailureRate` in seconds
	OperationFailureRateMinimum uint          `yaml:"operation_failure_rate_window_minimum"` // minimum amount of operations in window to check the failure rate
	MaxRAM                      int64         `yaml:"max_memory_reservation"`                // soft limit on memory consumption per server instance
}

type LoadFactorConfig struct {
	Method         LoadMethod `yaml:"method"`            // selected load factor source
	StaticValue    uint32     `yaml:"value"`             // static value, only relevant if method == `static`
	ProcMountpoint string     `yaml:"procfs_mountpoint"` // procfs mountpoint
}

type LoadMethod = string

type LocalConfig struct {
	Enable     bool       `yaml:"enable,omitempty"`     // Wether to enable the executor
	Executable string     `yaml:"executable,omitempty"` // Path to patched isabelle binary
	Ports      []uint16   `yaml:"ports"`                // range of ports used by server
	Pipe       PipeConfig `yaml:"pipe,omitempty"`       // wether to pipe stdout/stderr into debug logs after startup
}

type LoggingConfig struct {
	Output string `yaml:"destination"`
	Level  string `yaml:"level"`
}

type MonitoringConfig struct {
	Enable          bool          `yaml:"enable,omitempty"`          // enable listener for prometheus server
	Bind            string        `yaml:"bind,omitempty"`            // bind address:port for monitoring endpoint
	Pprof           bool          `yaml:"pprof"`                     // Wether to expose pprof endpoints
	TickerInterval  int64         `yaml:"ticker_interval,omitempty"` // Ticker Interval in ms, default 5s
	ShutdownTimeout time.Duration `yaml:"shutdown_timeout"`          // Timeout for shutdown of HTTP server
}

type OtelConfig struct {
	Exporter string                `yaml:"exporter"`  // exporter enum for traces (console, otlp)
	ID       string                `yaml:"id"`        // user id (instance id) for traces
	Sampling OtelSamplingConfig    `yaml:"sampling"`  // local sampling rules for traces
	Console  ConsoleExporterConfig `yaml:"console"`   // config for console trace exporter, only relevant if exporter == "console"
	HTTP     HTTPExporterConfig    `yaml:"otlp-http"` // config for otlp HTTP exporter, only relevant if exporter == "otlp-http"
}

type OtelDropSamplingConfig struct {
	Enable bool     `yaml:"enable"` // enable dropping spans by exact name
	Names  []string `yaml:"names"`  // span names or gRPC full method names to drop
}

type OtelExporter = string

type OtelSamplingConfig struct {
	Drop OtelDropSamplingConfig `yaml:"drop"` // spans to drop before export
}

type PipeConfig struct {
	Enable   bool   `yaml:"enable,omitempty"`  // wether to enable server output pipes
	Capture  string `yaml:"capture,omitempty"` // wether to capture "stdout", "stderr" or "both"
	LogLevel string `yaml:"level,omitempty"`   // output log level
}

type ReplicaConfig struct {
	Enable      bool   `yaml:"enable"`      // whether to maintain a replica server
	Consistency string `yaml:"consistency"` // consistency mode to use, either `strict` or `eventual`
}

type ServiceConfig struct {
	keepalive.ServerParameters  `yaml:"keepalive"`
	keepalive.EnforcementPolicy `yaml:"keepalive_limits"`
	MaxMessageSize              int             `yaml:"message_size"` // max message size in bytes allowed for a single gRPC message
	Bind                        string          `yaml:"bind"`         // Address to bind to
	Reflection                  bool            `yaml:"reflection"`   // enable grpc reflection
	Channelz                    bool            `yaml:"channelz"`     // enable channelz
	Encryption                  TransportConfig `yaml:"mtls"`         // transport encryption
}

type TimeoutConfig struct {
	Connection time.Duration `yaml:"connection"` // timeout for initial connection
	Session    time.Duration `yaml:"session"`    // timeout for creation of new sessions
	Request    time.Duration `yaml:"request"`    // total request timeout
	Shutdown   time.Duration `yaml:"shutdown"`   // graceful shutdown timeout
	Retries    uint          `yaml:"retries"`    // retries for connection
}

type TransportConfig struct {
	Enable      bool   `yaml:"enable,omitempty"` // enable [mTLS](https://www.cloudflare.com/learning/access-management/what-is-mutual-tls/)
	Certificate string `yaml:"certificate"`      // service certificate
	Key         string `yaml:"key"`              // service key
	CA          string `yaml:"ca"`               // ca certificate
}