release notes: add known issue for CLI login address normalization #20739
Conversation
github-actions
bot
added
the
area/desktop
✅ Deploy Preview for docsdocker ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
| - There is a known issue when authenticating against a registry in the Docker CLI (`docker login [registry address]`) where, if the provided registry address includes a repository/image name (such as `docker login index.docker.io/docker/welcome-to-docker`), the repository part (`docker/welcome-to-docker`) is not normalized and results in credentials being stored incorrectly, which causes subsequent pulls from the registry (`docker pull index.docker.io/docker/welcome-to-docker`) to not be authenticated. To prevent this, don't include any extraneous suffix in the registry address when running `docker login`. | ||
|
|
There was a problem hiding this comment.
Do we need to call out that this was undocumented behavior, and the expected argument is the name of the registry( hostname (with optional port) hostname[:port]), so that users are recommended to use that format,
or would that be too much info?
cc @dvdksn (in case you have too suggestions for wording)
We should probably also have a note in the engine release notes
There was a problem hiding this comment.
I considered that, then decided against it since it didn't feel super relevant to this section (listing known issues). I'm happy to change it though, I don't feel super strongly about it.
Adding it to the engine release notes makes sense – I'd also considered a little (temporary) callout in the CLI docs for docker login, or maybe a not-temporary one explaining that the expected input there is not to include anything but the registry hostname/port. Actually, that makes even more since now since we know some users are doing this (Gitlab).
There was a problem hiding this comment.
Let me add a blurb so we can discuss wording.
There was a problem hiding this comment.
Did we add release notes for 27.2?
laurazard
force-pushed
the
add-release-login-callout
branch
from
d423364 to
c6bc744
Compare
Signed-off-by: Laura Brehm <laurabrehm@hey.com>
laurazard
force-pushed
the
add-release-login-callout
branch
from
c6bc744 to
82366da
Compare
|
Included the suggested changes, PTAL @dvdksn @thaJeztah |
|
(let's try to get this merged soon so people running into this can find it). |
3 participants
Description
Added known issue for CLI login address normalization issue.
docker/cli#5382
More info in: docker/cli#5383
Reviews