kumoba 0.2.1

Local libkrun microVM sandboxes for Rust applications
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

mod agent;
pub use agent::Agent;
mod config;
mod mounts;
pub use kumoba_protocol::HostMount;
pub use mounts::validate_host_mounts;
mod platform;
pub use platform::HostPlatform;
mod desktop;
mod disk_copy;
mod egress;
pub use egress::{AccessRecord, EgressConfig, PrivateAllow, UpstreamProxy};
mod execution;
mod public_http;
mod runtime;
mod secret_https;
mod secret_stream;
mod secrets;
mod session;
mod snapshot_image;
pub use snapshot_image::{SnapshotImage, SnapshotImageInfo};

pub use config::{
    AccessSink, Command, ExecOutput, ExecSummary, GuestPath, Network, RuntimeConfig, SandboxConfig,
    SandboxId, State, StopOutcome, Termination,
};
pub use runtime::{Runtime, Snapshot};
pub use session::{Sandbox, Tunnel};

pub type Result<T> = std::result::Result<T, Error>;

#[derive(Debug, thiserror::Error)]
#[non_exhaustive]
pub enum Error {
    #[error("invalid configuration: {0}")]
    InvalidInput(String),
    #[error("state directory or sandbox is already owned by another handle or process")]
    InUse,
    #[error("sandbox is not running")]
    NotRunning,
    #[error("sandbox has been deleted")]
    Deleted,
    #[error("running sandbox capacity exhausted")]
    Capacity,
    #[error("sandbox has a pending disk operation")]
    Busy,
    #[error("boot failed: {0}")]
    Boot(String),
    #[error("guest operation failed: {0}")]
    Guest(String),
    #[error("guest connection failed; operation outcome may be unknown: {0}")]
    OutcomeUnknown(String),
    #[error("invalid guest protocol: {0}")]
    Protocol(String),
    #[error("snapshot requires a cleanly stopped sandbox")]
    NotClean,
    #[error("snapshot integrity check failed")]
    Integrity,
    #[error(transparent)]
    Io(#[from] std::io::Error),
    #[error(transparent)]
    Json(#[from] serde_json::Error),
    #[error("background operation failed: {0}")]
    Task(#[from] tokio::task::JoinError),
}

pub use egress::{EgressEndpoint, HttpConnectPolicy};

pub use secrets::{SecretId, SecretMetadata, SecretStore, SecretValue};

#[cfg(test)]
mod secrets_vm_tests;

pub use desktop::{DesktopAction, DesktopConfig, DesktopInfo, DesktopScreenshot, MouseButton};