canic-control-plane 0.20.4

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
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

use canic_core::{
    bootstrap::{EmbeddedRootReleaseEntry, compiled::ConfigModel},
    dto::subnet::SubnetIdentity,
};
use std::time::Duration;

///
/// LifecycleApi
///

pub struct LifecycleApi;

impl LifecycleApi {
    /// Delegate root init-time runtime seeding to the current core implementation.
    pub fn init_root_canister_before_bootstrap(
        identity: SubnetIdentity,
        config: ConfigModel,
        config_source: &str,
        config_path: &str,
        embedded_wasm_store_bootstrap_release_set: &'static [EmbeddedRootReleaseEntry],
        embedded_release_bundle: &'static [EmbeddedRootReleaseEntry],
        embedded_release_version: &str,
    ) {
        crate::api::template::WasmStoreBootstrapApi::register_embedded_root_wasm_store_release_set(
            embedded_wasm_store_bootstrap_release_set,
        );
        crate::runtime::install::register_template_module_source_resolver();
        canic_core::api::lifecycle::root::LifecycleApi::init_root_canister_before_bootstrap(
            identity,
            config,
            config_source,
            config_path,
        );
        crate::api::template::WasmStoreBootstrapApi::seed_embedded_root_release_bundle(
            embedded_release_bundle,
            embedded_release_version,
        )
        .expect("seed embedded root release bundle");
    }

    /// Delegate root init-time bootstrap scheduling to the current core implementation.
    pub fn schedule_init_root_bootstrap() {
        canic_core::api::timer::TimerApi::set_lifecycle_timer(
            Duration::ZERO,
            "canic:bootstrap:init_root_canister",
            async {
                crate::workflow::bootstrap::root::bootstrap_init_root_canister().await;
            },
        );
    }

    /// Delegate root post-upgrade runtime restore to the current core implementation.
    pub fn post_upgrade_root_canister_before_bootstrap(
        config: ConfigModel,
        config_source: &str,
        config_path: &str,
        embedded_wasm_store_bootstrap_release_set: &'static [EmbeddedRootReleaseEntry],
        embedded_release_bundle: &'static [EmbeddedRootReleaseEntry],
        embedded_release_version: &str,
    ) {
        crate::api::template::WasmStoreBootstrapApi::register_embedded_root_wasm_store_release_set(
            embedded_wasm_store_bootstrap_release_set,
        );
        crate::runtime::install::register_template_module_source_resolver();
        canic_core::api::lifecycle::root::LifecycleApi::post_upgrade_root_canister_before_bootstrap(
            config,
            config_source,
            config_path,
        );
        crate::api::template::WasmStoreBootstrapApi::seed_embedded_root_release_bundle(
            embedded_release_bundle,
            embedded_release_version,
        )
        .expect("seed embedded root release bundle");
    }

    /// Delegate root post-upgrade bootstrap scheduling to the current core implementation.
    pub fn schedule_post_upgrade_root_bootstrap() {
        canic_core::api::timer::TimerApi::set_lifecycle_timer(
            Duration::ZERO,
            "canic:bootstrap:post_upgrade_root_canister",
            async {
                crate::workflow::bootstrap::root::bootstrap_post_upgrade_root_canister().await;
            },
        );
    }
}