Skip to content
SHC Docs

Docker module

Source: modules/docker/.

At a glance

Section titled “At a glance”
CLI—
Subcommands0
HTTP endpointssee the route reference
Events emittedsee the event reference
Error codessee the error code reference
Service classes—
Cross-module depsapp, events, node

Source layout

Section titled “Source layout”
modules/docker/
├── errors.go
├── events.go
├── logs.go
├── puller.go
├── tasks.go

Errors

Section titled “Errors”

Typed errors are catalogued in the error code reference with HTTP statuses and message templates.

Responsibilities

Section titled “Responsibilities”

The docker module is a thin helper layer over the Docker CLI and Docker engine API that the rest of SHC uses instead of talking to Docker directly. Its job is to keep the dependency on Docker behind a small, testable surface: project naming, container labels, Compose / Swarm dispatch, version detection.

It has no persistent state of its own and no HTTP API. Most of the actual docker invocations for a stack live in app’s compose* files; this module holds the utilities they share.