Skip to content

Add DinD example note for k8s executors

Kyle Russell requested to merge bkylerussell/gitlab-ce:dind-example-doc into master

What does this MR do?

Documentation improvement to docker-in-docker CI example when running under a Kubernetes environment.

The example recommends a method for testing a docker-in-docker image across stages in a gitlab pipeline, which may not work as expected by default in Kubernetes when the image is stored in the container registry using $CI_COMMIT_REF_SLUG. $CI_COMMIT_REF_SLUG may not change across multiple pipeline runs on a given branch, so while the generated image may be updated in the container registry, the default Kubernetes executor pull_policy won't pickup these updates by default.

Related issues

Author's checklist

  • Follow the Documentation Guidelines and Style Guide.
  • Link docs to and from the higher-level index page, plus other related docs where helpful.
  • Apply the ~Documentation label.

Review checklist

All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.

1. Primary Reviewer

  • Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.

2. Technical Writer

  • Optional: Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.

3. Maintainer

  1. Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  2. Ensure a release milestone is set and that you merge the equivalent EE MR before the CE MR if both exist.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.
Edited by Evan Read

Merge request reports