Add runner prerequisites for dependency scanning auto-remediation
What does this MR do?
Adds the runner prerequisites for dependency scanning auto-remediation, and documents that the merge request is only created after the auto-remediation pipeline succeeds.
The Prerequisites section currently covers dependency scanning being enabled, a supported package manager and an attached profile, but says nothing about runners. The auto-remediation job is generated by GitLab rather than read from the project's .gitlab-ci.yml, and it has three requirements that a managed runner fleet does not necessarily meet:
- Untagged jobs.
Ci::Workloads::WorkloadDefinition#to_job_hashonly emitstagswhen they are set, andDependencyManagement::SecurityUpdate::UpdateServicenever sets them. The generated job is therefore untagged, and only a runner that accepts untagged jobs picks it up. BecauseCi::Workloads::RunWorkloadServicepasses generatedcontentintoCi::CreatePipelineService, the project's.gitlab-ci.ymlis never read, sodefault:tagshas no effect. - Privileged mode.
UpdateService::SERVICESisdocker:28-dind, withDOCKER_HOSTandDOCKER_TLS_CERTDIRset as job variables. This is hard-coded with no opt-out. - Image pulls. The runner needs to reach
registry.gitlab.com/security-products/dependency-management/orchestrator:0and thedocker:28-dindimage.
This MR also adds a Known issues entry: UpdateService#execute calls create_or_update_source_branch before create_workload, so the dependency-management/* branch exists before the pipeline runs, and CreateMergeRequestService bails out on pipeline.complete? && pipeline.success?. A branch that appears with no merge request and no manifest commit therefore means the pipeline did not succeed.
Related issues
- Runner targeting for the generated job is proposed in #627504 (closed), so that
tagscan be set through the profile or a project setting. - Non-privileged execution is proposed in #627505.
- Roadmap: &19244
Raised from customer feedback that the documentation was incomplete (internal: ZD 16198).
Note for the technical writer
The Known issues entry is behavioral rather than a prerequisite. It may read better as a short troubleshooting subsection instead. Please make that call in review, and move it if you prefer.
Author's checklist
- Follow the:
- If you're adding a new page, add the product availability details under the H1 topic title. Not applicable, no new page.
- If you are a GitLab team member, request a review based on:
- The documentation page's metadata.
- The associated Technical Writer.
Reviewer's checklist
Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.
- If the content requires it, ensure the information is reviewed by a subject matter expert.
- Technical writer review items:
- Ensure docs metadata is present and up-to-date.
- Ensure the appropriate labels are added to this MR.
- Ensure a release milestone is set.
- Review by assigned maintainer.