Skip to content

Update docs references to docker and docker-dind images

What does this MR do?

Update all doc references to docker:<version> and docker:<version>-dind images.

As a user, I was quite confused after copy pasting CI pipeline examples from the docs to use, as the docker build DinD examples would contain something like:

image: docker:24.0.5
services:
  - docker:24.0.5-dind

The way that is set up implies that we want two different images for the job container itself and the service container. However, in current docker images the image tags with no-suffix and with -dind suffix are exactly the same image.

Proposed change: Looking at the top of the docker image's description I think what would make more sense is that the job container image should be the -cli variant and the service should be the -dind variant (that has additional content for the docker daemon on top of the -cli image). The job's script only requires the docker cli tools but not the docker daemon, and the service is the one that requires the docker daemon, so this makes sense.

Since I searched through all the doc pages to look for references to the docker images, I have made an additional change to all the pages to use the latest version of Docker as well, instead of standardizing on the 24.0.5 that seems commonly used. I would much prefer to just say docker:cli and docker:dind to not have this constant issue of suggesting outdated Docker versions to users, but one of the doc pages specifically recommends to pin a specific version of Docker, so I'm following that convention.

Related issues

Author's checklist

If you are a GitLab team member and only adding documentation, do not add any of the following labels:

  • ~"frontend"
  • ~"backend"
  • ~"type::bug"
  • ~"database"

These labels cause the MR to be added to code verification QA issues.

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 you aren't sure which tech writer to ask, use roulette or ask in the #docs Slack channel.

  • 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.
    • 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.
      • If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
  • Review by assigned maintainer, who can always request/require the reviews above. Maintainer's review can occur before or after a technical writer review.
Edited by Chiang Fong Lee

Merge request reports

Loading