canic-host 0.110.35

Host-side App build and desired-state Fleet reconciliation 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

//! Module: fleet_ensure::dto::progress
//!
//! Responsibility: describe bounded operator-visible Fleet convergence progress.
//! Does not own: authority, persistence, decisions, or effects.
//! Boundary: progress is informational; the retained journal owns completion.

use crate::fleet_ensure::model::FleetEnsureSuccessorReviewReason;
use serde::Serialize;

/// Named phase currently being advanced or verified by Fleet Ensure.
#[derive(Clone, Copy, Debug, Eq, PartialEq, Serialize)]
#[serde(rename_all = "snake_case")]
pub enum FleetEnsurePhase {
    Infrastructure,
    ImportReconciliation,
    ControlPlane,
    WorkloadProvisioning,
    PoolReadiness,
    TerminalVerification,
    Complete,
}

/// Whether the named phase is advancing, waiting or requires operator action.
#[derive(Clone, Debug, Eq, PartialEq, Serialize)]
#[serde(tag = "kind", rename_all = "snake_case")]
pub enum FleetEnsureProgressState {
    Advancing,
    AwaitingProgress {
        /// Time spent awaiting this effect or terminal check in this invocation.
        elapsed_seconds: u64,
        provisioning: Option<FleetProvisioningProgress>,
    },
    PrerequisiteComplete,
    FundingRequired,
    ReviewRequired {
        reason: FleetEnsureSuccessorReviewReason,
        review: Option<Box<crate::fleet_ensure::model::FleetSuccessorReview>>,
    },
    Complete,
}

/// Bounded informational projection of the existing Coordinator observation.
/// Counts describe Roots, not individual Component activation or funding authority.
#[derive(Clone, Debug, Eq, PartialEq, Serialize)]
pub struct FleetProvisioningProgress {
    /// Latest retryable Root failure from this observation, not a new retry decision.
    pub pending_root_failure:
        Option<canic_core::dto::component_provisioning::FleetComponentProvisioningRootFailure>,
    pub phase: canic_core::dto::component_provisioning::FleetComponentProvisioningPhase,
    pub root_batch_count: u32,
    pub accepted_root_count: u32,
    pub provisioned_root_count: u32,
    pub directory_confirmed_root_count: u32,
    pub directory_confirmation_root_count: u32,
    pub runtime_activated_root_count: u32,
    pub component_count: u32,
}

/// Bounded progress event bound to the exact reviewed operation.
#[derive(Clone, Debug, Eq, PartialEq, Serialize)]
pub struct FleetEnsureProgress {
    /// First unfinished reviewed action, not proof that its remote execution has started.
    pub next_action: Option<FleetEnsureActionProgress>,
    pub operation_id: String,
    pub plan_sha256: String,
    pub phase: FleetEnsurePhase,
    pub state: FleetEnsureProgressState,
    pub applied_effects: u32,
    pub reviewed_effects: usize,
}

/// Bounded host projection of reviewed work; carries no payload or execution authority.
#[derive(Clone, Debug, Eq, PartialEq, Serialize)]
pub struct FleetEnsureActionProgress {
    pub kind: FleetEnsureActionKind,
    pub target: String,
}

/// Informational action identity projected from the maintained reviewed action contract.
#[derive(Clone, Copy, Debug, Eq, PartialEq, Serialize)]
#[serde(rename_all = "snake_case")]
pub enum FleetEnsureActionKind {
    ActivateRegistry,
    ActivateRegistryMirror,
    AdoptStore,
    BootstrapStore,
    Create,
    Delete,
    Fund,
    FundEstate,
    Install,
    JoinRoot,
    MaintainPoolReadiness,
    ObservePoolReadiness,
    PrepareComponentRegistry,
    PrepareStoreFixture,
    Protocol,
    ProvisionComponents,
    PublishStoreChunk,
    PublishStoreFixtureChunk,
    ReconcilePoolAsset,
    SealAuthority,
    SetControllers,
    Start,
    Stop,
    SynchronizeRegistry,
    Transfer,
}