Skip to content

Docker. Don't use version numbers with docker commands #770

@mjang

Description

@mjang

Describe the bug

Ref https://docs.nginx.com/nginx/admin-guide/installing-nginx/installing-nginx-docker/#use-official-nginx-plus-docker-images

The commands lead to errors, specifically:

Error response from daemon: pull access denied for private-registry.nginx.com/v2/nginx-plus/agent, repository does not exist or may require 'docker login': denied: <html>
<head><title>403 Forbidden</title></head>
<body>
<center><h1>403 Forbidden</h1></center>
<hr><center>nginx/1.27.4</center>
</body>
</html>

The command works without a v2. But in some cases, users will want the v2

To reproduce

Run commands in https://docs.nginx.com/nginx/admin-guide/installing-nginx/installing-nginx-docker/#use-official-nginx-plus-docker-images

Expected behavior

A clear and concise description of what you expected to happen.

Additional context

As noted internally:

that doc is for if you are using the docker REST API. See example curl command https://docs.nginx.com/nginx/admin-guide/installing-nginx/installing-nginx-docker/#list-all-tags

If you are doing a docker pull private-registry.nginx.com/nginx-plus/agent:debian will get you an agent v2 image and private-registry.nginx.com/nginx-plus/agentv3:debian will get you agent v3 image

Open question

Does this apply just to the link or is this a general problem. Should we add something to our style guide and/or set up an automated rule? Or am I "overthinking" this issue?

Possible solution:

Common explanation (with an include):

  • When to omit version (in this case v2)
  • When to use a version

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions