docker / docker/cli

Clarify "reference" in filters for `docker images`

Open
#3,654 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

kind/docs kind/enhancement
Dominant language
Go
Stars
6.1k
Forks
2.2k
Avg merge
1d 15h
Merged PRs (30d)
43

Description

This is possibly related to (though not the same as) #1332, "docker images --filter=reference giving seemingly unpredictable results." It's a copy of issue #7618 in docker/docker.github.io which was just now closed because I'm told it belongs here. Note that #1332 and this issue date from late 2018 with no response, yet still seem to be relevant.

There's no clear explanation of how to filter based on repository or tag. We can filter by "reference," which seems to do something similar, but it doesn't seem to work intuitively: dr images -f reference=*acme* will not list images with a repository field of docker-registry.ec2-1.acme.com:5000/acme/user.

The documentation should explain what a "reference" is how it relates to the repository and tag.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the Docker CLI documentation for docker images --filter=reference and review how repository and tag filters are described. Done means the documentation clearly defines a reference and explains how it relates to repository and tag matching, including the reported registry example.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker
Domain
cli, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.