GitLabgitlab-org
cli
main
1package update
3import (
4 "context"
6 "github.com/MakeNowJust/heredoc/v2"
7 "github.com/spf13/cobra"
9 gitlab "gitlab.com/gitlab-org/api/client-go/v3"
11 "gitlab.com/gitlab-org/cli/internal/api"
12 "gitlab.com/gitlab-org/cli/internal/cmdutils"
13 "gitlab.com/gitlab-org/cli/internal/glrepo"
14 "gitlab.com/gitlab-org/cli/internal/iostreams"
15 "gitlab.com/gitlab-org/cli/internal/mcpannotations"
16)
18type options struct {
19 io *iostreams.IOStreams
20 apiClient func(repoHost string) (*api.Client, error)
21 baseRepo func() (glrepo.Interface, error)
23 runnerID int64
24 pause *bool
25}
27func NewCmd(f cmdutils.Factory) *cobra.Command {
28 opts := &options{
29 io: f.IO(),
30 apiClient: f.ApiClient,
31 baseRepo: f.BaseRepo,
32 }
34 cmd := &cobra.Command{
35 Use: "update <runner-id>",
36 Short: "Update a runner.",
37 Args: cobra.ExactArgs(1),
38 Long: heredoc.Doc(`
39 Updates settings for a GitLab CI/CD runner.
41 Use flags to update the runner configuration, such as the pause state.
43 Prerequisites:
45 - Maintainer or Owner role for project runners.
46 - Owner role for group runners.
47 - Administrator access for instance runners.
48 `),
49 Example: heredoc.Doc(`
50 # Pause a runner
51 glab runner update <runner-id> --pause
53 # Unpause a runner
54 glab runner update <runner-id> --unpause
56 # Pause a runner in a specific project
57 glab runner update <runner-id> --pause -R owner/repo`),
58 Annotations: map[string]string{
59 mcpannotations.Safe: "true",
60 },
61 RunE: func(cmd *cobra.Command, args []string) error {
62 if err := opts.complete(args); err != nil {
63 return err
64 }
66 return opts.run(cmd.Context())
67 },
68 }
70 cmdutils.NewBoolFlagPair(cmd, &opts.pause, "pause", "Pause the runner.", "unpause", "Resume a paused runner.")
71 cmd.MarkFlagsOneRequired("pause", "unpause")
72 return cmd
73}
75func (o *options) complete(args []string) error {
76 id, err := cmdutils.ParseID(args[0], "runner ID")
77 if err != nil {
78 return err
79 }
81 o.runnerID = id
82 return nil
83}
85func (o *options) run(ctx context.Context) error {
86 c, err := o.apiClient("")
87 if err != nil {
88 return err
89 }
90 client := c.Lab()
91 updateOpts := o.buildUpdateOptions()
92 return o.updateRunnerDetails(ctx, client, updateOpts)
93}
95func (o *options) buildUpdateOptions() *gitlab.UpdateRunnerDetailsOptions {
96 opts := &gitlab.UpdateRunnerDetailsOptions{}
97 if o.pause != nil {
98 opts.Paused = o.pause
99 }
100 return opts
101}
103func (o *options) updateRunnerDetails(ctx context.Context, client *gitlab.Client, updateOpts *gitlab.UpdateRunnerDetailsOptions) error {
104 details, _, err := client.Runners.UpdateRunnerDetails(o.runnerID, updateOpts, gitlab.WithContext(ctx))
105 if err != nil {
106 return cmdutils.WrapError(err, "failed to update runner")
107 }
109 if updateOpts.Paused != nil {
110 if details.Paused {
111 o.io.LogInfof("Runner %d has been paused and will not accept new jobs.\n", o.runnerID)
112 } else {
113 o.io.LogInfof("Runner %d has been unpaused and is now accepting jobs.\n", o.runnerID)
114 }
115 }
116 return nil
117}
Diagnostics8 git calls · 357 ms
CallStatusSizeTime0357 ms
discover200185 B3 ms
git.upload-pack discover http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=3 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=3 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
fetchcombine:blob:none+tree:2 · deepen 12004.2 KiB · 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=4273 git.response.cache=HIT git.response.duration_ms=2 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:0 · deepen 1020032 KiB · hit4 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=32926 git.response.cache=HIT git.response.duration_ms=4 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
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=2 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:0200314 B · hit2 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=4 git.response.bytes=314 git.response.cache=HIT git.response.duration_ms=2 git.fetch.filter=tree:0 git.fetch.wants=9182edcf49c51a2d4d26f5f18ad76a93a377699f 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=314 git.pkt.payload.max=287 git.sideband.band1.bytes=287 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0 git.pack.objects=1 git.pack.bytes=287 git.pack.trailer=d25ce511fa222aedcda012c18364dcb1f012062bOpen pack map
fetchtree:0200138 B · hit4 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=343 git.response.bytes=138 git.response.cache=HIT git.response.duration_ms=4 git.fetch.filter=tree:0 git.fetch.wants=cb34b6f97c4f4fc071c06512121c2765df31b115 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=138 git.pkt.payload.max=111 git.sideband.band1.bytes=111 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0 git.pack.objects=1 git.pack.bytes=111 git.pack.trailer=3d4aee7f5d4bdc55799fb41e07769e50d3c34591Open pack map
fetch2001.2 KiB343 ms
git.upload-pack fetch http.response.status_code=200 git.response.bytes=1233 git.response.cache=MISS git.response.duration_ms=343 git.fetch.wants=068edce12b47e607943ba8a7145ba77b8ffaeacc 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=1233 git.pkt.payload.max=1206 git.sideband.band1.bytes=1206 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
- a5e2c55d0c2a4afc
- Request
- c633f2fd…
- 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