mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-11-22 11:54:35 +01:00
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work > - The Runner is the part that executes agent work: a daemon (`paperclip-runnerd`) and a provider pack of agent tools > - Parts 2 and 3 of this stack build the Runner alone as an image with two variants, and check it on pull requests. Nothing publishes it > - Downstream sandbox and VM images can copy the Runner only from a registry, and they must be able to verify where it came from > - A published image must be exactly the bytes that were checked, and its name must never point at something else later > - This pull request publishes both variants from `master` as `ghcr.io/paperclipai/paperclip-runner`, one time for each distinct set of inputs, and attests them > - Nothing consumes the image in this pull request. The application image build does not change > - The benefit is one verified, attested Runner that later changes can copy by digest ## Linked Issues or Issue Description Refs #21204 (part 2 of this stack) and #21096 (the merge-queue image build). No issue exists for this change. **Problem or motivation** The Runner image exists only inside a pull-request check. A consumer cannot pull it. There is no rule for which commit publishes an image, no protection for its tags, and no way to verify a copied Runner. **Proposed solution** Publish from a `master` push in this repository, and from nothing else. Build only when no image has the digest of the commit's inputs. Let the build legs hold no write access. Push the bytes that the legs checked by digest, attest each multi-platform index, and write the tags last. Write the full tag after the slim tag, so that the full tag means "both exist". **Alternatives considered** - Publish from `docker.yml`. That workflow holds one concurrency slot for each ref, and the Runner image needs its own signer identity, so that its attestation cannot stand in for the application image's. - Resolve the lockfile in the workflow before a `master` build, as `docker.yml` does. Then the published Runner depends on the state of the npm registry at run time, and the digest cannot be computed again from a commit. - Hand each variant to the publish job as its own OCI archive. The two archives hold the two shared layers two times: 1.27 GB for each architecture in place of 0.85 GB. - Write the full tag first. Then a consumer can see a full image whose slim image does not exist yet. **Roadmap alignment** This is build infrastructure. It adds no product feature and does not overlap an item in `ROADMAP.md`. This is part 4 of 4. Each part is on top of the one before it: 1. #21228 (merged): an optional field in the provider pack manifest 2. #21204: build and check the Runner image, with no publication 3. #21229: layers by change rate, and the slim variant 4. #21230: publish both variants from `master` (this pull request) ## What Changed - `.github/workflows/runner-image.yml`: adds the trigger `push` to `master` and the job `publish`. - `identity` checks the committed lockfile against the Runner's manifests, computes the digest in the build context, and asks the registry whether these inputs are published. - `build` is the job of part 3. It also records what it built, on every event. On a canonical `master` push it uploads that. It cannot write to the registry on any event. The only token in the job can read packages, and only the lookup step receives it. - `publish` runs only for a `master` push in this repository. It builds nothing and runs no dependency code. - Lockfile rule. A `master` push builds from the committed `pnpm-lock.yaml` and resolves nothing, so the digest is a function of the commit. When the committed lockfile is behind the manifests that the Runner build reads, the run writes a notice, publishes nothing, and stays green. The commit that merges the lockfile refresh publishes the image. Pull requests and manual runs resolve the lockfile first, always build, and never publish. - Hand-off. Each leg joins its two OCI archives into one OCI layout that names the images `slim` and `full`. The layout stores the two shared layers one time. `record` then reads the layout back, each image by its name, and checks every blob against its digest. The leg's record binds the layout to both image digests, the architecture, the inputs digest, and the commit. Those digests are the digests of the archives that part 3 unpacks and checks, so the tree that is checked and the image that is pushed are the same bytes. The publish job accepts only records for its own inputs and commit, and only a layout that still has the recorded bytes. - `record` runs on pull requests too. Only the upload is for a `master` push. A pull request therefore runs the hand-off on real build output. - Publication order. The publish job pushes the four images by digest (`skopeo copy --preserve-digests`). It makes a candidate index for the slim variant, then one for the full variant that names the slim index in the annotation `io.paperclip.runner.slim-digest`. It verifies that each index names exactly the recorded images, attests both, and then writes `inputs-<digest>-slim` and, last, `inputs-<digest>`. - The full tag is the completion marker. Every "is it published" lookup reads the full tag. `publication-state` reports one of: | State | Registry | What a run does | | --- | --- | --- | | `absent` | Neither tag | Builds and publishes | | `incomplete` | The slim tag alone | Builds and publishes. It replaces the slim tag with its own image, then writes the full tag | | `published` | The full tag, and the slim tag at the digest that the full index names | Nothing | | broken | The full tag, and a slim tag that is missing or points at another image | Fails, with the steps for an operator | | `unknown` | No clear answer | Builds. The publish job fails before it writes a final tag | - Recovery rule. A run that stops between the two tags leaves the state `incomplete`. It does not block those inputs. The next run never keeps the earlier slim image: it writes its own slim tag immediately before its full tag, verifies both against its own index digests, and then reads the pair back as every later run will see it. The broken state cannot be repaired by a run, because no run moves a full tag. An operator must delete the two package versions and re-run the workflow run of a `master` push with those inputs. - Pairing rule for consumers, in the contract: resolve the full tag first, take the slim digest from the annotation of the full index, and pull the slim image by that digest. - `verify-index` accepts `linux/arm64` with the variant `v8`, which some BuildKit versions record, and no other variant. - `scripts/runner-image-publish.mjs` (533 lines): the commands `lock-state`, `record`, `verify-legs`, `publication-state` and `verify-index`. It reads archives with the reader of `scripts/runner-image-oci.mjs` (607 lines here), which can now read one named image of a layout. `lock-state` refuses a checkout, because pnpm can rewrite the lockfile of the tree that it checks. The workflow gives it an export that no build reads. - The workflow test pins the build arguments of the image build. Build arguments are not part of the image identity. - `doc/runner-image-contract.md` (197 lines): the section "Publication": the lockfile rule, the order, the pairing rule, the recovery rule, the create-only tags, the internal `candidate-` tags, the command that verifies provenance, and the step to make the package public. `doc/DOCKER.md` says where the image is published. ## Verification Tests, and the build jobs of the workflow on GitHub. Nothing in this pull request ran against a registry, and no publish job has run. - Linux (the pinned `node:24.22.3-bookworm` base with GNU tar 1.34 and zstd): `runner-image-publish.test.ts` (75), `runner-image-workflow.test.ts` (12), the three other Runner image test files, the provider pack archive tests and the existing Dockerfile tests: 372 tests pass in 10 files. The same files pass on macOS. - The tests of the leg record failed on Linux in the first runs of this pull request: their fixtures named the archive members `./index.json`, which bsdtar finds and GNU tar does not. The fixtures now name the members as buildx does, and the publish script uses the one reader of part 3. - Leg records: both variants are accepted for this run's inputs and commit; other inputs, another commit, a changed layout, a record without a variant, an archive that lacks a blob, a full image that does not start with the slim image's layers, and a build that is not a publication build are refused. - Publication state: all five states, and the half-finished publication end to end. A slim tag alone lets the next run publish. A full image that is left with another run's slim tag is reported as broken. - Index: exactly the recorded images of one variant; the full index must name its slim index, and the slim index must name none; `v8` is accepted on arm64 only. - Registry lookups: a missing tag only when the registry says so; every refused, failed, or unreachable request is `unknown`. - Workflow: job permissions; the publish job and the upload are behind the canonical `master` push; the build steps receive no credential; the full tag is written last, after a strict lookup and both attestations; one export and a time limit for each build command; the two build arguments; actions pinned by commit; no expression inside a shell script. - `record` on the two OCI archives of a real `linux/arm64` build from part 3: the joined layout is 850,149,376 bytes, and both images read back by name with every blob under its digest. The two archives together are 1,273,646,592 bytes. The image digests in the record are the digests that `unpack` reports for the trees that were checked. - `tests/runner-e2e` workflow tests: 39 pass. `node --test .github/scripts/tests/*.test.mjs`: 799 pass. `node --test` on the image contract scripts: 33 pass. `docker buildx build --check` reports nothing. The image identity is the same as in part 3 (`a544fc9dde780963419ede0f34252f3a57de43a760d41d3eb8fcd4f577504f6a`), because this pull request changes no input of the image. GitHub, at this head: - The `Runner image` workflow passes with these changes: `Build and check (amd64)` in 18m30s and `Build and check (arm64)` in 7m48s. Each leg builds both variants, checks them, and writes the leg record. `Publish and attest` is skipped, as it must be on a pull request. Never run: - The publish job. It runs only for a `master` push. - The publish path: the registry lookups with a workflow token, `skopeo copy` from `oci-archive:<layout>:<name>` by digest, `docker buildx imagetools create` with index annotations, and the tag writes. - The attestations, and the `gh attestation verify` command in the document. - `actionlint`. It is not installed on the local host. - The full test suite and the full typecheck. CI must supply them. ## Risks - **Manual step.** GitHub creates the `paperclip-runner` package private on the first publication. A maintainer must make it public one time. Until then, consumers cannot pull the image without credentials. - The first `master` runs of the workflow are the first test of the publish path. A failure before the tags publishes nothing. A failure between the two tags leaves the `incomplete` state, and the next run with those inputs repairs it. - A slim tag can move while its publication is incomplete. A consumer must resolve the full tag first and take the slim digest from the annotation of the full index. It must never resolve `inputs-<digest>-slim` by tag on its own. The contract says so. - `candidate-` tags are written before the attestations and can name an index that is not attested. They are internal. - The broken state needs an operator, and it fails every `master` run with those inputs until then. It can arise only when someone changes or deletes a tag outside the workflow. - **Known residual.** Two `master` runs that both start before a new digest is published can each build the image. Each build leg and the publish job look again before they work, and the publish job runs one at a time for each digest. The cost is runner time, not correctness. - A commit whose lockfile is behind the Runner's manifests has no published Runner image until the lockfile refresh merges. A lockfile that the refresh cannot fix leaves every `master` run green with only a notice, for as long as it lasts. - The tags are create-only because the workflow never moves a tag of a complete publication. The registry does not enforce that. Consumers must pin the digest and verify the attestation. - `payload.runnerSourceRevision` in a pack from this image is the commit that published the image. Code that reads it as the application's commit must change before it consumes the image. > For core feature work, check [`ROADMAP.md`](ROADMAP.md) first and discuss it in `#dev` before opening the PR. Feature PRs that overlap with planned core work may need to be redirected — check the roadmap first. See `CONTRIBUTING.md`. ## Model Used - Claude Fable 5.2 (`claude-fable-5-2`), Anthropic, used through Claude Code with tool use (shell, file edits, local Docker builds). ## Checklist - [x] I have included a thinking path that traces from project context to this change - [x] I have specified the model used (with version and capability details) - [x] I have checked ROADMAP.md and confirmed this PR does not duplicate planned core work - [x] I have searched GitHub for duplicate or related PRs and linked them above - [x] I have either (a) linked existing issues with `Fixes: #` / `Closes #` / `Refs #` OR (b) described the issue in-PR following the relevant issue template - [x] I have not referenced internal/instance-local Paperclip issues or links (only public GitHub `#NNN` / `github.com/paperclipai/paperclip` URLs) - [x] My branch name describes the change (e.g. `docs/...`, `fix/...`) and contains no internal Paperclip ticket id or instance-derived details - [x] I have run tests locally and they pass - [x] I have added or updated tests where applicable - [x] I have updated relevant documentation to reflect my changes - [x] I have considered and documented any risks above - [x] All Paperclip CI gates are green - [x] Greptile is 5/5 with no open P2s, recommendations, or follow-ups - [x] I will address all Greptile and reviewer comments before requesting merge 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Co-authored-by: Claude Fable 5.2 <noreply@anthropic.com>
198 lines
11 KiB
Markdown
198 lines
11 KiB
Markdown
# Runner image contract
|
|
|
|
The Runner image is the Runner built alone, as a plain file tree with no
|
|
entrypoint and no operating system. An image build copies paths out of it
|
|
instead of compiling the Runner again. Nothing in this repository consumes it
|
|
yet. Its name is `ghcr.io/paperclipai/paperclip-runner`, and one build makes
|
|
two variants:
|
|
|
|
- full, the `runner-artifacts` target of the `Dockerfile`: every path below;
|
|
- slim, the `runner-artifacts-slim` target: the same without the two paths
|
|
marked "full only", the provider pack's transport archives.
|
|
|
|
## Layout
|
|
|
|
Every path a consumer may copy (`RUNNER_IMAGE_PATHS` in
|
|
`scripts/runner-image-layout.mjs`). Every file is readable by every user.
|
|
|
|
| Path | Content |
|
|
| --- | --- |
|
|
| `/runner-image.json` | Identity and description of this image. |
|
|
| `/paperclip-runnerd` | The daemon. A stripped release binary, mode `0755`. |
|
|
| `/provider-pack/` | The remote provider pack, with `provider-pack.json`. |
|
|
| `/provider-pack.archive.json` | Full only. Receipt of the pack's transport archives. |
|
|
| `/provider-pack.archives/` | Full only. The transport archives the receipt lists. |
|
|
| `/runner-package/package.json` | The Runner package manifest. |
|
|
| `/runner-package/dist/` | The Runner's complete build output. `dist/bin/paperclip-runnerd` is the same file as `/paperclip-runnerd`. |
|
|
| `/runner-package/node_modules/.cache/paperclip-runner-build-inputs.json` | The build stamp the Runner's build recorded for that output. |
|
|
| `/runner-package/scripts/provision-grok.mjs` | Provisions the native Grok executable. Reads `platforms.json` by relative path. |
|
|
| `/runner-package/src/providers/grok/platforms.json` | The Grok release pins. |
|
|
| `/runner-package/src/live/runnerd-codex-transport.ts` | The transport source, as a contract file. It defines `RUNNER_CLIENT_VERSION`. |
|
|
| `/bundles/runnerd-codex-transport.mjs` | The pack's `dist/live/runnerd-codex-transport.js` as one module. It imports without `node_modules`. |
|
|
| `/pnpm-lock.yaml` | The lockfile the image was installed from. |
|
|
|
|
Paths under `/runner-package/` keep their place inside
|
|
`packages/paperclip-runner`. `runner-image.json` describes one platform, and
|
|
is the same file in both variants:
|
|
|
|
- `inputsDigest` (the identity below) and `buildInputsDigest` (the digest in
|
|
the Runner's build stamp);
|
|
- `sourceRevision`: the commit that built the image, also in the pack as
|
|
`payload.runnerSourceRevision`. An image is published once for its
|
|
inputs, so later commits with the same inputs keep this revision;
|
|
- `publication`: `true` only for a build with the build argument
|
|
`PAPERCLIP_RUNNER_IMAGE_PUBLICATION=1`. Only then does the pack carry the
|
|
identity, as `payload.runnerInputsDigest`. Another image build that runs
|
|
the stage inline builds the same Runner but is not this image;
|
|
- `platform` (`linux`, `amd64` or `arm64`) and `libc`: the glibc the daemon
|
|
was compiled on (Debian bookworm, the oldest a consumer runs) and the
|
|
newest glibc version it needs;
|
|
- `providerPack`: the pack's digest and target;
|
|
- `paths` and `sha256`: the table above, and the digest of every single file;
|
|
- `fullImageOnly`: the names in `paths` that only the full image has.
|
|
|
|
## Layers
|
|
|
|
1. The pack's dependency files of 1 MiB or more: provider binaries and Node.
|
|
2. Everything else, with `runner-image.json`.
|
|
3. Full only: the transport archive of each file in layer 1.
|
|
4. Full only: the other transport archives, the overlay archive, the receipt.
|
|
|
|
The slim image is layers 1 and 2. The full image is those same two layer
|
|
blobs, then layers 3 and 4, which hold transport content and nothing else.
|
|
Layers 1 and 3 have the same bytes in every build with the same dependency
|
|
files, so a new image shares them with the one before it. A large file under
|
|
the pack's `dist` is the Runner's own output: it and its archive are in
|
|
layers 2 and 4. An archive is named by its file's place in the receipt, which
|
|
lists the dependency files first, so their names do not depend on `dist`.
|
|
|
|
## Identity
|
|
|
|
Both variants are named by one digest: the variant is not part of the
|
|
identity. The full image has the tag `inputs-<digest>` and the slim image
|
|
`inputs-<digest>-slim`. `scripts/runner-image-identity.mjs` computes the
|
|
digest from:
|
|
|
|
- every file under the paths the build copies from the build context
|
|
(`RUNNER_IMAGE_CONTEXT_INPUTS`, which include `pnpm-lock.yaml`): path,
|
|
executable bit and content, and each symbolic link by its target;
|
|
- the whole `Dockerfile`: the recipe, the base image pinned by digest and the
|
|
toolchain pins. Any edit to it makes a new image;
|
|
- the two platforms, `linux/amd64` and `linux/arm64`.
|
|
|
|
The source revision is not part of it, and neither is the text of
|
|
`.dockerignore`: a rule changes the digest only when it changes which of
|
|
those files the build receives. The build computes the digest for itself:
|
|
|
|
```sh
|
|
docker buildx build --target runner-artifacts-identity --output type=local,dest=/tmp/identity .
|
|
jq -r .digest /tmp/identity/runner-image-identity.json
|
|
```
|
|
|
|
The install is frozen. It fails when the lockfile is behind the manifests the
|
|
build reads (the root one, `packages/paperclip-runner` and
|
|
`packages/paperclip-eval-kernel`). A contributor cannot edit the lockfile, so
|
|
pull-request runs resolve it first. For a local build, run
|
|
`pnpm install --resolution-only --ignore-scripts --no-frozen-lockfile`.
|
|
|
|
## Checks
|
|
|
|
CI builds each variant as an OCI archive and nothing else.
|
|
`node scripts/runner-image-oci.mjs unpack <oci archive> --out <tree>` writes
|
|
the tree of an image from its layers, so the tree CI checks is the bytes of
|
|
the image. It refuses a whiteout, an absolute or `..` path, a path written
|
|
twice and an entry behind a link.
|
|
|
|
`node scripts/runner-image-layout.mjs check <tree> --variant slim|full` runs
|
|
in the build and again on each unpacked tree. The variant has no default: a
|
|
slim tree with the transport paths fails, and so does a full tree without
|
|
them. The check fails unless:
|
|
|
|
- every documented path exists, matches its digest in `runner-image.json`,
|
|
and resolves inside the tree;
|
|
- the build stamp names the inputs the identity names;
|
|
- every artifact in `provider-pack.json` has its digest, the `dist` tree and
|
|
each provider asset tree match their tree digests, and the pack names this
|
|
image's revision and platform;
|
|
- the pack names the inputs digest in a publication build and in no other.
|
|
`--expect-inputs-digest` fails on any other build;
|
|
- in a full image, every transport archive matches its receipt, and the
|
|
archives extract to the pack. The check extracts them as a sandbox does (GNU tar
|
|
with the options in `provider-pack-layers.ts`) and compares paths, content,
|
|
link targets and all twelve permission bits, after the `a+rX` grant the
|
|
build makes once the archives are written.
|
|
|
|
`node scripts/runner-image-oci.mjs check-layers --slim <oci archive> --full <oci archive>`
|
|
checks "Layers" on the two archives, and that no file is in two layers.
|
|
|
|
The build also runs `paperclip-runnerd --build-metadata` on every base image
|
|
in `docker/runner-image/Dockerfile.smoke`. Add a base there before a consumer
|
|
uses it.
|
|
|
|
## Consuming the image
|
|
|
|
Read the image only with `COPY --from`, and pin it by digest:
|
|
|
|
```dockerfile
|
|
FROM ghcr.io/paperclipai/paperclip-runner@sha256:<digest> AS runner-artifacts
|
|
FROM debian:trixie-slim
|
|
COPY --from=runner-artifacts /paperclip-runnerd /usr/local/bin/paperclip-runnerd
|
|
```
|
|
|
|
A Dockerfile with a `runner-artifacts` or `runner-artifacts-slim` stage of
|
|
its own, as in this repository, can take a built image or tree in its place
|
|
with `--build-context <stage>=<image or directory>`. The stage is then not
|
|
built.
|
|
|
|
## Publication
|
|
|
|
`.github/workflows/runner-image.yml` publishes on a `master` push in this
|
|
repository and nowhere else. Other runs build and check, and publish nothing.
|
|
|
|
- **Lockfile.** A `master` push builds from the committed `pnpm-lock.yaml`,
|
|
so the digest is a function of the commit. When that file is behind the
|
|
Runner's manifests, the run writes a notice, publishes nothing and stays
|
|
green. The commit that merges the lockfile refresh publishes the image.
|
|
- **Once.** The build runs only when `inputs-<digest>` does not exist.
|
|
- **Verified bytes.** The build legs cannot write to the registry. The
|
|
publish job pushes the images they checked by digest and joins each
|
|
variant into a multi-platform index under a `candidate-` tag. It attests
|
|
both indexes, and only then writes the two `inputs-` tags. `candidate-`
|
|
tags are internal: one can name an index that is not attested, and the
|
|
next run overwrites it. Do not consume them.
|
|
- **Order.** It writes `inputs-<digest>-slim` first and `inputs-<digest>`
|
|
last, so the full tag marks a complete publication. The full index names
|
|
its slim index in the annotation `io.paperclip.runner.slim-digest`.
|
|
- **Pairing.** Resolve the full tag first. Take the slim digest from that
|
|
annotation of the full index, and pull the slim image by that digest. Never
|
|
resolve `inputs-<digest>-slim` by tag on its own: while a publication is
|
|
incomplete, that tag can name the slim image of another run.
|
|
- **Recovery.** A run that stops between the two tags leaves a slim tag
|
|
alone. Those inputs are not published. The next run for them builds again,
|
|
replaces that tag with its own slim image and then writes the full tag. A
|
|
full tag whose slim tag is missing or names another image fails every run
|
|
for those inputs. An operator must then delete both package versions and
|
|
re-run the workflow run of a `master` push with those inputs.
|
|
- **Create-only.** The workflow never moves a tag of a complete publication,
|
|
but the registry does not enforce that. Pin the index digest and verify it:
|
|
`gh attestation verify oci://ghcr.io/paperclipai/paperclip-runner@sha256:<digest> --repo paperclipai/paperclip --signer-workflow paperclipai/paperclip/.github/workflows/runner-image.yml --source-ref refs/heads/master`
|
|
- **First publication.** GitHub creates the package private. A maintainer
|
|
must make it public once.
|
|
|
|
## Known limits
|
|
|
|
- A build without `PAPERCLIP_RUNNER_SOURCE_REVISION` or
|
|
`PAPERCLIP_BUILD_COMMIT` has no pack. It is for local use.
|
|
- The build runs the steps of the Runner's `build` script that write output,
|
|
not its drift checks; repository CI runs those.
|
|
- A build that vendors `/runner-package/` reuses `dist` only when its own
|
|
Runner build-inputs digest equals the stamp's. The image computes that
|
|
digest in the `.dockerignore`-filtered context; a checkout gives another.
|
|
- `# syntax=docker/dockerfile:1.20` is a tag. A new frontend release under it
|
|
does not change the identity.
|
|
- The archive check does not tell a directory with its own archive member
|
|
from one created only as a file's parent.
|
|
- A lockfile that the lockfile refresh cannot bring up to the Runner's
|
|
manifests leaves every `master` run green with only a notice, for as long
|
|
as it lasts. No image is published in that time, and nothing fails.
|