Draft: Document private package registry authentication
Stack, in merge order:
- updater !208
- orchestrator !67
- orchestrator !68
- orchestrator !62
- gitlab !256224 (merged)
- gitlab !264336 (merged)
- gitlab !264337
- docs !256327 (this MR)
Merge notes
- Different repositories can merge in parallel. Within a repository, keep the order above.
- Tag an updater release after !208 and an orchestrator release after !62.
- Keep
dependency_management_registry_credentialsoff. Nothing is active in production until it is on and the proxy is enabled. - Merge the docs last, after !264336 (merged), the orchestrator release and enabling the proxy.
Documents the registries key of .gitlab/dependency_management.yml for #624431. The code is in the stack starting at !256224 (merged).
Covers the file schema, the DS_AUTO_REMEDIATION_ prefix the referenced CI/CD variables must use, why such a variable has to be unprotected with a * environment scope, and the guidance to provision a dedicated read-only token rather than reusing one that can also publish. The section carries the history entry and flag alert for dependency_management_registry_credentials, which is off by default.
It also says the new variables are unrelated to DS_REMEDIATE and DS_REMEDIATE_TIMEOUT from legacy dependency scanning, since the names are close.
When to merge
After !264336 (merged) (which adds the flag), an orchestrator release that substitutes the placeholders (gitlab-org/security-products/dependency-management/orchestrator!62), and the proxy being enabled (#581992). Until all three are in, an administrator who enables the flag would put the variable into the job and authenticate nothing.
Technical writer review is welcome now.