boxlite 0.9.6

Embeddable virtual machine runtime for secure, isolated code execution
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

//! Constants for BoxLite runtime
//!
//! Centralized location for all hardcoded values, paths, and configuration.
//! Host controls all paths - guest receives these via GuestInitRequest.

// Re-export shared constants from boxlite-core
pub use boxlite_shared::constants::{container, mount_tags, network};

/// Guest mount points (paths inside the guest).
///
/// Note: Host only knows BIN_DIR (for guest entrypoint).
/// All other guest paths are determined by the guest based on tags.
pub mod guest_paths {
    /// Guest binary directory (for guest entrypoint executable)
    pub const BIN_DIR: &str = "/boxlite/bin";
}

pub mod envs {
    pub const BOXLITE_HOME: &str = "BOXLITE_HOME";

    /// REST API base URL (required for REST mode).
    #[cfg(feature = "rest")]
    pub const BOXLITE_REST_URL: &str = "BOXLITE_REST_URL";

    /// Opaque API key, sent directly as `Authorization: Bearer <key>`. Flat
    /// name (not `BOXLITE_REST_API_KEY`) matches industry convention —
    /// `STRIPE_API_KEY`, `HEROKU_API_KEY`, `GH_TOKEN`.
    #[cfg(feature = "rest")]
    pub const BOXLITE_API_KEY: &str = "BOXLITE_API_KEY";

    /// Value substituted into the `{prefix}` URL segment on
    /// box-scoped routes (`/v1/{prefix}/boxes/...`). Opaque
    /// to the client — deployment decides what it means. When
    /// unset / empty the client builds URLs without the segment
    /// (`/v1/boxes/...`) — the canonical single-tenant shape
    /// used by `boxlite serve` and similar single-scope deployments.
    #[cfg(feature = "rest")]
    pub const BOXLITE_REST_PATH_PREFIX: &str = "BOXLITE_REST_PATH_PREFIX";
}

/// Container images used by the runtime
pub mod images {
    /// Default container image when none is specified
    pub const DEFAULT: &str = "alpine:latest";

    /// Base image for VM init rootfs (must include mkfs.ext4 for disk formatting)
    pub const INIT_ROOTFS: &str = "debian:bookworm-slim";
}

/// Filesystem and mount options
pub mod fs_options {
    /// Default tmpfs size for writable layer (in MB)
    pub const TMPFS_SIZE_MB: usize = 1024;

    /// Overlayfs mount options
    pub const OVERLAYFS_OPTIONS: &[&str] =
        &["metacopy=off", "redirect_dir=off", "index=off", "xino=off"];
}

/// Virtual machine resource defaults
pub mod vm_defaults {
    /// Default number of CPUs allocated to a Box
    pub const DEFAULT_CPUS: u8 = 1;

    /// Default memory in MiB allocated to a Box
    pub const DEFAULT_MEMORY_MIB: u32 = 2048;

    /// Default disk size in GB for the container rootfs (sparse, grows as needed)
    pub const DEFAULT_DISK_SIZE_GB: u64 = 10;
}

/// File naming patterns
pub mod filenames {
    /// Lock file name
    pub const LOCK_FILE: &str = ".lock";
}