GitLabgitlab-org
cli
main
1package rotate
3import (
4 "context"
5 "errors"
6 "fmt"
8 "github.com/MakeNowJust/heredoc/v2"
9 "github.com/spf13/cobra"
11 gitlab "gitlab.com/gitlab-org/api/client-go/v3"
13 "gitlab.com/gitlab-org/cli/internal/api"
14 "gitlab.com/gitlab-org/cli/internal/cmdutils"
15 "gitlab.com/gitlab-org/cli/internal/iostreams"
16 "gitlab.com/gitlab-org/cli/internal/mcpannotations"
17 "gitlab.com/gitlab-org/cli/internal/text"
18)
20type options struct {
21 io *iostreams.IOStreams
22 apiClient func(repoHost string) (*api.Client, error)
24 controllerID int64
25 tokenID int64
26 force bool
27 outputFormat string
28}
30func NewCmd(f cmdutils.Factory) *cobra.Command {
31 opts := &options{
32 io: f.IO(),
33 apiClient: f.ApiClient,
34 }
36 cmd := &cobra.Command{
37 Use: "rotate <controller-id> <token-id> [flags]",
38 Short: `Rotate a token for a runner controller. (EXPERIMENTAL)`,
39 Long: heredoc.Docf(`
40 Replaces the current token with a new one. Store the new token value
41 securely before closing the terminal. You cannot retrieve the token
42 again. Prompts for confirmation before rotation. Use %[1]s--force%[1]s
43 to skip the confirmation prompt in non-interactive contexts.
44 `, "`") + text.ExperimentalString,
45 Args: cobra.ExactArgs(2),
46 Example: heredoc.Doc(`
47 # Rotate token 1 for runner controller 42 (with confirmation prompt)
48 glab runner-controller token rotate 42 1
50 # Rotate without confirmation
51 glab runner-controller token rotate 42 1 --force
53 # Rotate and output as JSON
54 glab runner-controller token rotate 42 1 --force --output json`),
55 Annotations: map[string]string{
56 mcpannotations.Exclude: "true",
57 },
58 RunE: func(cmd *cobra.Command, args []string) error {
59 if err := opts.complete(args); err != nil {
60 return err
61 }
62 if err := opts.validate(cmd.Context()); err != nil {
63 return err
64 }
65 return opts.run(cmd.Context())
66 },
67 }
69 cmdutils.EnableJSONOutput(cmd, opts.io, &opts.outputFormat)
71 fl := cmd.Flags()
72 fl.BoolVarP(&opts.force, "force", "f", false, "Skip confirmation prompt.")
74 return cmd
75}
77func (o *options) complete(args []string) error {
78 controllerID, err := cmdutils.ParseID(args[0], "runner controller ID")
79 if err != nil {
80 return err
81 }
82 o.controllerID = controllerID
84 tokenID, err := cmdutils.ParseID(args[1], "token ID")
85 if err != nil {
86 return err
87 }
88 o.tokenID = tokenID
89 return nil
90}
92func (o *options) validate(ctx context.Context) error {
93 if !o.force {
94 if !o.io.PromptEnabled() {
95 return cmdutils.FlagError{Err: errors.New("--force required when not running interactively")}
96 }
97 var confirmed bool
98 err := o.io.Confirm(ctx, &confirmed, fmt.Sprintf("Rotate token %d for runner controller %d?", o.tokenID, o.controllerID))
99 if err != nil {
100 return err
101 }
102 if !confirmed {
103 return cmdutils.CancelError()
104 }
105 }
106 return nil
107}
109func (o *options) run(ctx context.Context) error {
110 apiClient, err := o.apiClient("")
111 if err != nil {
112 return err
113 }
114 client := apiClient.Lab()
116 token, _, err := client.RunnerControllerTokens.RotateRunnerControllerToken(o.controllerID, o.tokenID, gitlab.WithContext(ctx))
117 if err != nil {
118 return cmdutils.WrapError(err, "failed to rotate runner controller token")
119 }
121 switch o.outputFormat {
122 case "json":
123 return o.io.PrintJSON(token)
124 default:
125 c := o.io.Color()
126 o.io.LogInfof("Rotated token %d for runner controller %d\n", token.ID, o.controllerID)
127 o.io.LogInfof("Token: %s\n", token.Token)
128 o.io.LogInfof("\n%s\n", c.Yellow("Warning: Save this token. You cannot view it again."))
129 return nil
130 }
131}
Diagnostics9 git calls · 242 ms
CallStatusSizeTime0242 ms
discover200185 B3 ms
git.upload-pack discover http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=ls-refs 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 KiB · hit3 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=HIT 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 · hit4 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=4273 git.response.cache=HIT git.response.duration_ms=4 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=4 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 · 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=1857 git.response.cache=HIT git.response.duration_ms=2 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:0200323 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=323 git.response.cache=HIT git.response.duration_ms=2 git.fetch.filter=tree:0 git.fetch.wants=8185a1b139a07a59fba10180a7318233adb22fc3 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=323 git.pkt.payload.max=296 git.sideband.band1.bytes=296 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0 git.pack.objects=1 git.pack.bytes=296 git.pack.trailer=ac106711ec2e15414437a5964de4b85c86703290Open pack map
fetchtree:0200225 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=225 git.response.cache=HIT git.response.duration_ms=3 git.fetch.filter=tree:0 git.fetch.wants=db9f9e3562c24a8cd29c65d7d104076467dfcd8b 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=225 git.pkt.payload.max=198 git.sideband.band1.bytes=198 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0 git.pack.objects=1 git.pack.bytes=198 git.pack.trailer=630e9ffc4531331e26b7d1bca3358917b64c9c9bOpen pack map
fetchtree:0200138 B · hit5 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=5 git.response.bytes=138 git.response.cache=HIT git.response.duration_ms=5 git.fetch.filter=tree:0 git.fetch.wants=e64b6fa8c2ed2463f9e100af60f74d2dd9d32a74 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=f8002c47712f38ec22a497a276adc171585ae414Open pack map
fetch2001.4 KiB223 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=223 git.response.bytes=1458 git.response.cache=MISS git.response.duration_ms=223 git.fetch.wants=8493207507cd8948f714fb6c35348e4b2781a327 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=1458 git.pkt.payload.max=1431 git.sideband.band1.bytes=1431 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
- a5e2b598694ccf33
- Request
- 3b1ea04b…
- 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