Skip to content

[DOCS] - Improve image pull secrets documentation clarity

Aaron Johnson requested to merge acjohnson1985/gitlab-runner:imagesecretdoc into main

What does this MR do?

I recently ran across this issue comment from 2 years ago gitlab#20467 (comment 215095526) because I was having trouble getting the gitlab helm chart to properly configure the kubernetes executor to use a private docker registry. Once I found the above comment I was able to configure the helm chart properly.

It would be nice if the official documentation was clearer on these values/parameters so that configuring the kubernetes executor with private registry credentials is a more obvious procedure in the future.

This MR attempts to clarify the different options for configuring the kubernetes executor.

Related issues

gitlab#20467 (comment 215095526)

Author's checklist

To avoid having this MR be added to code verification QA issues, don't add these labels: ~"feature", frontend, backend, ~"bug", or database

Review 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.
    • If relevant to this MR, ensure content topic type principles are in use, including:
      • The headings should be something you'd do a Google search for. Instead of Default behavior, say something like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure GDK.
      • Any task steps should be written as a numbered list.
  • Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  • Ensure a release milestone is set.

Merge request reports