ocaml-docker/lib/ at main · gazagnaire.org/ocaml-docker · Tangled

gazagnaire.org / ocaml-docker

0

Docker Engine API types and codecs in pure OCaml

0

ocaml-docker / lib /

at main 2 folders 37 files

Thomas Gazagnaire docker: give Ping its own equality 10d ago

requests: one client API, reached through run The eio facade carried two complete client APIs -- the session verbs and a One module duplicating every one of them -- so a caller had to know which of the two to reach for, and opening Requests_eio dumped thirty-two modules into scope, most of them pure vocabulary with no caller. The low-level driver added six request_ names fanning a single function over three optional axes, ending in request_100_continue_stream_decompress. There is now one verb set, entered through run, which opens the switch and hands back a session; a one-shot is a session that ends with the scope. The driver is Requests_eio_h1.request, one name taking the axes as optional arguments and always streaming, so callers who want a string drain it. The facade carries the thirteen modules callers reach for, ordered session, core types, behaviour, low-level; the rest stay in the pure core. Routing the buffered callers onto the streaming path surfaced a live bug: a fixed-length body that ends early read back as complete, because sub stops at end of input, so a peer promising more than it sends went unnoticed.

1 week ago

docker-server: adopt the respond split and bytesrw hijack streams Move the server's I/O entry points to respond-eio and take the hijacked exec/attach connection as a Bytesrw writer rather than the old Hijack callbacks; declare the new respond-eio and bytesrw deps.

1 week ago

docker: give Ping its own equality The ping round-trip test compared two Ping.t with (=), which the house rule rejects: nothing stops the polymorphic compare being pointed at a type that cannot support it. Export Ping.equal instead. A ping is a flat record of four strings and a bool -- no floats, functions or cycles -- so structural equality is the equality here, and defining it as a monomorphic (=) keeps it right when a header field is added, which a hand-written conjunction would not.

1 week ago

docker: image build (POST /build, classic builder) Serve the classic POST /build via a new BACKEND.image_build seam: the tar context is not interpreted (the in-memory backend cannot run steps), so a new image is registered under the requested tag and the usual progress stream returned. Client gains Image.build (empty body, since the server ignores the context). Our client builds a tagged image end to end and finds it in the image list. The stock CLI defaults to BuildKit, a separate protocol, so it is not used as a cross-check for this legacy endpoint.

1 month ago

docker: container changes (GET /containers/{id}/changes) Add Docker.Change, the filesystem-diff entry (Path plus a typed Modified/ Added/Deleted Kind), and serve GET /containers/{id}/changes via a new BACKEND.changes seam: a real runtime diffs the container against its image, while the in-memory backend has no writable layer and so reports nothing (404 when the container is unknown). Client gains Container.changes. Real `docker diff` round-trips against --fake.

1 month ago

docker: container changes (GET /containers/{id}/changes) Add Docker.Change, the filesystem-diff entry (Path plus a typed Modified/ Added/Deleted Kind), and serve GET /containers/{id}/changes via a new BACKEND.changes seam: a real runtime diffs the container against its image, while the in-memory backend has no writable layer and so reports nothing (404 when the container is unknown). Client gains Container.changes. Real `docker diff` round-trips against --fake.

1 month ago

docker: prune (containers/images/volumes/networks) and container wait Add the prune endpoints backing `docker system prune`: the backend bulk- removes non-running containers, dangling images, all volumes, and non- default networks, returning the removed identifiers; Docker.Prune encodes each response shape. Also POST /containers/{id}/wait, returning a simulated {StatusCode:0}. Client gains {Container,Image,Volume,Network}.prune and Container.wait. Real `docker container prune -f` round-trips against --fake.

1 month ago

docker: prune (containers/images/volumes/networks) and container wait Add the prune endpoints backing `docker system prune`: the backend bulk- removes non-running containers, dangling images, all volumes, and non- default networks, returning the removed identifiers; Docker.Prune encodes each response shape. Also POST /containers/{id}/wait, returning a simulated {StatusCode:0}. Client gains {Container,Image,Volume,Network}.prune and Container.wait. Real `docker container prune -f` round-trips against --fake.

1 month ago

docker: system df (GET /system/df) Add Docker.Df, the SystemDiskUsage response, and serve GET /system/df by aggregating the backend's images, containers, and volumes. In --fake no bytes are tracked, so only LayersSize (the sum of recorded image sizes) is reported and the per-object size fields stay at their zero default; the object lists and counts are real. Client gains a System.df. Real `docker system df` round-trips against --fake, and our client reads back a populated report.

1 month ago

docker: system df (GET /system/df) Add Docker.Df, the SystemDiskUsage response, and serve GET /system/df by aggregating the backend's images, containers, and volumes. In --fake no bytes are tracked, so only LayersSize (the sum of recorded image sizes) is reported and the per-object size fields stay at their zero default; the object lists and counts are real. Client gains a System.df. Real `docker system df` round-trips against --fake, and our client reads back a populated report.

1 month ago

opam: fix the dependency hygiene monopam lint reports Across the packages monopam lint flagged: declare the libraries each package actually uses (test-only ones scoped with-test, dev tools and benches scoped with-dev-setup), drop the opam deps and dune (libraries) entries nothing references, declare pin-depends for the wire and zarith git pins so a standalone opam install can resolve them, and point the five stale dune-project source URLs at the names sources.toml already uses. The generated .opam files are regenerated to match. Where monopam lint and merlint's project rules disagree, merlint wins: [protocol] packages keep probe linked (E932), CSV-trace interop tests keep csv (E825), and dev-scope deps carry the right filter (E943). The few dead-lib reports that remain are monopam lint blind spots, not real dead deps: usage reached only through an mdx README block (slirp), through copy_files# (vz), or inside a library's own private modules (builder), plus a tar gz dep kept live for a stub test still to write.

1 month ago

docker: container list/create/inspect over a runtime backend seam Add the first container endpoints -- GET /containers/json, POST /containers/create, GET /containers/{id}/json -- the point where the API first needs a runtime underneath it. The seam follows the Irmin Heap.Make pattern: docker-runner defines a BACKEND module type (a container runtime: an in-memory store now, runc or a VMM later) and an in-memory Memory backend; Server.Make (B : BACKEND) builds the server over it, projecting the backend's containers to the Engine API shapes. The static endpoints (/version, /_ping, /info) and the container endpoints are all served, each also under a /v<api> prefix. New docker types: Container.{Config,Create_response,Summary,Detail}. Client gains container_create / container_list / container_inspect (named after the Docker Go SDK). Errors are emitted as the {"message": ...} body via Docker.Error.to_body. The real docker 29.x CLI drives the lifecycle against dockrd end to end: `docker create`, `docker ps -a`, `docker inspect` all work. A live bug it surfaced -- the CLI sends null, not [], for empty Cmd/Env/Warnings arrays -- is fixed with a null-tolerant list codec and a regression test.

1 month ago

docker: container list/create/inspect over a runtime backend seam Add the first container endpoints -- GET /containers/json, POST /containers/create, GET /containers/{id}/json -- the point where the API first needs a runtime underneath it. The seam follows the Irmin Heap.Make pattern: docker-runner defines a BACKEND module type (a container runtime: an in-memory store now, runc or a VMM later) and an in-memory Memory backend; Server.Make (B : BACKEND) builds the server over it, projecting the backend's containers to the Engine API shapes. The static endpoints (/version, /_ping, /info) and the container endpoints are all served, each also under a /v<api> prefix. New docker types: Container.{Config,Create_response,Summary,Detail}. Client gains container_create / container_list / container_inspect (named after the Docker Go SDK). Errors are emitted as the {"message": ...} body via Docker.Error.to_body. The real docker 29.x CLI drives the lifecycle against dockrd end to end: `docker create`, `docker ps -a`, `docker inspect` all work. A live bug it surfaced -- the CLI sends null, not [], for empty Cmd/Env/Warnings arrays -- is fixed with a null-tolerant list codec and a regression test.

1 month ago

docker: daemon events (GET /events) Add Docker.Event (one JSON object per line, the id under Actor.ID) and serve GET /events. The Memory backend records the container lifecycle it simulates (create/start/stop/kill/restart/pause/unpause/destroy) and a new BACKEND.events replays the log; a real daemon would hold the connection open and push live events, so the in-memory backend returns its recorded log as a finite stream. Client gains System.events. Our client reads the log back and sees the create/start/destroy actions it drove.

1 month ago

docker: daemon events (GET /events) Add Docker.Event (one JSON object per line, the id under Actor.ID) and serve GET /events. The Memory backend records the container lifecycle it simulates (create/start/stop/kill/restart/pause/unpause/destroy) and a new BACKEND.events replays the log; a real daemon would hold the connection open and push live events, so the in-memory backend returns its recorded log as a finite stream. Client gains System.events. Our client reads the log back and sees the create/start/destroy actions it drove.

1 month ago

docker: container exec (create/start-hijack/inspect) Add Docker.Exec (create config/response, start, inspect detail) and the exec endpoints over the new respond hijack primitive: POST /containers/{id}/exec creates an instance (404 unknown, 409 not running), POST /exec/{id}/start hijacks the connection and writes a 101 upgrade then the multiplexed output, and GET /exec/{id}/json inspects it. In --fake no process runs, so an exec exits 0 with empty output. BACKEND grows exec_create/start/inspect; Memory tracks instances. The client gains an Exec module that performs the raw upgrade itself and demultiplexes stdout. Real `docker exec` round-trips against --fake, and our own client drives the same create/start/inspect path (plus the 409 on a stopped container).

1 month ago

docker: container exec (create/start-hijack/inspect) Add Docker.Exec (create config/response, start, inspect detail) and the exec endpoints over the new respond hijack primitive: POST /containers/{id}/exec creates an instance (404 unknown, 409 not running), POST /exec/{id}/start hijacks the connection and writes a 101 upgrade then the multiplexed output, and GET /exec/{id}/json inspects it. In --fake no process runs, so an exec exits 0 with empty output. BACKEND grows exec_create/start/inspect; Memory tracks instances. The client gains an Exec module that performs the raw upgrade itself and demultiplexes stdout. Real `docker exec` round-trips against --fake, and our own client drives the same create/start/inspect path (plus the 409 on a stopped container).

1 month ago

docker: image history (GET /images/{name}/history) Add Image.History, the layer-history entry, and serve GET /images/{name}/history via a new BACKEND.image_history seam: a real runtime reads the image config's layer chain, while the in-memory backend stores no layers and reports its single recorded metadata entry (404 when unknown). Client gains Image.history. Real `docker history` round-trips against --fake.

1 month ago

docker: image history (GET /images/{name}/history) Add Image.History, the layer-history entry, and serve GET /images/{name}/history via a new BACKEND.image_history seam: a real runtime reads the image config's layer chain, while the in-memory backend stores no layers and reports its single recorded metadata entry (404 when unknown). Client gains Image.history. Real `docker history` round-trips against --fake.

1 month ago

docker: container list/create/inspect over a runtime backend seam Add the first container endpoints -- GET /containers/json, POST /containers/create, GET /containers/{id}/json -- the point where the API first needs a runtime underneath it. The seam follows the Irmin Heap.Make pattern: docker-runner defines a BACKEND module type (a container runtime: an in-memory store now, runc or a VMM later) and an in-memory Memory backend; Server.Make (B : BACKEND) builds the server over it, projecting the backend's containers to the Engine API shapes. The static endpoints (/version, /_ping, /info) and the container endpoints are all served, each also under a /v<api> prefix. New docker types: Container.{Config,Create_response,Summary,Detail}. Client gains container_create / container_list / container_inspect (named after the Docker Go SDK). Errors are emitted as the {"message": ...} body via Docker.Error.to_body. The real docker 29.x CLI drives the lifecycle against dockrd end to end: `docker create`, `docker ps -a`, `docker inspect` all work. A live bug it surfaced -- the CLI sends null, not [], for empty Cmd/Env/Warnings arrays -- is fixed with a null-tolerant list codec and a regression test.

1 month ago

docker: container list/create/inspect over a runtime backend seam Add the first container endpoints -- GET /containers/json, POST /containers/create, GET /containers/{id}/json -- the point where the API first needs a runtime underneath it. The seam follows the Irmin Heap.Make pattern: docker-runner defines a BACKEND module type (a container runtime: an in-memory store now, runc or a VMM later) and an in-memory Memory backend; Server.Make (B : BACKEND) builds the server over it, projecting the backend's containers to the Engine API shapes. The static endpoints (/version, /_ping, /info) and the container endpoints are all served, each also under a /v<api> prefix. New docker types: Container.{Config,Create_response,Summary,Detail}. Client gains container_create / container_list / container_inspect (named after the Docker Go SDK). Errors are emitted as the {"message": ...} body via Docker.Error.to_body. The real docker 29.x CLI drives the lifecycle against dockrd end to end: `docker create`, `docker ps -a`, `docker inspect` all work. A live bug it surfaced -- the CLI sends null, not [], for empty Cmd/Env/Warnings arrays -- is fixed with a null-tolerant list codec and a regression test.

1 month ago

docker: networks create/inspect/remove; config types use option Extend networks from the read-only defaults to full CRUD: the backend now keeps a network store seeded with bridge/host/none, and serves POST /networks/create, GET /networks/{id}, DELETE /networks/{id}. Client gains Network.{create,inspect,remove}. Real `docker network create/ls/rm` works. Replace the ""-as-unspecified sentinel in Volume.Config / Network.Config with proper string option fields (None = unspecified). The optional-string codec uses (option string) with dec_absent, since opt_member rejects an explicit JSON null the docker CLI may send.

1 month ago

docker: networks create/inspect/remove; config types use option Extend networks from the read-only defaults to full CRUD: the backend now keeps a network store seeded with bridge/host/none, and serves POST /networks/create, GET /networks/{id}, DELETE /networks/{id}. Client gains Network.{create,inspect,remove}. Real `docker network create/ls/rm` works. Replace the ""-as-unspecified sentinel in Volume.Config / Network.Config with proper string option fields (None = unspecified). The optional-string codec uses (option string) with dec_absent, since opt_member rejects an explicit JSON null the docker CLI may send.

1 month ago

docker: give Ping its own equality The ping round-trip test compared two Ping.t with (=), which the house rule rejects: nothing stops the polymorphic compare being pointed at a type that cannot support it. Export Ping.equal instead. A ping is a flat record of four strings and a bool -- no floats, functions or cycles -- so structural equality is the equality here, and defining it as a monomorphic (=) keeps it right when a header field is added, which a hand-written conjunction would not.

1 week ago

docker: give Ping its own equality The ping round-trip test compared two Ping.t with (=), which the house rule rejects: nothing stops the polymorphic compare being pointed at a type that cannot support it. Export Ping.equal instead. A ping is a flat record of four strings and a bool -- no floats, functions or cycles -- so structural equality is the equality here, and defining it as a monomorphic (=) keeps it right when a header field is added, which a hand-written conjunction would not.

1 week ago

docker: prune (containers/images/volumes/networks) and container wait Add the prune endpoints backing `docker system prune`: the backend bulk- removes non-running containers, dangling images, all volumes, and non- default networks, returning the removed identifiers; Docker.Prune encodes each response shape. Also POST /containers/{id}/wait, returning a simulated {StatusCode:0}. Client gains {Container,Image,Volume,Network}.prune and Container.wait. Real `docker container prune -f` round-trips against --fake.

1 month ago

docker: prune (containers/images/volumes/networks) and container wait Add the prune endpoints backing `docker system prune`: the backend bulk- removes non-running containers, dangling images, all volumes, and non- default networks, returning the removed identifiers; Docker.Prune encodes each response shape. Also POST /containers/{id}/wait, returning a simulated {StatusCode:0}. Client gains {Container,Image,Volume,Network}.prune and Container.wait. Real `docker container prune -f` round-trips against --fake.

1 month ago

tree: reformat for the upgraded ocamlformat Comment reflow and header reindent produced by the new ocamlformat; no code changes.

1 month ago

docker: fold docker-runner into docker; give dockr its own package docker-runner was its own opam package but is I/O-free (deps: docker + fmt) like the main docker types, so a separate package only paid off for a future real backend depending on just the interface -- which doesn't exist. Fold it in: lib/runner.ml is now the Docker.Runner module (BACKEND renamed to the idiomatic S), the docker-runner package/opam are dropped, and its test moves to test/test_runner.ml. Merging the three binaries into one dockr also pulled docker-client and nox-crypto-rng (which the docker-server library does not use) into a library-bearing package; move the binary into its own executable-only dockr package (the etco pattern), so docker-server keeps only its real library deps (docker-client returns to with-test for the tests). Net: still 4 packages (docker, docker-client, docker-server, dockr), but each carries honest deps. Consumers use Docker.Runner.S / Docker.Runner.Memory; 65 + e2e tests pass.

1 month ago

docker: container stats (GET /containers/{id}/stats) Add Docker.Stats (the cpu/memory/pids counters the CLI reads, nested under cpu_stats/memory_stats/pids_stats) and serve GET /containers/{id}/stats via a new BACKEND.stats seam: a real backend samples the cgroup, the in-memory backend reports zeros (404 when unknown). A client reading one object then EOF (the --no-stream case) gets exactly this sample. Client gains Container.stats. Real `docker stats --no-stream` names the container against --fake, and our client reads the zeroed sample back.

1 month ago

docker: container stats (GET /containers/{id}/stats) Add Docker.Stats (the cpu/memory/pids counters the CLI reads, nested under cpu_stats/memory_stats/pids_stats) and serve GET /containers/{id}/stats via a new BACKEND.stats seam: a real backend samples the cgroup, the in-memory backend reports zeros (404 when unknown). A client reading one object then EOF (the --no-stream case) gets exactly this sample. Client gains Container.stats. Real `docker stats --no-stream` names the container against --fake, and our client reads the zeroed sample back.

1 month ago

docker: container logs (GET /containers/{id}/logs) + stdcopy framing Add Docker.Stdcopy, the multiplexed stdout/stderr stream framing (8-byte header: stream byte, three zeros, big-endian payload length) used by the logs and attach streams, with frame/demux unit-tested on known vectors. Serve GET /containers/{id}/logs: any existing container's logs are a multiplexed stream (404 when unknown), empty in --fake since no process runs, carrying the stream content type so clients demux it. Client gains Container.logs, which demuxes and returns stdout. Real `docker logs` round-trips against --fake.

1 month ago

docker: container logs (GET /containers/{id}/logs) + stdcopy framing Add Docker.Stdcopy, the multiplexed stdout/stderr stream framing (8-byte header: stream byte, three zeros, big-endian payload length) used by the logs and attach streams, with frame/demux unit-tested on known vectors. Serve GET /containers/{id}/logs: any existing container's logs are a multiplexed stream (404 when unknown), empty in --fake since no process runs, carrying the stream content type so clients demux it. Client gains Container.logs, which demuxes and returns stdout. Real `docker logs` round-trips against --fake.

1 month ago

docker: container top (GET /containers/{id}/top) Add Docker.Top, the process-listing response, and serve GET /containers/{id}/top. Like the daemon it requires the container to be running (404 when unknown, 409 when stopped); Top.of_command builds the simulated ps -ef table reported for a running --fake container. Client gains Container.top. Real `docker top` prints the listing against --fake, and our client reads the command back (and sees the 409 once stopped).

1 month ago

docker: container top (GET /containers/{id}/top) Add Docker.Top, the process-listing response, and serve GET /containers/{id}/top. Like the daemon it requires the container to be running (404 when unknown, 409 when stopped); Top.of_command builds the simulated ps -ef table reported for a running --fake container. Client gains Container.top. Real `docker top` prints the listing against --fake, and our client reads the command back (and sees the 409 once stopped).

1 month ago

docker: Engine API client and server, first slice New ocaml-docker package: the Docker Engine REST API on the host, in pure OCaml. The IO-free `docker` library maps request and response bodies to OCaml values with nox-json; `docker-client` (the `dockr` CLI) and `docker-server` (the `dockrd` daemon) are thin Eio adapters over a Unix socket, so the same definitions back the client, the server, and the tests. This first slice covers GET /version and GET /_ping (both also under a /v<api> prefix) -- enough to exercise the whole stack (Unix-socket transport, routing, headers, JSON codecs, client/server symmetry) without a container runtime behind it. The interop tests cover both directions. test/client drives a real daemon and test/interop/dockerd replays committed real-daemon captures (the oracle is contacted only at REGEN=1), validating our client against a real server. test/server points the stock `docker` CLI at our server, validating our server against a real client.

1 month ago

docker: Engine API client and server, first slice New ocaml-docker package: the Docker Engine REST API on the host, in pure OCaml. The IO-free `docker` library maps request and response bodies to OCaml values with nox-json; `docker-client` (the `dockr` CLI) and `docker-server` (the `dockrd` daemon) are thin Eio adapters over a Unix socket, so the same definitions back the client, the server, and the tests. This first slice covers GET /version and GET /_ping (both also under a /v<api> prefix) -- enough to exercise the whole stack (Unix-socket transport, routing, headers, JSON codecs, client/server symmetry) without a container runtime behind it. The interop tests cover both directions. test/client drives a real daemon and test/interop/dockerd replays committed real-daemon captures (the oracle is contacted only at REGEN=1), validating our client against a real server. test/server points the stock `docker` CLI at our server, validating our server against a real client.

1 month ago

docker: networks create/inspect/remove; config types use option Extend networks from the read-only defaults to full CRUD: the backend now keeps a network store seeded with bridge/host/none, and serves POST /networks/create, GET /networks/{id}, DELETE /networks/{id}. Client gains Network.{create,inspect,remove}. Real `docker network create/ls/rm` works. Replace the ""-as-unspecified sentinel in Volume.Config / Network.Config with proper string option fields (None = unspecified). The optional-string codec uses (option string) with dec_absent, since opt_member rejects an explicit JSON null the docker CLI may send.

1 month ago

docker: networks create/inspect/remove; config types use option Extend networks from the read-only defaults to full CRUD: the backend now keeps a network store seeded with bridge/host/none, and serves POST /networks/create, GET /networks/{id}, DELETE /networks/{id}. Client gains Network.{create,inspect,remove}. Real `docker network create/ls/rm` works. Replace the ""-as-unspecified sentinel in Volume.Config / Network.Config with proper string option fields (None = unspecified). The optional-string codec uses (option string) with dec_absent, since opt_member rejects an explicit JSON null the docker CLI may send.

1 month ago