summaryrefslogtreecommitdiff
path: root/data/deprecations/15-6-deprecate-post-api-v4-runner.yml
blob: 07590296096db7ac9f2e5dbae1a478ec9364dee2 (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: "Registration tokens and server-side runner arguments in `POST /api/v4/runners` endpoint"  # (required) The name of the feature to be deprecated
  announcement_milestone: "15.6"  # (required) The milestone when this feature was first announced as deprecated.
  announcement_date: "2022-11-22"  # (required) The date of the milestone release when this feature was first announced as deprecated. This should almost always be the 22nd of a month (YYYY-MM-22), unless you did an out of band blog post.
  removal_milestone: "17.0"  # (required) The milestone when this feature is planned to be removed
  removal_date: "2024-05-22"  # (required) The date of the milestone release when this feature is planned to be removed. This should almost always be the 22nd of a month (YYYY-MM-22), unless you did an out of band blog post.
  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/379743  # (required) Link to the deprecation issue in GitLab
  body: |  # (required) Do not modify this line, instead modify the lines below.
    The support for registration tokens and certain runner configuration arguments in the `POST` method operation 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 17.0.

    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 17.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.
  end_of_support_date: "2023-05-22"  # (optional) The date of the milestone release 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