arcbox-docker 0.4.9

Docker REST API compatibility layer for ArcBox
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

//! # arcbox-docker
//!
//! Docker REST API compatibility layer for `ArcBox`.
//!
//! This crate provides a Docker-compatible API server that allows existing
//! Docker CLI tools to work with `ArcBox` seamlessly.
//!
//! ## Compatibility
//!
//! Host routing supports Docker Engine API compatibility paths `v1.24..v1.43`
//! (plus unversioned endpoints). Request handling is split between local
//! `ArcBox` handlers and pass-through proxying to guest `dockerd`.
//!
//! Supported operation groups include:
//!
//! - Container operations (create, start, stop, remove, logs, exec)
//! - Image operations (pull, push, list, remove)
//! - Volume operations
//! - Network operations (basic)
//!
//! `/version` and related system metadata responses are sourced from guest
//! `dockerd`.
//!
//! ## Architecture
//!
//! ```text
//! docker CLI ──► Unix Socket ──► arcbox-docker ──► arcbox-core
//!                                     │
//!                                     ▼
//!                              HTTP REST API
//!                             (Axum server)
//! ```
//!
//! ## Usage
//!
//! The server listens on a Unix socket that can be configured as the
//! Docker context, allowing transparent use of Docker CLI:
//!
//! ```bash
//! docker context create arcbox --docker "host=unix:///home/you/.arcbox/docker.sock"
//! docker context use arcbox
//! docker ps  # Now uses ArcBox!
//! ```
pub mod api;
pub mod context;
pub mod error;
pub mod handlers;
pub(crate) mod host_path;
pub mod proxy;
pub mod routing;
pub mod server;
pub mod trace;
pub mod workload;
// Docker API compatibility layer contains many spec fields only serialized/deserialized.
#[allow(dead_code)]
pub mod types;

pub use context::{ContextStatus, DockerContextManager};
pub use error::{DockerError, Result};
pub use server::{DockerApiServer, ServerConfig};