canic-core 0.101.19

Canic — a canister orchestration and management toolkit for the Internet Computer
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52

//! Module: config::schema::component_group
//!
//! Responsibility: define strict checked-in Component Group declarations.
//! Does not own: graph compilation, deployments, placement, purpose, or runtime state.
//! Boundary: TOML input is decoded into bounded identifier-keyed maps before compilation.

use crate::{
    config::{
        ComponentDeploymentLabelKey, ComponentDeploymentLabelValue, FleetServiceMemberPurpose,
    },
    ids::{ComponentGroupMemberId, ComponentGroupSpecId, ComponentSpecId, FleetServiceId},
};
use std::collections::BTreeMap;

use serde::{Deserialize, Serialize};

/// Reusable configuration-only composition of Components and included groups.
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
#[serde(deny_unknown_fields)]
pub struct ComponentGroupSpecConfig {
    #[serde(default)]
    pub components: BTreeMap<ComponentGroupMemberId, ComponentGroupComponentConfig>,

    #[serde(default)]
    pub groups: BTreeMap<ComponentGroupMemberId, ComponentGroupIncludeConfig>,
}

/// One direct Component occurrence declared inside a Component Group.
#[derive(Clone, Debug, Deserialize, Serialize)]
#[serde(deny_unknown_fields)]
pub struct ComponentGroupComponentConfig {
    pub component_spec: ComponentSpecId,

    pub service: Option<FleetServiceId>,

    pub service_purpose: Option<FleetServiceMemberPurpose>,

    #[serde(default)]
    pub labels: BTreeMap<ComponentDeploymentLabelKey, ComponentDeploymentLabelValue>,
}

/// One configuration-only inclusion edge to another Component Group.
#[derive(Clone, Debug, Deserialize, Serialize)]
#[serde(deny_unknown_fields)]
pub struct ComponentGroupIncludeConfig {
    pub component_group: ComponentGroupSpecId,

    pub service_purpose: Option<FleetServiceMemberPurpose>,

    #[serde(default)]
    pub labels: BTreeMap<ComponentDeploymentLabelKey, ComponentDeploymentLabelValue>,
}