lightshuttle-runtime 0.2.0

Container runtime backends and lifecycle manager for LightShuttle
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

//! Error type returned by container runtime operations.

use std::time::Duration;

/// Shorthand alias for `std::result::Result<T, RuntimeError>`.
pub type Result<T> = std::result::Result<T, RuntimeError>;

/// Errors raised by a [`crate::ContainerRuntime`] implementation.
#[derive(Debug, thiserror::Error)]
pub enum RuntimeError {
    /// The runtime could not establish a connection to the underlying
    /// container daemon (Docker socket, Podman API, ...).
    #[error("failed to connect to the container runtime")]
    Connect(#[source] bollard::errors::Error),

    /// Pulling an image from the registry failed.
    #[error("failed to pull image `{image}`")]
    ImagePull {
        /// The image reference that the runtime tried to pull.
        image: String,
        /// Underlying error from the container daemon.
        #[source]
        source: bollard::errors::Error,
    },

    /// The runtime refused to start the container.
    #[error("failed to start container")]
    Start(#[source] bollard::errors::Error),

    /// The runtime refused to stop a container.
    #[error("failed to stop container `{id}`")]
    Stop {
        /// Identifier of the container that could not be stopped.
        id: String,
        /// Underlying error from the container daemon.
        #[source]
        source: bollard::errors::Error,
    },

    /// The runtime refused to remove a container.
    #[error("failed to remove container `{name}`")]
    Remove {
        /// Name of the container that could not be removed.
        name: String,
        /// Underlying error from the container daemon.
        #[source]
        source: bollard::errors::Error,
    },

    /// The runtime could not inspect a container.
    #[error("failed to inspect container `{id}`")]
    Inspect {
        /// Identifier of the container that could not be inspected.
        id: String,
        /// Underlying error from the container daemon.
        #[source]
        source: bollard::errors::Error,
    },

    /// The container does not exist on the daemon.
    #[error("container `{0}` not found")]
    NotFound(String),

    /// A blocking operation exceeded its allotted time budget.
    #[error("operation `{operation}` timed out after {after:?}")]
    Timeout {
        /// Short name of the operation that timed out.
        operation: &'static str,
        /// Configured timeout.
        after: Duration,
    },

    /// Streaming logs from a container failed mid-flight.
    #[error("log stream error")]
    LogStream(#[source] bollard::errors::Error),

    /// Building an image from a Dockerfile failed.
    #[error("failed to build image from Dockerfile")]
    Build(#[source] bollard::errors::Error),

    /// The provided [`crate::ContainerSpec`] is structurally invalid.
    #[error("invalid container spec: {0}")]
    InvalidSpec(String),
}