canic-host 0.70.10

Host-side build, install, deployment, and fleet-template library for Canic workspaces
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

use super::super::{CanisterControlClassV1, DeploymentCheckV1};
use super::authority::LifecycleVerificationRequirementV1;
use super::proposal::{
    ExternalUpgradeProposalV1, ExternalUpgradeReceiptV1, ExternalUpgradeVerificationResultV1,
};
use serde::{Deserialize, Serialize};

///
/// ExternalUpgradeVerificationReportV1
///
#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
pub struct ExternalUpgradeVerificationReportV1 {
    pub schema_version: u32,
    pub report_id: String,
    pub report_digest: String,
    pub proposal_id: String,
    pub proposal_digest: String,
    pub receipt_id: String,
    pub receipt_digest: String,
    pub subject: String,
    pub canister_id: Option<String>,
    pub role: Option<String>,
    pub verification_result: ExternalUpgradeVerificationResultV1,
    pub verification_notes: Vec<String>,
    pub live_inventory_required: bool,
    pub status_summary: String,
}

///
/// ExternalUpgradeVerificationReportRequest
///
#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
pub struct ExternalUpgradeVerificationReportRequest {
    pub report_id: String,
    pub proposal: ExternalUpgradeProposalV1,
    pub receipt: ExternalUpgradeReceiptV1,
}

///
/// ExternalUpgradeVerificationPolicyV1
///
#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
pub struct ExternalUpgradeVerificationPolicyV1 {
    pub schema_version: u32,
    pub policy_id: String,
    pub policy_digest: String,
    pub proposal_id: String,
    pub proposal_digest: String,
    pub deployment_plan_id: String,
    pub deployment_plan_digest: String,
    pub subject: String,
    pub canister_id: Option<String>,
    pub role: Option<String>,
    pub required_verification: Vec<LifecycleVerificationRequirementV1>,
    pub verification_requirements: Vec<ExternalUpgradeVerificationPolicyRequirementV1>,
    pub max_observation_age_seconds: Option<u64>,
    pub status_summary: String,
}

///
/// ExternalUpgradeVerificationPolicyRequirementV1
///
#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
pub struct ExternalUpgradeVerificationPolicyRequirementV1 {
    pub requirement: LifecycleVerificationRequirementV1,
    pub status: ExternalUpgradeVerificationRequirementStatusV1,
    pub expected_value: Option<String>,
}

///
/// ExternalUpgradeVerificationRequirementStatusV1
///
#[derive(Clone, Copy, Debug, Deserialize, Eq, Ord, PartialEq, PartialOrd, Serialize)]
pub enum ExternalUpgradeVerificationRequirementStatusV1 {
    Required,
    NotRequired,
}

///
/// ExternalUpgradeVerificationPolicyRequest
///
#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
pub struct ExternalUpgradeVerificationPolicyRequest {
    pub policy_id: String,
    pub proposal: ExternalUpgradeProposalV1,
}

///
/// ExternalUpgradeVerificationObservationV1
///
#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
pub struct ExternalUpgradeVerificationObservationV1 {
    pub source: ExternalVerificationObservationSourceV1,
    pub deployment_check_id: Option<String>,
    pub deployment_check_digest: Option<String>,
    pub inventory_id: Option<String>,
    pub observed_at: Option<String>,
    pub live_inventory_observed: bool,
    pub controller_observation_present: bool,
    pub observed_control_class: Option<CanisterControlClassV1>,
    pub observed_module_hash: Option<String>,
    pub observed_canonical_embedded_config_sha256: Option<String>,
    pub protected_call_ready: Option<bool>,
}

///
/// ExternalVerificationObservationSourceV1
///
#[derive(Clone, Copy, Debug, Deserialize, Eq, Ord, PartialEq, PartialOrd, Serialize)]
pub enum ExternalVerificationObservationSourceV1 {
    SuppliedObservation,
    DeploymentTruthInventory,
}

///
/// ExternalUpgradeVerificationCheckV1
///
#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
pub struct ExternalUpgradeVerificationCheckV1 {
    pub schema_version: u32,
    pub check_id: String,
    pub check_digest: String,
    pub policy_id: String,
    pub policy_digest: String,
    pub proposal_id: String,
    pub proposal_digest: String,
    pub subject: String,
    pub canister_id: Option<String>,
    pub role: Option<String>,
    pub observation: ExternalUpgradeVerificationObservationV1,
    pub requirement_results: Vec<ExternalUpgradeVerificationCheckRequirementV1>,
    pub verification_result: ExternalUpgradeVerificationResultV1,
    pub status_summary: String,
}

///
/// ExternalUpgradeVerificationCheckRequirementV1
///
#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
pub struct ExternalUpgradeVerificationCheckRequirementV1 {
    pub requirement: LifecycleVerificationRequirementV1,
    pub status: ExternalUpgradeVerificationRequirementStatusV1,
    pub expected_value: Option<String>,
    pub observed_value: Option<String>,
    pub satisfied: Option<bool>,
}

///
/// ExternalUpgradeVerificationCheckRequest
///
#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
pub struct ExternalUpgradeVerificationCheckRequest {
    pub check_id: String,
    pub policy: ExternalUpgradeVerificationPolicyV1,
    pub observation: Option<ExternalUpgradeVerificationObservationV1>,
    pub deployment_check: Option<DeploymentCheckV1>,
}