Confusing documentation examples regarding helpers

[neidiom]

https://www.nomadproject.io/docs/drivers/docker/

First example is

plugin "docker" {
  config {
    endpoint = "unix:///var/run/docker.sock"

    auth {
      config = "/etc/docker-auth.json"
      helper = "docker-credential-aws"
    }
}

where docker-credential-aws is used

then we go to

The script's name must begin with docker-credential- and this option should include only the basename of the script, not the path.

where it states that it has to start with docker-credential- keywords

then we go to

client {
  enabled = true
}

plugin "docker" {
  config {
    auth {
      # Nomad will prepend "docker-credential-" to the helper value and call
      # that script name.
      helper = "ecr"
    }
  }
}

where it says that Nomad will prepend "docker-credential-" to the helper value.

Am I missing something?

[shoenig]

Thanks for reporting, @neidiom !

I believe the first example is a documentation bug. Looks like the driver always prepends the docker-credential- prefix.

Would you like to open a quick PR to fix that first example?

[tgross]

Possibly related: #7357

[tgross]

Fixed in #8913 and #7801

[github-actions]

I'm going to lock this issue because it has been closed for 120 days ⏳. This helps our maintainers find and focus on the active issues.
If you have found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.