For guidance on the overall deprecations, removals and breaking changes workflow, please visit [Breaking changes, deprecations, and removing features](https://about.gitlab.com/handbook/product/gitlab-the-product/#deprecations-removals-and-breaking-changes) <!-- Use this template as a starting point for deprecations. --> ### Deprecation Summary The support for registration tokens and certain runner configuration arguments in the `POST` method on the `/api/v4/runners` endpoint is **deprecated.** This endpoint [registers](https://docs.gitlab.com/ee/api/runners.html#register-a-new-runner) a Runner with a GitLab instance at the instance, group, or project level through the API. We plan to remove the support for registration tokens and certain configuration arguments in this endpoint in GitLab 16.0. Suppose you have developed and relied on automation for registering runners using this endpoint. In that case, you will need to adopt the new Runner registration method, as the current automation that you have developed will stop functioning with the changes to the endpoint in GitLab 16.0. Namely, calls to the endpoint that include a runner registration token or certain arguments such as `locked`, `run_untagged`, or `tag_list` will return an `HTTP 410 Gone` status code. <!-- This should contain a brief description of the feature or functionality that is deprecated. The description should clearly state the potential impact of the deprecation to end users. It is recommended that you link to the documentation. The description of the deprecation should state what actions the user should take to rectify the behavior. If the deprecation is scheduled for an upcoming release, the content should remain in the deprecations documentation page until it has been completed. For example, if a deprecation is announced in 14.9 and scheduled to be completed in 15.0, the same content would be included in the documentation for 14.9, 14.10, and 15.0. **If this issue proposes a breaking change outside a major release XX.0, you need to get approval from your manager and request collaboration from Product Operations on communication. Be sure to follow the guidance [here](https://about.gitlab.com/handbook/product/gitlab-the-product/#deprecations-removals-and-breaking-changes.)** --> #### Documentation - Deprecation notice: [add link](here) - Migration guidelines: [Next GitLab Runner Token Architecture](https://handbook.gitlab.com/handbook/engineering/architecture/design-documents/runner_tokens/) - etc. ### Breaking Change - **Yes** <!-- Does this MR contain a breaking change? If yes: - Add the ~"breaking change" label to this issue. - Add instructions for how users can update their workflow. --> ### Affected Customers Who is affected by this deprecation: GitLab.com users, Self-managed users, or Dedicated users? (choose all that apply) - [x] GitLab.com - [x] Self-Managed - [x] Dedicated <!-- Who is affected by this deprecation, Self-managed users, SaaS users, or both? This is especially important when nearing the annual major release where breaking changes and removals are typically introduced. These changes might be seen on GitLab.com before the official release date. --> ### Affected Tier What pricing tiers are impacted? - [x] GitLab Free - [x] GitLab Premium - [x] GitLab Ultimate <!-- Which tier is this feature available in? * Free * Premium * Ultimate --> ### Checklists **Labels** - [x] This issue is labeled ~deprecation, and with the relevant `~devops::`, `~group::`, and `~Category:` labels. - [x] This issue is labeled ~"breaking change" if the removal of the deprecated item will be a [breaking change](https://about.gitlab.com/handbook/product/gitlab-the-product/#examples-of-breaking-changes). **Timeline** Please add links to the relevant merge requests. - As soon as possible, but no later than the third milestone preceding the major release (for example, given the following release schedule: `14.8, 14.9, 14.10, 15.0` – `14.8` is the third milestone preceding the major release): - [x] A [deprecation announcement entry](https://about.gitlab.com/handbook/marketing/blog/release-posts/#creating-a-deprecation-announcement) has been created so the deprecation will appear in release posts and on the [general deprecation page](https://docs.gitlab.com/ee/update/deprecations). - [x] Documentation has been updated to mark the feature as [deprecated](https://docs.gitlab.com/ee/development/documentation/versions.html#deprecations-and-removals). - [ ] On or before the major milestone: A [removal entry](https://about.gitlab.com/handbook/marketing/blog/release-posts/#removals) has been created so the removal will appear on the [removals by milestones](https://docs.gitlab.com/ee/update/removals) page and be announced in the release post. - On the major milestone: - [ ] The deprecated item has been removed. - [ ] If the removal of the deprecated item is a [breaking change](https://about.gitlab.com/handbook/product/gitlab-the-product/#examples-of-breaking-changes), the merge request is labeled ~"breaking change". **Mentions** - [x] Your stage's stable counterparts have been `@mentioned` on this issue. For example, Customer Support, Customer Success (Technical Account Manager), Product Marketing Manager. - To see who the stable counterparts are for a product team visit [product categories](https://about.gitlab.com/handbook/product/categories/) - If there is no stable counterpart listed for Sales/CS please mention `@timtams` - If there is no stable counterpart listed for Support please mention `@gitlab-com/support/managers` - If there is no stable counterpart listed for Marketing please mention `@cfoster3` - [x] Your GPM has been `@mentioned` so that they are aware of planned deprecations. The goal is to have reviews happen at least two releases before the final removal of the feature or introduction of a breaking change. ### Deprecation Milestone <!-- In which milestone will this deprecation be announced ? --> **15.6** ### Planned Removal Milestone <!-- In which milestone will the feature or functionality be removed and announced? --> The feature / functionality will be removed in milestone: **18.0** ### Links [Next GitLab Runner Token Architecture](https://docs.gitlab.com/ee/architecture/blueprints/runner_tokens/#next-gitlab-runner-token-architecture) <!-- Add links to any relevant documentation or code that will provide additional details or clarity regarding the planned change. This issue is the main SSOT for the deprecations and removals process. Be sure to link all issues and MRs related to this deprecation/removal to this issue. This can include removal issues that were created ahead of time, and the MRs doing the actual deprecation/removal work. --> <!-- Label reminders - you should have one of each of the following labels. Use the following resources to find the appropriate labels: - https://gitlab.com/gitlab-org/gitlab/-/labels - https://about.gitlab.com/handbook/product/categories/features/ --> <!-- Populate the Section, Group, and Category --> <!-- Choose the Pricing Tier(s) --> <!-- Identifies that this Issue is related to deprecating a feature --> <!-- Add the ~"breaking change" label to this issue if necessary --> ## Communication plan ### Customer impact - All users at the instance, group, or project levels that have automation workflows that still rely on registration tokens for creating new runners will find that these workflows no longer work with GitLab 18.0. - Customers must insert the `authentication - See the [Next GitLab Runner Token Architecture handbook page](https://handbook.gitlab.com/handbook/engineering/architecture/design-documents/runner_tokens/#stage-7---removals) for the details.