canic-core 0.101.15

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
53
54
55
56
57
58

//! Module: config::schema::fleet_service
//!
//! Responsibility: define strict checked-in Fleet-service target declarations.
//! Does not own: occurrence resolution, placement assignment, publication, or runtime state.
//! Boundary: source targets name logical service topology without physical roots or Canisters.

use crate::ids::{
    CanisterRole, ComponentGroupDeploymentId, ComponentGroupMemberPath, ComponentSpecId,
    FleetServiceId,
};
use std::collections::BTreeMap;

use serde::{Deserialize, Serialize};

/// Top-level namespace for application service declarations.
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
#[serde(deny_unknown_fields)]
pub struct ServicesConfig {
    #[serde(default)]
    pub fleet: FleetServicesConfig,
}

/// Fleet-wide logical service targets in canonical service-ID key space.
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
#[serde(deny_unknown_fields)]
pub struct FleetServicesConfig {
    #[serde(default)]
    pub targets: BTreeMap<FleetServiceId, FleetServiceTargetConfig>,
}

/// Strict source declaration for one Fleet service and its mode.
#[derive(Clone, Debug, Deserialize, Serialize)]
#[serde(tag = "mode", deny_unknown_fields)]
pub enum FleetServiceTargetConfig {
    #[serde(rename = "authority_replica")]
    AuthorityReplica {
        role: CanisterRole,
        component_spec: ComponentSpecId,
        authority_deployment: ComponentGroupDeploymentId,
        authority_member: ComponentGroupMemberPath,
        placement: FleetServicePlacementPolicyConfig,
    },

    #[serde(rename = "active_pool")]
    ActivePool {
        role: CanisterRole,
        component_spec: ComponentSpecId,
        placement: FleetServicePlacementPolicyConfig,
    },
}

/// Source density and spread envelope shared by all members of one service.
#[derive(Clone, Debug, Deserialize, Serialize)]
#[serde(deny_unknown_fields)]
pub struct FleetServicePlacementPolicyConfig {
    pub maximum_members_per_root: u32,
    pub minimum_distinct_roots: u32,
}