Struct Config 

pub struct Config {
    pub host: Host,
    pub caches: Caches,
    pub profiles: BTreeMap<String, Profile>,
    pub repositories: Vec<Repository>,
    pub history: History,
    pub records: Records,
    pub sizing: Sizing,
    pub web: Web,
    pub notify: Notify,
}

A parsed runnerd.toml. validate checks it against the host’s budget.

Fields

host: Host

The host’s budget and isolation.

caches: Caches

The caches runners share.

profiles: BTreeMap<String, Profile>

Runner profiles by name.

repositories: Vec<Repository>

The repositories to serve, one pool per entry: a repository named by several entries is served by each of their profiles, a job by the one whose labels match it (ADR 0058).

history: History

What is kept of past jobs.

records: Records

How much the records of failed jobs may keep.

sizing: Sizing

How sizing advice reads the job history.

web: Web

Who may use the dashboard through another address.

notify: Notify

Where the daemon sends notifications; none by default.

Implementations

impl Config

pub fn budget_blocks( &self, admission: AdmissionPolicy, ) -> Option<Vec<BudgetBlock>>

What admission holds to MemoryMax, a block per profile: under caps, every slot of each profile at its cap; under measured, one runner of the largest profile. The mirror with either. None when the caps overflow, as Config::memory_caps refuses them.

pub fn check_against(&self, memory_max: Option<ByteSize>) -> ConfigCheck

Validates the parsed config against memory_max, the slice’s MemoryMax: what Config::check answers once the text parses and the slice is read, and what doctor checks the config the daemon runs with by.

impl Config

pub fn load(path: &Path) -> Result<Config, ConfigError>

Reads and parses a config file.

pub fn parse(text: &str) -> Result<Config, ConfigError>

Parses a config from TOML text.

pub fn check( text: &str, memory_max: impl FnOnce(&str) -> Result<Option<ByteSize>>, ) -> (Option<Config>, ConfigCheck)

Parses text and validates it against the MemoryMax that memory_max reads for the slice it names: what runnerd check-config prints and POST /v1/config/check answers. Returns the config if it is valid.

pub fn mirror_memory(&self) -> u64

The mirror’s memory cap, 0 when it is disabled.

pub fn memory_caps(&self) -> Result<ByteSize, ConfigError>

The memory every runner and the mirror may use at once.

pub fn memory_needed(&self) -> Result<ByteSize, ConfigError>

The memory [host] admission must fit in MemoryMax: every cap at once under caps; under measured, the largest single runner with the mirror, since slots there only bounds how many run at once.

pub fn pool(&self, repository: &str, labels: &[String]) -> Option<&Repository>

The pool of repository whose labels match a job asking for labels: every label it asks for is one of the pool’s. None when no pool of it does.

pub fn pool_in(&self, repository: &str, profile: &str) -> Option<&Repository>

The pool of repository in profile, whose runners start in that profile’s slots.

pub fn repository_names(&self) -> Vec<String>

The repositories served, each once, in the order the config first names them.

pub fn validate( &self, memory_max: Option<ByteSize>, ) -> Result<Vec<Warning>, ConfigError>

Checks the config against the slice’s MemoryMax (None when the slice is unlimited).

Trait Implementations

impl Debug for Config

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Config

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.