summaryrefslogtreecommitdiff
path: root/data/deprecations/15-7-deprecate-api-v4-runner-registration-token-reset-endpoints.yml
blob: 3f77a9f3d8f0307fe30d5bf5cf6d1aadc022634f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
- title: "Support for REST API endpoints that reset runner registration tokens"  # (required) The name of the feature to be deprecated
  announcement_milestone: "15.7"  # (required) The milestone when this feature was first announced as deprecated.
  removal_milestone: "16.0"  # (required) The milestone when this feature is planned to be removed
  breaking_change: true  # (required) If this deprecation is a breaking change, set this value to true
  reporter: pedropombeiro  # (required) GitLab username of the person reporting the deprecation
  stage: Verify  # (required) String value of the stage that the feature was created in. e.g., Growth
  issue_url: https://gitlab.com/gitlab-org/gitlab/-/issues/383341  # (required) Link to the deprecation issue in GitLab
  body: |  # (required) Do not modify this line, instead modify the lines below.
    The support for runner registration tokens is deprecated. As a consequence, the REST API endpoints to reset a registration token are also deprecated and will
    be removed in GitLab 16.0.
    The deprecated endpoints are:

    - `POST /runners/reset_registration_token`
    - `POST /projects/:id/runners/reset_registration_token`
    - `POST /groups/:id/runners/reset_registration_token`

    In GitLab 15.8, we plan to implement a new method to bind runners to a GitLab instance,
    as part of the new [GitLab Runner token architecture](https://docs.gitlab.com/ee/architecture/blueprints/runner_tokens/).
    This new architecture introduces a new method for registering runners and will eliminate the legacy
    [runner registration token](https://docs.gitlab.com/ee/security/token_overview.html#runner-registration-tokens).
    From GitLab 16.0 and later, the runner registration methods implemented by the new GitLab Runner token architecture will be the only supported methods.
  end_of_support_milestone: "16.0"  # (optional) Use "XX.YY" format. The milestone when support for this feature will end.
  tiers:  # (optional - may be required in the future) An array of tiers that the feature is available in currently.  e.g., [Free, Silver, Gold, Core, Premium, Ultimate]
  documentation_url: https://docs.gitlab.com/ee/api/runners.html#register-a-new-runner  # (optional) This is a link to the current documentation page