Struct ComposeFile 

pub struct ComposeFile {
    pub name: Option<String>,
    pub incus_project: Option<String>,
    pub volumes: BTreeMap<String, NamedVolumeSpec>,
    pub services: BTreeMap<String, SandboxSpec>,
    pub secrets: BTreeMap<String, SecretDef>,
}

A compose file: named volumes plus any number of services, each one sandbox. Mirrors docker compose wherever incus allows.

Fields

name: Option<String>

Project name. Default sandbox names are <name>-<service> and named volumes are <name>_<volume>. Defaults to the directory holding the first compose file.

incus_project: Option<String>

incus project to operate in (default: default).

volumes: BTreeMap<String, NamedVolumeSpec>

Named custom storage volumes, created if missing before any sandbox that uses them. Keys are what services refer to.

services: BTreeMap<String, SandboxSpec>

Sandboxes, keyed by service name.

secrets: BTreeMap<String, SecretDef>

Secrets services can mount as files under /run/secrets. Values are read when the file is deployed and never stored in instance config.

Trait Implementations

impl Clone for ComposeFile

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 ComposeFile

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

Formats the value using the given formatter.

impl Default for ComposeFile

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ComposeFile

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for ComposeFile

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for ComposeFile

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for ComposeFile

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ComposeFile