debian-mirror-gitlab/doc/ci/runners/register_runner.md

stage	group	info
Verify	Runner	To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments

Generate runner tokens (FREE)

To register a runner, you can use either:

• An authentication token assigned to the runner when you create the runner in the UI. The runner uses the token to authenticate with GitLab when picking up jobs from the job queue.
• A registration token (deprecated).

Generate an authentication token

Registration with an authentication token is available for all runners.

NOTE: The token only displays in the UI for a short period of time during registration.

For a shared runner

• Introduced in GitLab 15.10. Deployed behind the create_runner_workflow_for_admin flag
• Enabled by default in GitLab 16.0.

FLAG: On self-managed GitLab, by default this feature is available. To hide the feature, ask an administrator to disable the feature flag named create_runner_workflow_for_admin.

Prerequisites:

• You must be an administrator.

To generate an authentication token for a shared runner:

1. On the top bar, select Main menu > Admin.
2. On the left sidebar, select CI/CD > Runners.
3. Select New instance runner.
4. Select a platform.
5. Optional. Enter configurations for the runner.
6. Select Submit.
7. Follow the instructions to register the runner from the command line.

For a group runner

• Introduced in GitLab 15.10. Deployed behind the create_runner_workflow_for_namespace flag. Disabled by default.
• Enabled by default in GitLab 16.0.

FLAG: On self-managed GitLab, by default this feature is available. To hide the feature, ask an administrator to disable the feature flag named create_runner_workflow_for_namespace.

Prerequisites:

• You must have the Owner role for the group.

To generate an authentication token for a group runner:

1. On the top bar, select Main menu > Groups and find your group.
2. On the left sidebar, select CI/CD > Runners.
3. Select New group runner.
4. Select a platform.
5. Optional. Enter configurations for the runner.
6. Select Submit.
7. Follow the instructions to register the runner from the command line.

For a project runner

• Introduced in GitLab 15.10. Deployed behind the create_runner_workflow_for_namespace flag. Disabled by default.
• Enabled by default in GitLab 16.0.

FLAG: On self-managed GitLab, by default this feature is available. To hide the feature, ask an administrator to disable the feature flag named create_runner_workflow_for_namespace.

Prerequisites:

• You must have the Maintainer role for the project.

To generate an authentication token for a project runner:

1. On the top bar, select Main menu > Projects and find your project.
2. On the left sidebar, select Settings > CI/CD.
3. Select New project runner.
4. Select a platform.
5. Optional. Enter configurations for the runner.
6. Select Submit.
7. Follow the instructions to register the runner from the command line.

Generate a registration token (deprecated)

WARNING: The ability to pass a runner registration token, and support for certain configuration arguments was deprecated in GitLab 15.6. Authentication tokens should be used instead to register runners. Registration tokens, and support for certain configuration arguments will be disabled behind a feature flag in GitLab 16.6 and removed in GitLab 17.0. The configuration arguments disabled for glrt- tokens are --locked, --access-level, --run-untagged, --maximum-timeout, --paused, --tag-list, and --maintenance-note. This change is a breaking change.

For a shared runner

1. On the top bar, select Main menu > Admin.
2. On the left sidebar, select CI/CD > Runners.
3. Select Register an instance runner.
4. Copy the registration token.

For a group runner

1. On the top bar, select Main menu > Groups and find your group.
2. On the left sidebar, select CI/CD > Runners.
3. Copy the registration token.

For a project runner

1. On the top bar, select Main menu > Projects and find your project.
2. On the left sidebar, select Settings > CI/CD.
3. Expand the Runners section.
4. Copy the registration token.