Add login command to container registry empty state message

Problem to solve

@lbot in Slack suggested:

Add a step to [the container registry empty state content]: docker login <gitlab instance registry url>. Last night I wanted to add an image to my repo registry. I saw the [container registry empty state content]. It said run those two things. I ran the first, and got a 403. Then I realized, I wasn't logged in. If it said "log in to this registry if you haven't already" I suspect others wouldn't be met with that micro friction of an easily avoidable error

This makes total sense to me and I feel this would be a good addition to the empty state component, giving a new user all the necessary steps to push their first image in one place (and a link to further documentation for more reading).

Intended users

• Sasha (Software Developer)
• Devon (DevOps Engineer)

Proposal

Add the docker login [url] command to the empty state content.

What does success look like, and how can we measure that?

The empty state component provides all the commands for a first time user to push an image.

changed milestone to %12.4

added UX devopspackage frontend grouppackage registry typefeature labels

changed weight to 1

@trizzi @icamacho What are your thoughts on this? I think it's a worthwhile addition and something we could add fairly quickly.

@nkipling I think this is great! Do you need any direction or a comp from me to move forward?

I was thinking something like this:

@nkipling This is great! 🚀 I would we separate out the login from the add as follows:

Quick Start

If you are not already logged into Docker, run the following command:

docker login 127.0.0.1:5000

Once logged in, you can add an image to this registry with the following commands:

docker build...

docker push...

Thoughts?

Looks good to me! 👍 @lbot what are your thoughts?

@axil - Would you mind taking a look at this copy as well?

@icamacho @nkipling we should clarify what credentials the user should use. What about:

If you are not already logged in, run the following command to authenticate to the Container Registry (use your GitLab username and password when asked):

One other thing to consider though, is that if you have 2FA enabled, you have to use a personal access token instead of your password. I guess we can mention this somewhere here, it would span in multiple lines, not sure how that would look.

Here's the error message you will get if you try to login with a passwd while 2FA is enabled:

Error response from daemon: Get https://registry.gitlab.com/v2/: unauthorized: HTTP Basic: Access denied\nYou must use a personal access token with 'api' scope for Git over HTTP.\nYou can generate one at https://gitlab.com/profile/personal_access_tokens

Another copy with the 2FA note:

If you are not already logged in, you need to authenticate to the Container Registry by using your GitLab username and password. If you have Two-Factor Authentication enabled, use a personal access token instead of a password.

@axil - Thanks for calling that out! I like the updated copy. I've heard users stumble over the 2-factor auth aspect so calling it out early is great!

Yeah, and I realized we don't document that almost nowhere 😢 I added it to the list of items to refactor.

@nkipling I'll get some time on your calendar next week to 🍐 on this. I'm keen to get it in as it's pretty straight forward. 🤘

Thanks for opening this issue! I think it makes total sense and something we should do.

added [deprecated] Accepting merge requests label

added UI text label

mentioned in issue #32971 (closed)

added Category:Container Registry label

If this issue is still up for grabs, I'd love to take this one on!

Pretty much done with this already short of a few follow up questions I have below:

• Should the new copy be italicized or have some other differentiating style?
• where should the Two-Factor Authentication link go?
• where should the personal access token link go?

Hi @n8rzz, thanks for taking a look and thanks for the MR! 👍 My suggestion would be to use these two links:

• Two Factor Auth
• Personal Access Tokens

I've added a comment to your MR with a suggestion on how to add these.

mentioned in commit n8rzz/gitlab@34bb3df8

mentioned in merge request !18244 (merged)

mentioned in commit n8rzz/gitlab@3cc72f75

mentioned in commit n8rzz/gitlab@a2fb2887

mentioned in commit n8rzz/gitlab@053a6565

mentioned in commit n8rzz/gitlab@802c075b

added Community contribution label

changed milestone to %12.5

added missed-deliverable missed:12.4 labels

added Deliverable label

closed via merge request !18244 (merged)

mentioned in commit 9d509ee4

mentioned in commit 760cc92c

mentioned in merge request !17615 (merged)

mentioned in commit Dalahro/gitlab@4d1a3d31

marked this issue as related to #32669 (closed)