Loading
docs(plans): plan the monolith S16 CI job image pull credentials
Summary
- Change: the implementation plan for monolith/S16: GitLab adds an Artifact Registry credential to the CI job payload, so a runner pulls an Artifact Registry image in
image:orservices:with the job's identity. One GitLab Rails step behind a project flag, then the e2e rows and scenarios, the user docs, the flag removal and the docs' flag note: 6 steps. - Why: see the spec.
- Downsides: the token cannot be revoked and lives up to the job's timeout (12 hours at most), which AppSec accepted as an interim with two follow-ups (#1691, #1771). The e2e scenarios prove the credential against Artifact Registry, not that a real GitLab Runner applies it; the tracking item's reproduction covers that.
Checklist
- Risk first: Step 1, the only code step: it runs on every job request. It goes first and stays behind a flag that is off by default; the cheap conditions run before the database checks and the signature, and an error from a database check or the issuer is caught inside the credential, so a job request never fails because of it.
- Conflicts: the credential factory and the runner job request spec are Verify-owned and see other changes; Step 1 adds an EE extension point instead of editing the provider list, so it collides only on the factory's few lines.
- Reach: Verify (
group::pipeline execution) reviews Step 1, as owners of the job payload. No other service changes: GitLab.com's Artifact Registry already accepts the token, and runners need no release. AppSec has reviewed the token lifetime on the spec. - Coverage: every S16 acceptance criterion has a step: 1 to 6 in Step 1; 7 and 8 only in part in Steps 2 and 3, since the harness pulls in place of a GitLab Runner, which Step 3's limitations entry records. The spec's follow-ups stay outside this plan: #1691, #1771, ops/artifact-registry#229, gitlab#634871, gitlab#599087.
- Least sure: the cost on the job request path once Step 5 removes the flag: every job on a non-Kubernetes runner in an organization without Artifact Registry pays one indexed read of the namespace mapping. If
present_buildlatency moves as the flag widens, caching activation is the place to revisit.
Related to gitlab-org/gitlab#630573
Edited by Daniel Prause