Loading
docs(user): document Artifact Registry images in CI/CD jobs (monolith/S16 plan: 4/6)
Summary
- Problem: monolith/S16 lets a CI job pull an Artifact Registry image in
image:orservices:with the job's own identity, but the user documentation does not say so, nor when it does not apply. - Impact: users of Artifact Registry container repositories in CI/CD; nothing changes in the service.
- Change: Step 4 of the monolith/S16 plan:
docs/user/formats/docker.mdgains "Use an image in a CI/CD job".- The history block and the feature flag note for
ci_artifact_registry_pull_credentials, off by default. - Who the job pulls as, the prerequisites (organization member, Artifact Viewer or higher, an executor other than Kubernetes), and an example with
image:andservices:. - The image must name the Artifact Registry host and port exactly, and a user's own
DOCKER_AUTH_CONFIGentry for the host wins. - "When a job gets no credential": a non-member, another organization, the Kubernetes executor or an unreported one, with
DOCKER_AUTH_CONFIGor Kubernetes pull secrets as the way out, and what a refused pull looks like. - "Cached images on shared runners":
if-not-presentand the runner security guidance.
- The history block and the feature flag note for
- Downsides: the page describes a feature behind a flag that is off by default; Step 6 removes the flag note once the flag is gone.
Steps 1 to 3 are merged: gitlab-org/gitlab!268444 (merged), !3816 (merged) and !3934 (merged).
Checklist
- Ran it: n/a, documentation only. The page's links, Vale, markdownlint and rumdl pass in the hooks.
- Interfaces and data: none; it documents the payload credential Step 1 (gitlab-org/gitlab!268444 (merged)) added.
- Failure: n/a; the page names what a job sees when it gets no credential.
- Rollout: n/a; the page carries the feature flag note.
- Hot path: no.
- Database: no.
- Security: no service change; the page points to the runner security guidance for cached private images on shared runners.
- ADRs: ADR-020 (the token the credential carries) and ADR-021 (the job's user's grant decides), which the page's prerequisites follow.
- E2E: none; Step 3 covers the rows the page describes.
- Simplicity: one section on the existing Docker page rather than a new page, since the feature only applies to container images.
Closes #1865 (closed)
Edited by Daniel Prause