manage-runners runner update
Update one runner; product, GitLab host, runner token, concurrency, executor, SSH key, cache, --dashboard or --send-to changes, and label changes of GitHub runners, recreate an active runner's VM; --github-token-env rotates a GitHub runner's token and --watchdog and --watchdog-timeout change the watchdog without recreating it
| Required scopes | runners:read, runners:write |
|---|---|
| Required flags | --id |
| Changes state | yes |
| Destructive | no |
| Paid resource effect | recreate |
| Confirmation | paid_resource |
| Non-interactive use | supported |
This command may delete and recreate an active runner's VM. Read confirmations before running it non-interactively.
Usage
Update one runner; product, GitLab host, runner token, concurrency, executor, SSH key, cache, --dashboard or --send-to changes, and label changes of GitHub runners, recreate an active runner's VM; --github-token-env rotates a GitHub runner's token and --watchdog and --watchdog-timeout change the watchdog without recreating it
Usage:
manage-runners runner update [flags]
Flags:
--cache string S3 cache id, or a name, which needs runners:read; see cache list (GitLab runners)
--concurrency int runner concurrency; 1 to 32 for GitHub runners
--dashboard string show metrics in the dashboard: on|off; on requires an active paid subscription
--digitalocean-connection string switch a DigitalOcean runner to this DigitalOcean connection of the same team instead of a token; see provider digitalocean connections
--executor string runner executor (GitLab runners)
--github-token-env string environment variable containing a new GitHub token (GitHub runners)
--gitlab-host string GitLab host (GitLab runners)
--hetzner-token string switch a Hetzner runner to this saved token of the same project instead of a token; see provider hetzner tokens
--hetzner-token-env string environment variable containing the Hetzner token
--id string id
--interval duration polling interval (default 2s)
--label stringArray runner label
--name string runner name
--no-cache[=true|false] use no cache
--no-send-to[=true|false] send metrics to no connection
--product-id string product id
--profile string configuration profile
--provider-token-env string environment variable containing a new token of the runner's cloud provider (Hetzner or DigitalOcean)
--runner-token-env string environment variable containing the runner token (GitLab runners)
--send-to string send metrics to this Metrics connection: id, or a name, which needs runners:read; see metrics list; requires an active paid subscription
--ssh-key-id stringArray SSH key id
--timeout duration maximum wait duration (default 10m0s)
--wait[=true|false] wait for a terminal runner state
--watchdog string restart the runner by a forced pause and resume when its collector reports nothing for --watchdog-timeout minutes, at most 3 times in 24 hours: on|off; needs metrics shown in the dashboard or sent to a connection
--watchdog-timeout int minutes without collector reports before the watchdog restarts the runner, 5 to 60; omitted: the current timeout
--yes[=true|false] confirm recreating an active runner's VM; required with --product-id, --gitlab-host, --runner-token-env, --concurrency, --executor, --ssh-key-id, --cache, --no-cache, --dashboard, --send-to or --no-send-to, and with --label for GitHub runners
Every command also accepts the global flags. For machine-readable
help, run manage-runners help runner update --output json.