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

/* -------------------------------------------------------------------------- *\
 *        Apache 2.0 License Copyright © 2022-2023 The Aurae Authors          *
 *                                                                            *
 *                +--------------------------------------------+              *
 *                |   █████╗ ██╗   ██╗██████╗  █████╗ ███████╗ |              *
 *                |  ██╔══██╗██║   ██║██╔══██╗██╔══██╗██╔════╝ |              *
 *                |  ███████║██║   ██║██████╔╝███████║█████╗   |              *
 *                |  ██╔══██║██║   ██║██╔══██╗██╔══██║██╔══╝   |              *
 *                |  ██║  ██║╚██████╔╝██║  ██║██║  ██║███████╗ |              *
 *                |  ╚═╝  ╚═╝ ╚═════╝ ╚═╝  ╚═╝╚═╝  ╚═╝╚══════╝ |              *
 *                +--------------------------------------------+              *
 *                                                                            *
 *                         Distributed Systems Runtime                        *
 *                                                                            *
 * -------------------------------------------------------------------------- *
 *                                                                            *
 *   Licensed under the Apache License, Version 2.0 (the "License");          *
 *   you may not use this file except in compliance with the License.         *
 *   You may obtain a copy of the License at                                  *
 *                                                                            *
 *       http://www.apache.org/licenses/LICENSE-2.0                           *
 *                                                                            *
 *   Unless required by applicable law or agreed to in writing, software      *
 *   distributed under the License is distributed on an "AS IS" BASIS,        *
 *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. *
 *   See the License for the specific language governing permissions and      *
 *   limitations under the License.                                           *
 *                                                                            *
\* -------------------------------------------------------------------------- */
#![allow(dead_code)]

use libcontainer::container::Container;

#[derive(Debug, Clone, Default)]
pub struct Sandbox {
    /// The unique name of the Pod sandbox at runtime.
    ///
    /// Note: This is the name of the "Pod" that can typically be associated
    /// back the AURAE_RUNTIME_DIR value (which is typically "/var/run/aurae").
    ///
    /// Note: This also is a copy of the value that is used in the cache hashmap
    /// to access the Pod sandbox in the internal cache mechanism.
    name: String,

    /// Init containers are the "preliminary" container that is used to begin
    /// the isolation process in a sandbox.
    ///
    /// The init container will most often be a spawned "auraed" instance
    /// running in a new namespace isolation zone that is unshared from the
    /// host namespaces.
    pub(crate) init: Container,

    /// Tenants are the arbitrary workloads running alongside the init
    /// containers in an Aurae pod.
    ///
    /// These are usually things like an OCI compatible container image such
    /// as "nginx" or "busybox".
    ///
    /// In the case of large enterprise workload management, these specifically
    /// are "your app".
    pub(crate) tenants: Vec<Container>,
}

pub struct SandboxBuilder {
    name: String,
    init: Container,
}

impl SandboxBuilder {
    // TODO: Consider embedding the ContainerBuilder directly into this SandboxBuilder. For now just require a started init container.
    pub fn new(name: String, init: Container) -> SandboxBuilder {
        SandboxBuilder { name, init }
    }
    /// The SandboxBuilder will require that the libcontainer::Container be built before
    /// we can build the Sandbox.
    pub fn build(self) -> Sandbox {
        Sandbox { name: self.name, init: self.init, tenants: vec![] }
    }
}