canic-backup 0.68.22

Manifest and orchestration primitives for Canic deployment backup and restore
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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199

//! Module: manifest::types
//!
//! Responsibility: define serialized backup manifest data contracts.
//! Does not own: validation, discovery, snapshot capture, or restore actions.
//! Boundary: stable JSON shapes shared by backup creation and restore flows.

use serde::{Deserialize, Serialize};

///
/// DeploymentBackupManifest
///
/// Top-level deployment backup manifest persisted with a backup bundle.
/// Owned by backup manifest contracts and consumed by restore planning.
///

#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct DeploymentBackupManifest {
    pub manifest_version: u16,
    pub backup_id: String,
    pub created_at: String,
    pub tool: ToolMetadata,
    pub source: SourceMetadata,
    pub consistency: ConsistencySection,
    pub deployment: DeploymentSection,
    pub verification: VerificationPlan,
}

///
/// ToolMetadata
///
/// Tool identity recorded with one generated backup manifest.
/// Owned by backup manifest contracts and written during backup creation.
///

#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct ToolMetadata {
    pub name: String,
    pub version: String,
}

///
/// SourceMetadata
///
/// Source environment identity recorded for a backup bundle.
/// Owned by backup manifest contracts and used by restore validation.
///

#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct SourceMetadata {
    pub environment: String,
    pub root_canister: String,
}

///
/// ConsistencySection
///
/// Backup unit grouping used to validate deployment consistency.
/// Owned by backup manifest contracts and checked before restore planning.
///

#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct ConsistencySection {
    pub backup_units: Vec<BackupUnit>,
}

///
/// BackupUnit
///
/// Role grouping that must be captured and restored as one consistency unit.
/// Owned by backup manifest contracts and validated against deployment roles.
///

#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct BackupUnit {
    pub unit_id: String,
    pub kind: BackupUnitKind,
    pub roles: Vec<String>,
}

///
/// BackupUnitKind
///
/// Consistency grouping mode for a backup unit.
/// Owned by backup manifest contracts and interpreted by validators.
///

#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
#[serde(rename_all = "kebab-case")]
pub enum BackupUnitKind {
    Single,
    Subtree,
}

///
/// DeploymentSection
///
/// Captured deployment topology and member list for one backup.
/// Owned by backup manifest contracts and consumed by restore planning.
///

#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct DeploymentSection {
    pub topology_hash_algorithm: String,
    pub topology_hash_input: String,
    pub discovery_topology_hash: String,
    pub pre_snapshot_topology_hash: String,
    pub topology_hash: String,
    pub members: Vec<DeploymentMember>,
}

///
/// DeploymentMember
///
/// One canister member captured in a deployment backup manifest.
/// Owned by backup manifest contracts and mapped into restore plan members.
///

#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct DeploymentMember {
    pub role: String,
    pub canister_id: String,
    pub parent_canister_id: Option<String>,
    pub subnet_canister_id: Option<String>,
    pub controller_hint: Option<String>,
    pub identity_mode: IdentityMode,
    pub verification_checks: Vec<VerificationCheck>,
    pub source_snapshot: SourceSnapshot,
}

///
/// IdentityMode
///
/// Restore identity policy for one deployment member.
/// Owned by backup manifest contracts and enforced during restore planning.
///

#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
#[serde(rename_all = "kebab-case")]
pub enum IdentityMode {
    Fixed,
    Relocatable,
}

///
/// SourceSnapshot
///
/// Snapshot artifact metadata for one deployment member.
/// Owned by backup manifest contracts and validated before restore execution.
///

#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
pub struct SourceSnapshot {
    pub snapshot_id: String,
    pub module_hash: Option<String>,
    pub code_version: Option<String>,
    pub artifact_path: String,
    pub checksum_algorithm: String,
    #[serde(default)]
    pub checksum: Option<String>,
}

///
/// VerificationPlan
///
/// Deployment and member verification checks required for a backup bundle.
/// Owned by backup manifest contracts and consumed by restore validation.
///

#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct VerificationPlan {
    pub deployment_checks: Vec<VerificationCheck>,
    pub member_checks: Vec<MemberVerificationChecks>,
}

///
/// MemberVerificationChecks
///
/// Verification checks scoped to one deployment role.
/// Owned by backup manifest contracts and validated against deployment members.
///

#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct MemberVerificationChecks {
    pub role: String,
    pub checks: Vec<VerificationCheck>,
}

///
/// VerificationCheck
///
/// Named verification check and the deployment roles it covers.
/// Owned by backup manifest contracts and interpreted by validators.
///

#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
pub struct VerificationCheck {
    pub kind: String,
    pub roles: Vec<String>,
}