firecracker-sdk 0.0.3

SDK for working with Firecracker MicroVM using the Rust programming language
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

use std::{
    collections::HashMap,
    path::{Path, PathBuf},
};

use anyhow::Result;
use serde::Serialize;

use crate::{
    domain::config::{BootSource, Drives, FirecrackerConfiguration},
    infrastructure::{fs::FileManager, process::FirecrackerProcess, s3::S3Downloader},
};

/// A structure for configuring the launch of FirecrackerVM. Helps to preconfigure and start the virtual machine.
///
/// Note: Firecracker must be installed globally.
///
/// Exemple:
/// ```no_compile
/// let process = FirecrackerStartup::new()
///     .set_api_socket("/tmp/some.socket")
///     .download_rootfs(true)
///     .download_kernel(true)
///     .start().await.unwrap();
/// ```
#[derive(Serialize)]
pub struct FirecrackerStartup {
    api_socket: PathBuf,
    download_kernel: bool,
    download_rootfs: bool,
}

impl FirecrackerStartup {
    /// Creates a new instance of FirecrackerStartup
    pub fn new() -> Self {
        Self {
            api_socket: PathBuf::from("/tmp/firecracker.socket"),
            download_kernel: false,
            download_rootfs: false,
        }
    }

    /// Set the --api-sock startup argument with the path to the unix socket
    ///
    /// Note: For the best documentation, please refer to [here](https://github.com/firecracker-microvm/firecracker/blob/main/docs/getting-started.md).
    pub fn set_api_socket<P: AsRef<Path>>(mut self, path: P) -> Self {
        self.api_socket = path.as_ref().to_path_buf();
        self
    }

    /// Returns the --api-sock startup argument with the path to the unix socket
    ///
    /// Note: For the best documentation, please refer to [here](https://github.com/firecracker-microvm/firecracker/blob/main/docs/getting-started.md).
    pub fn get_api_socket(&self) -> &PathBuf {
        &self.api_socket
    }

    /// Flag to download the latest kernel version for microVM
    pub fn download_kernel(mut self, flag: bool) -> Self {
        self.download_kernel = flag;
        self
    }
    /// Flag to download the ubuntu-22.04.ext4 for microVM
    pub fn download_rootfs(mut self, flag: bool) -> Self {
        self.download_rootfs = flag;
        self
    }

    /// Starts a VM with specified parameters
    /// Returns a structure for working with the Firecracker process
    pub async fn start(self) -> Result<FirecrackerProcess> {
        let fs = FileManager::default();
        let s3 = S3Downloader::default();
        let kernel_path = fs.resolve_kernel_path(self.download_kernel, &s3).await?;
        let rootfs_path = fs.resolve_rootfs_path(self.download_rootfs, &s3).await?;

        FirecrackerProcess::new(FirecrackerConfiguration {
            startup_config: self,
            boot_source: BootSource {
                kernel_image_path: kernel_path,
                boot_args: HashMap::new(),
            },
            drives: Drives {
                drive_id: "rootfs".into(),
                path_on_host: rootfs_path,
                is_root_device: true,
                is_read_only: false,
            },
        })
        .await
    }
}

impl Default for FirecrackerStartup {
    fn default() -> Self {
        Self::new()
    }
}