Devcontainers & Runtime Images
Crewship used to ship a single monolithicghcr.io/crewship-ai/agent-runtime image with every CLI, tool, and the sidecar baked in. That image has been retired (commit dd86356). Any glibc-based Linux base image now works — Crewship provisions the crew-specific tooling on top via devcontainer features and bind-mounts the sidecar from the host.
This guide explains the whole pipeline end-to-end, from setting a base image on a crew to running agents inside the cached per-crew image.
What you get
Bring Your Own Image (BYOI)
debian:bookworm-slim, ubuntu:24.04, mcr.microsoft.com/devcontainers/base:bookworm, or any other glibc Linux image. Musl/Alpine is unsupported (the Go sidecar binary is CGO-free but still glibc-linked).Community Features
installsAfter).mise Runtime Tools
mise.json block — no Dockerfile required.Per-Crew Cached Image
crewship-cache:{hash[:12]}. Re-running agents skips the install phase entirely.Mental model
Phase 1: Dockerfile + BuildKit provisioning
As of Phase 1, when the Docker CLI with BuildKit is available the provisioner no longer builds the runtime by spinning up a temp container anddocker commit-ing it. Instead it generates a Dockerfile per crew and
builds it with BuildKit, which buys:
- Per-feature layer caching — adding one feature rebuilds only that layer;
common-utilsand the previously-installed features hit the cache. - Package-manager cache mounts — apt / npm / pip caches persist across builds, so re-provisions don’t re-download the world.
- Deterministic ordering — features install in dependency order
(topological sort with
common-utilsfirst).
docker CLI (that is how BuildKit’s cache mounts
and the dockerfile frontend behave identically everywhere), and the CLI is
pinned to the daemon the container provider resolved — not to whatever
docker context happens to be current. This matters on any machine with more
than one runtime installed: colima start and a Rancher Desktop launch both
make themselves the current context without touching /var/run/docker.sock, so
an unpinned build would land the image on one daemon while the container create
looked for it on another. Your docker context is yours; it has no effect on
where Crewship builds.
Intermediate per-feature layers are tagged crewship-feat:{hash} (regenerable,
never referenced directly); the final per-crew image is still tagged
crewship-cache:{hash[:12]}. The transition is transparent: if BuildKit is
unavailable on the host, provisioning falls back to the container-commit path
shown above with no operator action required. Either way you trigger it
with the same crewship crew provision / crewship crew rebuild commands.
Prerequisites
Build the sidecar on the host
internal/config/config.go searches:{binDir}/crewship-sidecar(next to thecrewshipbinary)/usr/local/bin/crewship-sidecar
{binDir}/entrypoint.sh{cwd}/scripts/entrypoint.sh{cwd}/entrypoint.sh/usr/local/share/crewship/entrypoint.sh
CREWSHIP_SIDECAR_PATH / CREWSHIP_ENTRYPOINT_PATH.Verify fail-fast is in effect
crewship start exits with:Confirm Docker can pull images
docker pull against the base image you declare. On air-gapped hosts, pre-pull:Configuration shape
Every crew stores three optional fields in thecrews table:
Supported devcontainer.json fields
Parser lives in internal/devcontainer/config.go:
postCreateCommand accepts the polymorphic forms from the spec: a single string, an array of strings (run sequentially), or an object of named commands (keys ignored, values executed). See parsePolymorphicCommand in internal/devcontainer/config.go.mise config
agent user (UID 1001), so tools land under /home/agent/.local/share/mise. This survives cache rebuilds because the cache image freezes the post-mise state.
Managing a crew’s runtime config
- UI (Crew Wizard)
- CLI
- REST API
- Base image dropdown (populated from
/api/v1/runtimes/catalog) - Feature picker (searchable, powered by
/api/v1/features/catalog) - mise tool picker (searchable, same
/api/v1/runtimes/catalogpayload) - A side-by-side preview of the generated
devcontainer.jsonandmise.jsonblobs
containers.dev scrape, TTL 24 h.Triggering provisioning
Provisioning is asynchronous. The CLI command returns immediately after the backend enqueues a job; you then poll for status. Five triggers can put a crew into provisioning state:- Proactive auto-provision on config save — when a crew is created (
POST /api/v1/crews,crewship apply,crewship crew create) or its devcontainer / mise / runtime-image config changes (PATCH /api/v1/crews/{crewId}), the handler immediately kicks off the build in the background (CrewHandler.maybeAutoProvision). This is the primary path: by the time anyone dispatches an issue the image is usually already cached, so operators never touch a “Build now” button. Editing the config invalidates the old cached image, so the rebuild keeps the crew current automatically. - Explicit CLI/API trigger —
crewship crew provision <slug>orPOST /api/v1/crews/{crewId}/provision. - Crew rebuild —
crewship crew rebuild <slug>clears the cached image marker and re-runs provision. - Auto-provision on first chat (PR #230) — when an operator opens a chat with an agent in a crew that has a config but no cached image, the chat handler calls
ProvisioningHandler.EnqueueForCrewdirectly. The chat surface renders an inlineCrewProvisioningCardwith the live progress checklist; once provisioning succeeds, the agent’s first message starts on the freshly cached image. - Auto-provision on dispatch — when an issue, mission, or routine is dispatched to an agent in a crew that needs provisioning but has no usable cached image (never built, or the cache tag was pruned from the daemon), the dispatch path (
AssignmentHandler.runAssignment→ProvisioningHandler.EnsureProvisioned) blocks until the image is built, then starts the agent on it. The sameprovision.*workspace events fire, so the top-right toolbar provisioning popover lights up (“preparing container”) with no extra wiring. If the build fails or times out, the run finishes with a clear “preparing the crew container failed: …” message instead of the crypticexit 127you’d get from launching the agent on a bare base image with noclaudeCLI. This guarantee means a crew is runnable the moment it’s created — operators don’t have to remember tocrewship crew provisionfirst.
EnqueueForCrew API is idempotent: if a job is already running for the crew, the second call returns the existing job’s ID rather than starting a duplicate. Rate limiting is enforced — ErrRateLimited is returned as RFC 7807 Problem Details if a workspace is enqueueing more than the per-minute cap.
Trigger
POST /api/v1/crews/{crewId}/provision → ProvisioningHandler.ProvisionTrigger → spawns a background goroutine that calls provisioner.Provision(ctx, baseImage, cfg, miseConfig).Poll status
(baseImage, devcontainer_config, mise_config) — see configHash in internal/devcontainer/provisioner.go. Any change invalidates the cache.Re-build on demand
What Provision does, step by step
The entire pipeline is in internal/devcontainer/provisioner.go:Provision:
1. Compute config hash, check cache
1. Compute config hash, check cache
2. Skip if nothing to do
2. Skip if nothing to do
postCreateCommand, no containerEnv, and no mise tools, Provision returns CachedImage="" — the runtime launcher uses the bare RuntimeImage as-is.3. Pull base image if missing
3. Pull base image if missing
ensureImage runs ImageList then ImagePull if absent. The stream is drained to completion before proceeding — otherwise the next ContainerCreate fails with No such image.4. Create a temporary container
4. Create a temporary container
crewship-provision-{hash[:8]}-{unixnano}, entrypoint ["sleep", "infinity"], runs as root so install.sh scripts can write everywhere.5. Install devcontainer features
5. Install devcontainer features
feature: {} entry:- Resolve feature ID → OCI artifact (
ghcr.io/devcontainers/features/common-utils:2). - Fetch manifest, pull the single layer (media type
application/vnd.devcontainers.layer.v1+tar, raw tar — not gzipped). - Write the tar stream into
/tmp/devcontainer-features/{featureId}/inside the container viaCopyToContainer. - Exec
install.shwith the feature options injected as env vars (e.g.USERNAME=agent USERUID=1001 /tmp/devcontainer-features/common-utils/install.sh).
installsAfter (topological sort on feature IDs) — see features.go:SortFeatures. Legacy wild-form [{id: string}] metadata is accepted alongside the spec-compliant []string.6. Install mise tools (if declared)
6. Install mise tools (if declared)
curl -fsSL https://mise.run | sh as the agent user, then mise install for each {tool: version} entry. Fails the provisioning job if any tool download 404s or the version is invalid.7. Run postCreateCommand
7. Run postCreateCommand
agent) via docker exec, with stdout/stderr streamed to the server log. Non-zero exit aborts the whole provision.8. Clean up, commit, tag
8. Clean up, commit, tag
Running agents on the cached image
Every path that starts a crew — chat,crewship issue start, a scheduled
agent, a webhook, a routine’s agent or script step, the web terminal, the
dashboard’s start button — resolves the crew’s runtime config through the same
crew-start contract (internal/crewstart) and therefore boots the cached
image. The terminal is worth calling out: it is the surface an operator opens
specifically to inspect a crew’s environment, and it used to pass only the
crew’s id and slug, so it started debian:bookworm-slim with none of the
crew’s provisioned toolchain — gh, node and the agent CLI all missing —
while crewship crew provision reported success (#1717). If you are debugging
a crew through the terminal on an older build, check
docker inspect <container> --format '{{.Config.Image}}' before trusting what
the shell tells you about the toolchain.
Underneath, container.EnsureCrewRuntime(ctx, team, ...) in internal/provider/docker/docker.go:
-
Resolve which image to boot:
- If
team.CachedImage != ""→ use the cached image. - Else → use
team.RuntimeImageor config default (debian:bookworm-slim).
- If
-
Ensure Docker network
crewship-agentsexists (Internal: false— containers need outbound HTTPS for LLM providers). -
ContainerCreatewith:- Entrypoint forced to
/usr/local/bin/entrypoint.sh(bind-mounted). - HostConfig:
CapDrop: ALL, CapAdd: NET_RAW, no-new-privileges, ReadonlyRootfs: true.- Memory / CPU /
PidsLimit: 200. ExtraHosts: ["host.docker.internal:host-gateway"]— lets the sidecar reachcrewshipdon Linux too.Mounts:/workspace,/output,/crew(rw binds),/secrets(in-memory tmpfs — 16 MiB, mode0700, uid/gid 1001, never host-backed),/home/agent+/opt/crew-tools(named volumes), plus the two read-only bind mounts for the sidecar binary + entrypoint.
- Entrypoint forced to
-
ContainerStart. -
Sanity-check the sidecar bind mount for BYOI images:
Catches Alpine/musl base images that silently can’t run the glibc-linked sidecar.
-
From then on, agent execution uses
docker exec(neverdocker run).
Seed data: end-to-end demo
Thecrewship seed command seeds demo crews with sensible devcontainer + mise configs, then provisions all of them in parallel:
Container actuals
devcontainer.json declares what the container should look like. After agents have run a session — installing packages with apt-get, pip, or npm — the container’s actual state usually drifts from the declared intent. PR #231 closes that gap with the container.snapshot journal entry.
After every successful agent exec, internal/containerstate.Snapshot runs four short probes inside the crew container:
pip in a Node-only image, no npm in a Python-only one) yield empty lists rather than errors. The snapshot is hashed (SHA-256 over the canonical-sorted package set + os details). The orchestrator emits a container.snapshot journal entry only when the hash changes — so quiet sessions that don’t mutate the container produce no churn at all.
A typical session that adds one Python dependency emits exactly one container.snapshot entry (the new pip line), which then survives compaction the same way other observability entries do — see Crew Journal — container.snapshot for the payload schema.
Operators can use these entries to diff intent vs reality:
- “What did this agent install last week?” — query
entry_type=container.snapshoton the crew, sort byts. - “What’s drift between today’s container and the cached image?” — compare the latest snapshot against the manifest baked at provision time.
Variable expansion in mounts and env
PR #225 extends the devcontainer expansion vocabulary the spec defines:${devcontainerId}— resolves to a stable, Docker-volume-safe identifier derived from the crew ID (SHA-256 of the crew ID, first 16 hex chars). Useful for naming per-crew persistent volumes.${VAR}/${containerEnv:VAR}— resolved against the base image’s environment (everything in the image’sENVdirectives), not the host’s. So referencing${HOME}resolves to whatever the image set it to (e.g./home/agent), not the operator’s home directory. Only the curly-brace form is expanded — bare$VARis left untouched.
${devcontainerId} is expanded in mount source/target strings; ${VAR} / ${containerEnv:VAR} is expanded in containerEnv values (against the image’s default ENV). Unknown variables are left in place verbatim (e.g. ${TYPO} stays as the literal token) so an operator can spot and debug them in the rendered config — they are not treated as a hard provisioning error.
Runtime bind-mount semantics
- To roll out a new sidecar or entrypoint across existing crews, rebuild the sidecar (
make build:sidecar) and then remove each crew’s container:docker rm -f crewship-team-<slug>. The container is recreated transparently on the next agent message, picking up the updated bind mount. - Containers still serving an old sidecar are flagged on the next agent run as a
sidecar.staleseverity-error journal entry. Servers built withmake build/make build:gocarry the expected sidecar hash baked in at build time, so a deploy that ships a new server but forgets to rebuild/recopycrewship-sidecaris also flagged (plus astale sidecar ARTIFACT detectedserver log) — that variant needs the sidecar binary redeployed first; recreating containers alone remounts the same old file. postStartCommandruns on every start, so it is the right hook for operations that must reflect host state at the moment of launch (e.g. refreshing a secret viavault read). Do not try to bake those intopostCreateCommand— they’d freeze at provisioning time.- Cached images (
crewship-cache:{hash}) live on the Docker host indefinitely. Runcrewship crew cache prune --older-than 30das part of your maintenance rotation; cached images referenced by live crews are protected automatically.
Troubleshooting
docker build failed for crewship-feat:… — where is the reason?
docker build failed for crewship-feat:… — where is the reason?
RUN that echoes a build-arg or an API key shows [REDACTED].Need more than the tail? Two places have the rest:crewship crew provision status <crew>— the durableprovisioning.build_failedjournal row keeps a larger window, and it survives after the live stream is gone.- Start the server with debug logging to stream every build line as it happens.
docker CLI exited without printing anything, which almost always means it
never reached a daemon. Check crewship doctor.sidecar binary not found; run 'make build:sidecar'
sidecar binary not found; run 'make build:sidecar'
autodetectSidecarPaths in internal/config/config.go failed. Run make build:sidecar on the host, or set CREWSHIP_SIDECAR_PATH=/absolute/path/to/crewship-sidecar and CREWSHIP_ENTRYPOINT_PATH=/absolute/path/to/entrypoint.sh. For tests that never launch containers, set CREWSHIP_SKIP_SIDECAR=1.pull access denied for crewship-feat… / crewship-cache… may require 'docker login'
pull access denied for crewship-feat… / crewship-cache… may require 'docker login'
crewship-feat:* and
crewship-cache:* are local-only tags that exist on exactly one daemon.
This message means the create went looking for a locally-built image on a
daemon that never built it, so it fell back to pulling.Historically that happened when the build (docker CLI, docker context) and
the create (the provider’s probed socket) landed on different daemons — the
default state on a machine where colima start or Rancher Desktop took the
current context. The builder is now pinned to the provider’s endpoint, so
the split cannot occur.If you still see it, the image really was removed from the provider’s
daemon (a docker system prune on that daemon, most often). Re-provision:crewship doctor or
GET /api/v1/system/runtime, and list the tags there with
DOCKER_HOST=<that socket> docker images | grep crewship-.sidecar bind mount sanity check failed (exit 126)
sidecar bind mount sanity check failed (exit 126)
feature 'xyz' install.sh exits non-zero
feature 'xyz' install.sh exits non-zero
curl, git, ca-certificates). debian:bookworm-slim is intentionally minimal. Either:- Switch to
mcr.microsoft.com/devcontainers/base:bookworm(pre-installed), or - Declare
ghcr.io/devcontainers/features/common-utils:2as the first feature — it installs prerequisites.
base/runtime image freshness unknown; keeping the local copy without pulling
base/runtime image freshness unknown; keeping the local copy without pulling
HEAD) and compares it against the local image’s RepoDigests. If that lookup fails, the pull is skipped and the local copy is used as-is — the right call when you’re offline, but it means a permanently failing lookup pins you to a stale image indefinitely. That case now logs at WARN:- No route to the registry (air-gapped host, egress firewall). Pre-pull images on the host and ignore the warning.
-
A broken or wedged Docker credential helper.
~/.docker/config.jsonnames acredsStore, and Docker execsdocker-credential-<store>for every registry. If that binary is missing, hangs, or prompts for an unlocked keychain, the digest lookup times out (5s). Verify with:Digest lookups for registries that need no credentials — loopback/localhostregistries — skip the helper entirely, and a helper that errors falls back to anonymous access rather than giving up, so public images keep resolving.
cache image never refreshes
cache image never refreshes
configHash is deterministic over (baseImage, devcontainer_config, mise_config). Upstream feature releases that re-use the same tag don’t change the hash. Force a rebuild:tmux: not found (noisy log on startup)
tmux: not found (noisy log on startup)
44da863: setupTmuxExec now pre-checks command -v tmux and falls back to stdbuf -oL <cmd> when absent. debian:bookworm-slim doesn’t ship tmux — this is expected.claude: not found inside agent container
claude: not found inside agent container
ghcr.io/devcontainers-extra/features/claude-code:2 feature (replaces our former Go EnsureClaudeCode helper). Make sure it’s in the crew’s devcontainer_config.features. Seed crews include it automatically.Migrating from the legacy agent-runtime image
If you have a long-running deployment that still references ghcr.io/crewship-ai/agent-runtime:latest:
Update Crewship to the current release
dd86356.Build the sidecar on the host
Reconfigure each existing crew
Restart crewshipd
agent-runtime.yml workflow deleted). Pulling its old tag still works but sits frozen; nothing in Crewship itself assumes it anymore.
Reference
- Configuration → Devcontainers — config fields + environment variables reference.
- Configuration → Environment Variables —
CREWSHIP_SIDECAR_PATH,CREWSHIP_ENTRYPOINT_PATH,CREWSHIP_SKIP_SIDECAR. - Security → Container Isolation — UID boundaries, capability drops, network policy.
- Code of record:
internal/devcontainer/,internal/provider/docker/docker.go,cmd/crewship/seeddata/crews.go,cmd/crewship/cmd_crew_config.go,cmd/crewship/cmd_crew_provision.go.