Struct ServiceConfig 

pub struct ServiceConfig {
    pub schema_version: u32,
    pub name: String,
    pub description: Option<String>,
    pub address: ServiceAddress,
    pub components: Vec<ServiceComponent>,
    pub db: DbCatalog,
}

An operator-facing service declaration from .yah/services/<svc>/service.toml.

A service groups one or more components (a static surface, a containerized API, an almanac…) under a single address. Mirrors project the service onto concrete infra; see MirrorConfig.

Fields

schema_version: u32

name: String

description: Option<String>

One-line operator-facing answer to “what is this and why does the camp run it?”, rendered beside the service wherever it is listed.

New surface in R926, and it exists because the registry had no place to say what a service IS. A name and a domain identify a service to someone who already knows the fleet; they tell a reader who does not nothing at all, so the knowledge lived in whichever working doc or board annotation last touched the thing. That is exactly the knowledge a health check makes actionable — a red cell is only useful next to what went red.

Deliberately not a free-form [meta] table: one field with one meaning cannot accumulate a second half-owner, which is the failure the headscale appliance already demonstrated four times over (see this repo’s CLAUDE.md on giving a thing ONE owner).

Optional, because nine services predate it and a required field would make every one of them fail to load. None renders as no description rather than as an empty one.

address: ServiceAddress

How this service is reached, and therefore how its liveness is probed. See ServiceAddress.

components: Vec<ServiceComponent>

db: DbCatalog

Databases this service exposes, grouped by environment (W241). Every entry becomes a data-workbench / sql_* catalog id of the shape <env>:<service>:<name> (e.g. pond:scrabcake:main). Optional and default-empty — services without databases omit the [db] table entirely.

Implementations

impl ServiceConfig

pub fn domain(&self) -> Option<&str>

The service’s domain, or None when it is node-addressed (R926-F1). Callers that cannot proceed without one must say which service and why — see ServiceAddress::domain.

pub fn require_domain(&self, wanted_for: &str) -> Result<&str>

The domain, or an error naming this service and what the caller wanted it for. The shape every yah cloud apply reader wants: a node-addressed service is not deployed by the reconcilers at all, so reaching one of them with a Node address is a config bug and deserves a sentence, not an unwrap.

pub fn health_path(&self) -> Option<&str>

pub fn load(path: &Path) -> Result<Self>

Parse a single services/<svc>/service.toml file.

pub fn save(&self, workspace_root: &Path) -> Result<()>

Persist to .yah/services/<name>/service.toml, creating the service directory if needed. Create-or-overwrite — the canonical replacement for the legacy sites.json write path. workspace_root is the camp dir (the parent of .yah/).

pub fn delete(workspace_root: &Path, name: &str) -> Result<bool>

Remove .yah/services/<name>/ and everything under it (service.toml plus its mirrors/). Returns false when the directory was already absent, so callers can distinguish “deleted” from “no-op”.

Trait Implementations

impl Clone for ServiceConfig

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ServiceConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ServiceConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ServiceConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.