GitLabgitlab-org
cli
main
1// Package docker provides commands that help configure a docker
2// credential helper.
3package docker
5import (
6 "fmt"
8 "github.com/MakeNowJust/heredoc/v2"
9 "github.com/docker/docker-credential-helpers/credentials"
10 "github.com/spf13/cobra"
12 "gitlab.com/gitlab-org/cli/internal/api"
13 "gitlab.com/gitlab-org/cli/internal/cmdutils"
14 "gitlab.com/gitlab-org/cli/internal/mcpannotations"
15)
17// NewCmdConfigureDocker returns a command that configures the CLI
18// as a Docker credential helper.
19func NewCmdConfigureDocker(f cmdutils.Factory) *cobra.Command {
20 cmd := &cobra.Command{
21 Use: "configure-docker",
22 Args: cobra.NoArgs,
23 ValidArgsFunction: cobra.NoFileCompletions,
24 Short: "Register glab as a Docker credential helper.",
25 Long: heredoc.Docf(`
26 Configures Docker to use glab for authentication with GitLab
27 container registries. This command runs only on Linux and macOS.
29 After you run this command, Docker uses glab to obtain credentials
30 when it pulls from or pushes to a GitLab container registry.
32 Docker looks for the credential helper script by name on your %[1]sPATH%[1]s. By default, glab installs the script next to the glab binary. If that directory is not writable, glab falls back to %[1]s~/.local/bin%[1]s, then to any other writable directory on your %[1]sPATH%[1]s. If the script lands in a directory that is not on your %[1]sPATH%[1]s, glab tells you which directory to add.
33 `, "`"),
34 Example: heredoc.Doc(`
35 # Configure Docker to use glab for GitLab container registry authentication
36 glab auth configure-docker
37 `),
38 Annotations: map[string]string{
39 mcpannotations.Destructive: "true",
40 },
41 RunE: func(cmd *cobra.Command, args []string) error {
42 io := f.IO()
43 cfg := f.Config()
44 return configureDocker(io, cfg)
45 },
46 }
47 return cmd
48}
50// NewCmdCredentialHelper returns a command that handles Docker credential
51// requests.
52func NewCmdCredentialHelper(f cmdutils.Factory) *cobra.Command {
53 cmd := &cobra.Command{
54 Use: "docker-helper",
55 ValidArgs: []cobra.Completion{"store", "get", "erase"},
56 Args: cobra.MatchAll(
57 helperArgCheck,
58 cobra.OnlyValidArgs,
59 ),
60 Short: "A Docker credential helper for GitLab container and artifact registries.",
61 Long: heredoc.Doc(`
62 Responds to Docker credential helper requests for GitLab container
63 registries and Artifact Registries. Docker invokes this command
64 automatically.
65 `),
66 Example: heredoc.Doc(`
67 # Docker invokes the helper automatically; supported actions are 'store', 'get', and 'erase'.
68 # Retrieve the stored credentials for a registry:
69 echo registry.gitlab.com | glab auth docker-helper get`),
70 Annotations: map[string]string{
71 mcpannotations.Destructive: "true",
72 },
73 RunE: func(cmd *cobra.Command, args []string) error {
74 // Only the default host's transport is used here. Each registry
75 // lookup reads its own host's credentials, so a missing default-host
76 // token must not block a registry on another host.
77 apiClient, err := api.NewClientFromConfig(f.DefaultHostname(), f.Config(), false, f.BuildInfo().UserAgent(), api.WithoutAuthentication())
78 if err != nil {
79 return err
80 }
82 httpClient := apiClient.HTTPClient()
84 credHelper := Helper{
85 client: httpClient,
86 cfg: f.Config(),
87 io: f.IO(),
88 userAgent: f.BuildInfo().UserAgent(),
89 ctx: cmd.Context(),
90 }
92 action := args[0]
93 return credentials.HandleCommand(&credHelper, action, f.IO().In, f.IO().StdOut)
94 },
95 }
96 return cmd
97}
99func helperArgCheck(cmd *cobra.Command, args []string) error {
100 validation := cobra.ExactArgs(1)
101 if err := validation(cmd, args); err != nil {
102 return fmt.Errorf("arg is missing - valid args: %s", cmd.ValidArgs)
103 }
104 return nil
105}
Diagnostics8 git calls · 230 ms
CallStatusSizeTime0230 ms
discover200185 B2 ms
git.upload-pack discover http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=ls-refs git.upstream.dur_ms=2 git.response.bytes=185 git.server.agent=git/2.56.g1891de4-Linux git.server.object_format=sha1 git.server.caps=agent ls-refs fetch server-option object-format git.server.fetch=shallow wait-for-done filter git.protocol.version=2 git.pkt.frames=9 git.pkt.data=7 git.pkt.flush=2 git.pkt.delim=0 git.pkt.bytes=185 git.pkt.payload.max=35
ls-refs20058 KiB3 ms
git.upload-pack ls-refs http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=ls-refs git.upstream.dur_ms=2 git.response.bytes=59849 git.response.cache=UPDATING git.response.duration_ms=3 git.protocol.version=2 git.pkt.frames=731 git.pkt.data=730 git.pkt.flush=1 git.pkt.delim=0 git.pkt.bytes=59849 git.pkt.payload.max=143 git.ls_refs.count=730 git.ls_refs.head=refs/heads/main
fetchtree:0 · deepen 1020032 KiB · hit1 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=1 git.response.bytes=32926 git.response.cache=HIT git.response.duration_ms=1 git.fetch.filter=tree:0 git.fetch.wants=0dd7574dce9e385c5c30540e6c15657adc6bdce9 git.fetch.haves.count=0 git.fetch.deepen=10 git.fetch.thin_pack=false git.fetch.ofs_delta=true git.protocol.version=2 git.pkt.frames=22 git.pkt.data=20 git.pkt.flush=1 git.pkt.delim=1 git.pkt.bytes=32926 git.pkt.payload.max=32046 git.sideband.band1.bytes=32046 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0 git.pack.objects=80 git.pack.bytes=32046 git.pack.ofs_delta=36 git.pack.ref_delta=0 git.pack.chain.max=2 git.pack.trailer=cb0bad5d7ffc514895d8b21c4dd470327f90bc91 git.pack.full=44Open pack map
fetchcombine:blob:none+tree:2 · deepen 12004.2 KiB · hit3 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=3 git.response.bytes=4273 git.response.cache=HIT git.response.duration_ms=3 git.fetch.filter=combine:blob:none+tree:2 git.fetch.wants=0dd7574dce9e385c5c30540e6c15657adc6bdce9 git.fetch.haves.count=0 git.fetch.deepen=1 git.fetch.thin_pack=false git.fetch.ofs_delta=true git.protocol.version=2 git.pkt.frames=7 git.pkt.data=5 git.pkt.flush=1 git.pkt.delim=1 git.pkt.bytes=4273 git.pkt.payload.max=4173 git.sideband.band1.bytes=4173 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0 git.pack.objects=11 git.pack.bytes=4173 git.fetch.wide.objects=11 git.fetch.wide.extra_bytes=3930 git.fetch.wide.blobs=0
fetchtree:02001.8 KiB · hit3 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=3 git.response.bytes=1857 git.response.cache=HIT git.response.duration_ms=3 git.fetch.filter=tree:0 git.fetch.wants=dce174ff8c632a19d17eea99c8a9b7c37fb2b592 git.fetch.haves.count=0 git.fetch.deepen=0 git.fetch.thin_pack=false git.fetch.ofs_delta=true git.protocol.version=2 git.pkt.frames=4 git.pkt.data=3 git.pkt.flush=1 git.pkt.delim=0 git.pkt.bytes=1857 git.pkt.payload.max=1830 git.sideband.band1.bytes=1830 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0 git.pack.objects=1 git.pack.bytes=1830 git.pack.trailer=fb03183b7909876778f740d196d7516811003517Open pack map
fetchtree:0200358 B · hit2 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=2 git.response.bytes=358 git.response.cache=HIT git.response.duration_ms=2 git.fetch.filter=tree:0 git.fetch.wants=5d783fac547a70b19ca138c47d067b44febb52da git.fetch.haves.count=0 git.fetch.deepen=0 git.fetch.thin_pack=false git.fetch.ofs_delta=true git.protocol.version=2 git.pkt.frames=4 git.pkt.data=3 git.pkt.flush=1 git.pkt.delim=0 git.pkt.bytes=358 git.pkt.payload.max=331 git.sideband.band1.bytes=331 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0 git.pack.objects=1 git.pack.bytes=331 git.pack.trailer=22a484e5ecad6d6e62b224e8a7f90cf5ff085938Open pack map
fetchtree:0200352 B · hit3 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=3 git.response.bytes=352 git.response.cache=HIT git.response.duration_ms=3 git.fetch.filter=tree:0 git.fetch.wants=078b54e79fa23822972abf99b4c28a7b8a3e2806 git.fetch.haves.count=0 git.fetch.deepen=0 git.fetch.thin_pack=false git.fetch.ofs_delta=true git.protocol.version=2 git.pkt.frames=4 git.pkt.data=3 git.pkt.flush=1 git.pkt.delim=0 git.pkt.bytes=352 git.pkt.payload.max=325 git.sideband.band1.bytes=325 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0 git.pack.objects=1 git.pack.bytes=325 git.pack.trailer=756e6cebb5c15b5cd4bd8e9270eb683dbb54a67cOpen pack map
fetch2001.5 KiB216 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=216 git.response.bytes=1517 git.response.cache=MISS git.response.duration_ms=216 git.fetch.wants=bff0819ac0e4693323da05409c994d8c680cf879 git.fetch.haves.count=0 git.fetch.deepen=0 git.fetch.thin_pack=false git.fetch.ofs_delta=true git.protocol.version=2 git.pkt.frames=4 git.pkt.data=3 git.pkt.flush=1 git.pkt.delim=0 git.pkt.bytes=1517 git.pkt.payload.max=1490 git.sideband.band1.bytes=1490 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0
Each row is one HTTP round trip ply made to the git server for this page, on one timeline. discover asks what the server speaks, ls-refs lists branch tips, fetch brings objects by id. A hit was served by Workers Cache. Tap a row for its wire details.
- Remote
- https://gitlab.com/gitlab-org/cli
- Ref
- refs/heads/main
- Commit
- 0dd7574dce9e385c5c30540e6c15657adc6bdce9
- cf-ray
- a5e21638380e984a
- Request
- 05b8eed6…
- Protocol
- v2 · sha1
- Agent
- git/2.56.g1891de4-Linux
- Filter
- advertised
- Fetch
- shallow wait-for-done filter
- Capabilities
- agent ls-refs fetch server-option object-format