microvms-app 1.0.1

The MicroVMs client's use cases, written against ports: the control plane, sandboxes, sessions, agents
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

// SPDX-License-Identifier: Apache-2.0
//! The MicroVMs client's use cases, written only against ports (ARCH-7).
//!
//! The control-plane client, [`sandbox::Sandbox`], [`session::Session`], `ensure_image`, the
//! agent recipes and the daemon release's verification policy are here. Everything they do
//! outside the process goes through a trait this crate declares:
//! [`control::transport::Transport`] for the control plane, [`control::BuildServices`] for STS
//! and S3, [`session::HttpBackend`] for the daemon, [`session::TokenMinter`] for proxy tokens,
//! [`names::NameStore`] for the name registry, [`clock::Clock`] for time, [`entropy::Entropy`]
//! for randomness, [`adapters::Adapters`] for the pieces a use case builds partway through, and
//! [`provision::ReleaseSource`] and [`provision::AttestationVerifier`] for the daemon release a
//! fetch proves.
//!
//! # What this crate can't do
//!
//! Reach the network, AWS, the filesystem, a subprocess, the wall clock or the OS random pool.
//! A use case that did one of those directly couldn't be tested without the real thing, and it
//! would bypass the port a test replaces. These checks hold that:
//!
//! * the exact dependency set in `verify/arch/placement.toml`, which
//!   `crates/microvms-cli/tests/dependency_direction.rs` asserts along with each dependency's
//!   features, keeps reqwest, the AWS crates, getrandom and the socket crates out;
//! * `clippy.toml` beside this crate's manifest bans the std file, network, process,
//!   environment and clock calls, and tokio's `net`, `fs` and `process` items, which feature
//!   unification would otherwise let this crate name;
//! * the crate root below forbids both lints, so a hit fails the build and an inner `#[allow]`
//!   or `#[expect]` is itself an error.
//!
//! The production implementations are in `microvms-edges`. `microvms-core` wires them into the
//! constructors a caller has always used (`ControlPlane::new`, `Sandbox::new`,
//! `Session::connect`) and re-exports every item here at its `microvms_core::` path, so a
//! consumer names these types through core and never depends on this crate.
//!
//! The shared test doubles are in `testing`, behind the `test-support` feature.

// CLI-7: a print macro panics when its stream's reader has gone (#216). Every write goes
// through a checked writer instead.
#![deny(clippy::print_stdout, clippy::print_stderr)]
// ARCH-7: `clippy.toml` beside this crate's manifest names the file, process, network,
// environment and clock items this crate may not touch. Forbidden rather than denied, so a hit
// fails the build and an inner `#[allow]` or `#[expect]` is itself an error (E0453): a use case
// that needs one of them needs a port.
#![forbid(clippy::disallowed_methods, clippy::disallowed_types)]

pub mod adapters;
pub mod agents;
pub mod clock;
pub mod control;
pub mod defaults;
pub mod entropy;
pub mod names;
pub mod preflight;
pub mod provision;
pub mod sandbox;
pub mod session;
#[cfg(any(test, feature = "test-support"))]
pub mod testing;
pub mod workspace;

// The rules and values the use cases compute with, at the paths the moved code names them by.
pub use microvms_domain::{constants, cost, duration, error, hooks, identity, region, sizing};

// Re-exported so the use cases and their callers name wire types through one crate.
pub use protocol;

pub use error::{Error, ErrorKind, WireKind};
pub use hooks::{BuildHookTimeout, RunHookTimeout};
pub use region::Region;
pub use sizing::SizeClass;