diff options
Diffstat (limited to 'doc/update')
-rw-r--r-- | doc/update/deprecations.md | 199 |
1 files changed, 102 insertions, 97 deletions
diff --git a/doc/update/deprecations.md b/doc/update/deprecations.md index 93e33fe04eb..a141ccb98a5 100644 --- a/doc/update/deprecations.md +++ b/doc/update/deprecations.md @@ -46,6 +46,108 @@ For deprecation reviewers (Technical Writers only): {::options parse_block_html="true" /} <div class="js-deprecation-filters"></div> +<div class="milestone-wrapper" data-milestone="18.0"> + +## GitLab 18.0 + +<div class="deprecation breaking-change" data-milestone="18.0"> + +### GitLab Runner registration token in Runner Operator + +<div class="deprecation-notes"> +- Announced in GitLab <span class="milestone">15.6</span> +- Removal in GitLab <span class="milestone">18.0</span> ([breaking change](https://docs.gitlab.com/ee/update/terminology.html#breaking-change)) +- To discuss this change or learn more, see the [deprecation issue](https://gitlab.com/gitlab-org/gitlab/-/issues/382077). +</div> + +The [`runner-registration-token`](https://docs.gitlab.com/runner/install/operator.html#install-the-kubernetes-operator) parameter that uses the OpenShift and Kubernetes Vanilla Operator to install a runner on Kubernetes is deprecated. Authentication tokens will be used to register runners instead. Registration tokens, and support for certain configuration arguments, +will be removed in GitLab 18.0. For more information, see [Migrating to the new runner registration workflow](../ci/runners/new_creation_workflow.md). +The configuration arguments disabled for authentication tokens are: + +- `--locked` +- `--access-level` +- `--run-untagged` +- `--tag-list` + +This change is a breaking change. You should use an [authentication token](../ci/runners/register_runner.md) in the `gitlab-runner register` command instead. + +</div> + +<div class="deprecation breaking-change" data-milestone="18.0"> + +### Registration tokens and server-side runner arguments in `gitlab-runner register` command + +<div class="deprecation-notes"> +- Announced in GitLab <span class="milestone">15.6</span> +- Removal in GitLab <span class="milestone">18.0</span> ([breaking change](https://docs.gitlab.com/ee/update/terminology.html#breaking-change)) +- To discuss this change or learn more, see the [deprecation issue](https://gitlab.com/gitlab-org/gitlab/-/issues/380872). +</div> + +Registration tokens and certain configuration arguments in the command `gitlab-runner register` that [registers](https://docs.gitlab.com/runner/register/) a runner, are deprecated. +Authentication tokens will be used to register runners instead. Registration tokens, and support for certain configuration arguments, +will be removed in GitLab 18.0. For more information, see [Migrating to the new runner registration workflow](../ci/runners/new_creation_workflow.md). +The configuration arguments disabled for authentication tokens are: + +- `--locked` +- `--access-level` +- `--run-untagged` +- `--maximum-timeout` +- `--paused` +- `--tag-list` +- `--maintenance-note` + +This change is a breaking change. You should [create a runner in the UI](../ci/runners/register_runner.md) to add configurations, and use the authentication token in the `gitlab-runner register` command instead. + +</div> + +<div class="deprecation breaking-change" data-milestone="18.0"> + +### Support for REST API endpoints that reset runner registration tokens + +<div class="deprecation-notes"> +- Announced in GitLab <span class="milestone">15.7</span> +- Removal in GitLab <span class="milestone">18.0</span> ([breaking change](https://docs.gitlab.com/ee/update/terminology.html#breaking-change)) +- To discuss this change or learn more, see the [deprecation issue](https://gitlab.com/gitlab-org/gitlab/-/issues/383341). +</div> + +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 +return the HTTP `410 Gone` status code in GitLab 18.0. +The deprecated endpoints are: + +- `POST /runners/reset_registration_token` +- `POST /projects/:id/runners/reset_registration_token` +- `POST /groups/:id/runners/reset_registration_token` + +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/ci/runners/new_creation_workflow.html). +The work is planned in [this epic](https://gitlab.com/groups/gitlab-org/-/epics/7633). +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 18.0 and later, the runner registration methods implemented by the new GitLab Runner token architecture will be the only supported methods. + +</div> + +<div class="deprecation breaking-change" data-milestone="18.0"> + +### `runnerRegistrationToken` parameter for GitLab Runner Helm Chart + +<div class="deprecation-notes"> +- Announced in GitLab <span class="milestone">15.6</span> +- Removal in GitLab <span class="milestone">18.0</span> ([breaking change](https://docs.gitlab.com/ee/update/terminology.html#breaking-change)) +- To discuss this change or learn more, see the [deprecation issue](https://gitlab.com/gitlab-org/gitlab/-/issues/381111). +</div> + +The [`runnerRegistrationToken`](https://docs.gitlab.com/runner/install/kubernetes.html#required-configuration) parameter to use the GitLab Helm Chart to install a runner on Kubernetes is deprecated. + +We plan to implement a new method to bind runners to a GitLab instance leveraging `runnerToken` +as part of the new [GitLab Runner token architecture](https://docs.gitlab.com/ee/ci/runners/new_creation_workflow.html). +The work is planned in [this epic](https://gitlab.com/groups/gitlab-org/-/epics/7633). + +From GitLab 18.0 and later, the methods to register runners introduced by the new GitLab Runner token architecture will be the only supported methods. + +</div> +</div> + <div class="milestone-wrapper" data-milestone="17.0"> ## GitLab 17.0 @@ -310,29 +412,6 @@ are deprecated and will be removed from the GraphQL API. For installation instru <div class="deprecation breaking-change" data-milestone="17.0"> -### GitLab Runner registration token in Runner Operator - -<div class="deprecation-notes"> -- Announced in GitLab <span class="milestone">15.6</span> -- Removal in GitLab <span class="milestone">17.0</span> ([breaking change](https://docs.gitlab.com/ee/update/terminology.html#breaking-change)) -- To discuss this change or learn more, see the [deprecation issue](https://gitlab.com/gitlab-org/gitlab/-/issues/382077). -</div> - -The [`runner-registration-token`](https://docs.gitlab.com/runner/install/operator.html#install-the-kubernetes-operator) parameter that uses the OpenShift and Kubernetes Vanilla Operator to install a runner on Kubernetes is deprecated. Authentication tokens will be used to register runners instead. Registration tokens, and support for certain configuration arguments, -will be removed in GitLab 17.0. For more information, see [Migrating to the new runner registration workflow](../ci/runners/new_creation_workflow.md). -The configuration arguments disabled for authentication tokens are: - -- `--locked` -- `--access-level` -- `--run-untagged` -- `--tag-list` - -This change is a breaking change. You should use an [authentication token](../ci/runners/register_runner.md) in the `gitlab-runner register` command instead. - -</div> - -<div class="deprecation breaking-change" data-milestone="17.0"> - ### GraphQL deprecation of `dependencyProxyTotalSizeInBytes` field <div class="deprecation-notes"> @@ -558,33 +637,6 @@ This change is a breaking change. You should [create a runner in the UI](../ci/r <div class="deprecation breaking-change" data-milestone="17.0"> -### Registration tokens and server-side runner arguments in `gitlab-runner register` command - -<div class="deprecation-notes"> -- Announced in GitLab <span class="milestone">15.6</span> -- Removal in GitLab <span class="milestone">17.0</span> ([breaking change](https://docs.gitlab.com/ee/update/terminology.html#breaking-change)) -- To discuss this change or learn more, see the [deprecation issue](https://gitlab.com/gitlab-org/gitlab/-/issues/380872). -</div> - -Registration tokens and certain configuration arguments in the command `gitlab-runner register` that [registers](https://docs.gitlab.com/runner/register/) a runner, are deprecated. -Authentication tokens will be used to register runners instead. Registration tokens, and support for certain configuration arguments, -will be removed in GitLab 17.0. For more information, see [Migrating to the new runner registration workflow](../ci/runners/new_creation_workflow.md). -The configuration arguments disabled for authentication tokens are: - -- `--locked` -- `--access-level` -- `--run-untagged` -- `--maximum-timeout` -- `--paused` -- `--tag-list` -- `--maintenance-note` - -This change is a breaking change. You should [create a runner in the UI](../ci/runners/register_runner.md) to add configurations, and use the authentication token in the `gitlab-runner register` command instead. - -</div> - -<div class="deprecation breaking-change" data-milestone="17.0"> - ### Required Pipeline Configuration is deprecated <div class="deprecation-notes"> @@ -692,33 +744,6 @@ we'll be introducing support in [this epic](https://gitlab.com/groups/gitlab-org <div class="deprecation breaking-change" data-milestone="17.0"> -### Support for REST API endpoints that reset runner registration tokens - -<div class="deprecation-notes"> -- Announced in GitLab <span class="milestone">15.7</span> -- Removal in GitLab <span class="milestone">17.0</span> ([breaking change](https://docs.gitlab.com/ee/update/terminology.html#breaking-change)) -- To discuss this change or learn more, see the [deprecation issue](https://gitlab.com/gitlab-org/gitlab/-/issues/383341). -</div> - -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 -return the HTTP `410 Gone` status code in GitLab 17.0. -The deprecated endpoints are: - -- `POST /runners/reset_registration_token` -- `POST /projects/:id/runners/reset_registration_token` -- `POST /groups/:id/runners/reset_registration_token` - -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/ci/runners/new_creation_workflow.html). -The work is planned in [this epic](https://gitlab.com/groups/gitlab-org/-/epics/7633). -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. - -</div> - -<div class="deprecation breaking-change" data-milestone="17.0"> - ### The GitLab legacy requirement IID is deprecated in favor of work item IID <div class="deprecation-notes"> @@ -844,26 +869,6 @@ removed in 17.0. <div class="deprecation breaking-change" data-milestone="17.0"> -### `runnerRegistrationToken` parameter for GitLab Runner Helm Chart - -<div class="deprecation-notes"> -- Announced in GitLab <span class="milestone">15.6</span> -- Removal in GitLab <span class="milestone">17.0</span> ([breaking change](https://docs.gitlab.com/ee/update/terminology.html#breaking-change)) -- To discuss this change or learn more, see the [deprecation issue](https://gitlab.com/gitlab-org/gitlab/-/issues/381111). -</div> - -The [`runnerRegistrationToken`](https://docs.gitlab.com/runner/install/kubernetes.html#required-configuration) parameter to use the GitLab Helm Chart to install a runner on Kubernetes is deprecated. - -We plan to implement a new method to bind runners to a GitLab instance leveraging `runnerToken` -as part of the new [GitLab Runner token architecture](https://docs.gitlab.com/ee/ci/runners/new_creation_workflow.html). -The work is planned in [this epic](https://gitlab.com/groups/gitlab-org/-/epics/7633). - -From GitLab 17.0 and later, the methods to register runners introduced by the new GitLab Runner token architecture will be the only supported methods. - -</div> - -<div class="deprecation breaking-change" data-milestone="17.0"> - ### `sidekiq` delivery method for `incoming_email` and `service_desk_email` is deprecated <div class="deprecation-notes"> |