diff options
Diffstat (limited to 'doc/update/deprecations.md')
| -rw-r--r-- | doc/update/deprecations.md | 125 |
1 files changed, 108 insertions, 17 deletions
diff --git a/doc/update/deprecations.md b/doc/update/deprecations.md index 42bd41ed74b..8bf14bc2dce 100644 --- a/doc/update/deprecations.md +++ b/doc/update/deprecations.md @@ -45,6 +45,7 @@ The Task Runner pod is used to execute periodic housekeeping tasks within the Gi This will result in the rename of the sub-chart: `gitlab/task-runner` to `gitlab/toolbox`. Resulting pods will be named along the lines of `{{ .Release.Name }}-toolbox`, which will often be `gitlab-toolbox`. They will be locatable with the label `app=toolbox`. Announced: 2021-08-22 +Planned removal: 2021-11-22 ## 14.6 @@ -53,6 +54,7 @@ Announced: 2021-08-22 The [release-cli](https://gitlab.com/gitlab-org/release-cli) will be released as a [generic package](https://gitlab.com/gitlab-org/release-cli/-/packages) starting in GitLab 14.2. We will continue to deploy it as a binary to S3 until GitLab 14.5 and stop distributing it in S3 in GitLab 14.6. Announced: 2021-08-22 +Planned removal: 2021-12-22 ## 14.8 @@ -63,9 +65,19 @@ Distribution support and security updates for openSUSE Leap 15.2 are [ending Dec Starting in 14.5 we are providing packages for openSUSE Leap 15.3, and will stop providing packages for openSUSE Leap 15.2 in the 14.8 milestone. Announced: 2021-11-22 +Planned removal: 2022-02-22 ## 15.0 +### API: `stale` status returned instead of `offline` or `not_connected` + +A breaking change will occur for the Runner [API](https://docs.gitlab.com/ee/api/runners.html#runners-api) endpoints in 15.0. + +Instead of the GitLab Runner API endpoints returning `offline` and `not_connected` for runners that have not contacted the GitLab instance in the past three months, the API endpoints will return the `stale` value, which was introduced in 14.6. + +Announced: 2021-12-22 +Planned removal: 2022-05-22 + ### Audit events for repository push events Audit events for [repository events](https://docs.gitlab.com/ee/administration/audit_events.html#repository-push) are now deprecated and will be removed in GitLab 15.0. @@ -75,6 +87,14 @@ feature flag. Enabling them can cause too many events to be generated which can dramatically slow down GitLab instances. For this reason, they are being removed. Announced: 2021-09-22 +Planned removal: 2022-05-22 + +### CI/CD job name length limit + +In GitLab 15.0 we are going to limit the number of characters in CI/CD job names to 255. Any pipeline with job names that exceed the 255 character limit will stop working after the 15.0 release. + +Announced: 2021-12-22 +Planned removal: 2022-05-22 ### Certificate-based integration with Kubernetes @@ -89,12 +109,14 @@ For a more robust, secure, forthcoming, and reliable integration with Kubernetes [Kubernetes Agent](https://docs.gitlab.com/ee/user/clusters/agent/) to connect Kubernetes clusters with GitLab. Announced: 2021-11-15 +Planned removal: 2022-05-22 ### Converting an instance (shared) runner to a project (specific) runner is deprecated In GitLab 15.0, we will remove the feature that enables you to convert an instance (shared) runner to a project (specific) runner. Users who need to add a runner to only a particular project can register a runner to the project directly. Announced: 2021-11-22 +Planned removal: 2022-05-22 ### Deprecate `Versions` on base `PackageType` @@ -103,12 +125,51 @@ As part of the work to create a [Package Registry GraphQL API](https://gitlab.co In milestone 15.0, we will completely remove `Version` from `PackageType`. Announced: 2021-11-22 +Planned removal: 2022-05-22 + +### Deprecate `pipelines` fields in the Package GraphQL types + +As part of the work to create a [Package Registry GraphQL API](https://gitlab.com/groups/gitlab-org/-/epics/6318), the Package group deprecated the `pipelines` fields in all Package-related GraphQL types. As of GitLab 14.6, the `pipelines` field is deprecated in [`Package`](https://docs.gitlab.com/ee/api/graphql/reference/index.html#package) and [`PackageDetailsType`](https://docs.gitlab.com/ee/api/graphql/reference/index.html#packagedetailstype) due to scalability and performance concerns. + +In milestone 15.0, we will completely remove `pipelines` from `Package` and `PackageDetailsType`. You can follow and contribute to work on a replacement in the epic [GitLab-#7214](https://gitlab.com/groups/gitlab-org/-/epics/7214). + +Announced: 2021-12-22 +Planned removal: 2022-05-22 + +### Deprecate legacy approval status names from License Compliance API + +We deprecated legacy names for approval status of license policy (blacklisted, approved) in the `managed_licenses` API but they are still used in our API queries and responses. They will be removed in 15.0. + +If you are using our License Compliance API you should stop using the `approved` and `blacklisted` query parameters, they are now `allowed` and `denied`. In 15.0 the responses will also stop using `approved` and `blacklisted` so you need to adjust any of your custom tools to use the old and new values so they do not break with the 15.0 release. + +Announced: 2021-12-22 +Planned removal: 2022-05-22 ### Deprecate support for SLES 12 SP2 Long term service and support (LTSS) for SUSE Linux Enterprise Server (SLES) 12 SP2 [ended on March 31, 2021](https://www.suse.com/lifecycle/). The CA certificates on SP2 include the expired DST root certificate, and it's not getting new CA certificate package updates. We have implemented some [workarounds](https://gitlab.com/gitlab-org/gitlab-omnibus-builder/-/merge_requests/191), but we will not be able to continue to keep the build running properly. Announced: 2021-11-22 +Planned removal: 2022-05-22 + +### Deprecation of Runner status `not_connected` API value + +The GitLab Runner REST and GraphQL [API](https://docs.gitlab.com/ee/api/runners.html#runners-api) endpoints +will return `never_contacted` instead of `not_connected` as the status values in 15.0. + +Runners that have never contacted the GitLab instance will also return `stale` if created more than 3 months ago. + +Announced: 2021-12-22 +Planned removal: 2022-05-22 + +### Deprecation of bundler-audit Dependency Scanning tool + +As of 14.6 bundler-audit is being deprecated from Dependency Scanning. It will continue to be in our CI/CD template while deprecated. We are removing bundler-audit from Dependency Scanning on May 22, 2022 in 15.0. After this removal Ruby scanning functionality will not be affected as it is still being covered by Gemnasium. + +If you have explicitly excluded bundler-audit using DS_EXCLUDED_ANALYZERS you will need to clean up (remove the reference) in 15.0. If you have customized your pipeline's Dependency Scanning configuration, for example to edit the `bundler-audit-dependency_scanning` job, you will want to switch to gemnasium-dependency_scanning before removal in 15.0, to prevent your pipeline from failing. If you have not used the DS_EXCLUDED_ANALYZERS to reference bundler-audit, or customized your template specifically for bundler-audit, you will not need to take action. + +Announced: 2021-12-22 +Planned removal: 2022-05-22 ### GitLab Serverless @@ -117,6 +178,7 @@ Announced: 2021-11-22 We decided to remove the GitLab Serverless features as they never really resonated with our users. Besides, given the continuous development of Kubernetes and Knative, our current implementations do not even work with recent versions. Announced: 2021-09-22 +Planned removal: 2022-05-22 ### Known host required for GitLab Runner SSH executor @@ -125,6 +187,7 @@ In [GitLab 14.3](https://gitlab.com/gitlab-org/gitlab-runner/-/merge_requests/30 In GitLab 15.0 and later, the default value for this configuration option will change from `true` to `false`. This means that strict host key checking will be enforced when using the GitLab Runner SSH executor. Announced: 2021-11-22 +Planned removal: 2022-05-22 ### Legacy database configuration @@ -135,6 +198,16 @@ supported using a single PostgreSQL adapter, whereas the new format is changing This deprecation mainly impacts users compiling GitLab from source because Omnibus will handle this configuration automatically. Announced: 2021-09-22 +Planned removal: 2022-05-22 + +### Must explicitly assign `AuthenticationType` for `[runners.cache.s3]` + +In GitLab 15.0 and later, to access the AWS S3 cache, you must specify the `AuthenticationType` for [`[runners.cache.s3]`](https://docs.gitlab.com/runner/configuration/advanced-configuration.html#the-runnerscaches3-section). The `AuthenticationType` must be `IAM` or `credentials`. + +Prior to 14.5, if you did not define the `AuthenticationType`, GitLab Runner chose a type for you. + +Announced: 2021-11-22 +Planned removal: 2022-05-22 ### NFS for Git repository storage deprecated @@ -149,6 +222,7 @@ Gitaly Cluster offers tremendous benefits for our customers such as: We encourage customers currently using NFS for Git repositories to plan their migration by reviewing our documentation on [migrating to Gitaly Cluster](https://docs.gitlab.com/ee/administration/gitaly/index.html#migrate-to-gitaly-cluster). Announced: 2021-06-22 +Planned removal: 2022-05-22 ### OmniAuth Kerberos gem @@ -159,6 +233,7 @@ This gem has not been maintained and has very little usage. We therefore plan to Note that we are not deprecating the Kerberos SPNEGO integration, only the old password-based Kerberos integration. Announced: 2021-09-22 +Planned removal: 2022-05-22 ### Package pipelines in API payload is paginated @@ -167,31 +242,48 @@ A request to the API for `/api/v4/projects/:id/packages` returns a paginated res In milestone 15.0, we will remove the `pipelines` attribute from the API response. Announced: 2021-11-22 +Planned removal: 2022-05-22 ### REST API Runner will not contain `paused` -Runner REST API will not return `paused` as a status in GitLab 15.0. +The GitLab Runner REST and GraphQL API endpoints will not return `paused` or `active` as a status in GitLab 15.0. -Paused runners' status will only relate to runner contact status, such as: -`online`, `offline`, or `not_connected`. Status `paused` will not appear when the runner is -not active. +A runner's status will only relate to runner contact status, such as: +`online`, `offline`, or `not_connected`. Status `paused` or `active` will no longer appear. When checking if a runner is `paused`, API users are advised to check the boolean attribute -`active` to be `false` instead. +`active` to be `false` instead. When checking if a runner is `active`, check if `active` is `true`. + +Announced: 2021-11-22 +Planned removal: 2022-05-22 + +### Removal of `defaultMergeCommitMessageWithDescription` GraphQL API field + +The GraphQL API field `defaultMergeCommitMessageWithDescription` has been deprecated and will be removed in GitLab 15.0. For projects with a commit message template set, it will ignore the template. Announced: 2021-11-22 +Planned removal: 2022-05-22 ### Removal of `promote-db` command from `gitlab-ctl` In GitLab 14.5, we introduced the command `gitlab-ctl promote` to promote any Geo secondary node to a primary during a failover. This command replaces `gitlab-ctl promote-db` which is used to promote database nodes in multi-node Geo secondary sites. `gitlab-ctl promote-db` will continue to function as-is and be available until GitLab 15.0. We recommend that Geo customers begin testing the new `gitlab-ctl promote` command in their staging environments and incorporating the new command in their failover procedures. Announced: 2021-11-22 +Planned removal: 2022-05-22 ### Removal of `promote-to-primary-node` command from `gitlab-ctl` In GitLab 14.5, we introduced the command `gitlab-ctl promote` to promote any Geo secondary node to a primary during a failover. This command replaces `gitlab-ctl promote-to-primary-node` which was only usable for single-node Geo sites. `gitlab-ctl promote-to-primary-node` will continue to function as-is and be available until GitLab 15.0. We recommend that Geo customers begin testing the new `gitlab-ctl promote` command in their staging environments and incorporating the new command in their failover procedures. Announced: 2021-11-22 +Planned removal: 2022-05-22 + +### Remove `type` and `types` keyword in CI/CD configuration + +The `type` and `types` CI/CD keywords will be removed in GitLab 15.0. Pipelines that use these keywords will stop working, so you must switch to `stage` and `stages`, which have the same behavior. + +Announced: 2021-12-22 +Planned removal: 2022-05-22 ### Remove the `:dependency_proxy_for_private_groups` feature flag @@ -200,6 +292,7 @@ We added a feature flag because [GitLab-#11582](https://gitlab.com/gitlab-org/gi In milestone 15.0, we will remove the feature flag entirely. Moving forward, you must authenticate when using the Dependency Proxy. Announced: 2021-11-22 +Planned removal: 2022-05-22 ### Remove the `pipelines` field from the `version` field @@ -211,6 +304,7 @@ In GraphQL, there are two `pipelines` fields that you can use in a [`PackageDeta To mitigate possible performance problems, we will remove the `versions` field's `pipelines` field in milestone 15.0. Although you will no longer be able to get all pipelines for all versions of a package, you can still get the pipelines of a single version through the remaining `pipelines` field for that version. Announced: 2021-11-22 +Planned removal: 2022-05-22 ### Update to the Container Registry group-level API @@ -219,25 +313,22 @@ In milestone 15.0, support for the `tags` and `tags_count` parameters will be re The `GET /groups/:id/registry/repositories` endpoint will remain, but won't return any info about tags. To get the info about tags, you can use the existing `GET /registry/repositories/:id` endpoint, which will continue to support the `tags` and `tag_count` options as it does today. The latter must be called once per image repository. Announced: 2021-11-22 +Planned removal: 2022-05-22 ### Value Stream Analytics filtering calculation change -We are changing how the date filter works in Value Stream Analytics. Instead of filtering by the time that the issue or merge request was created, the date filter will filter by the end event time of the given stage. This will result in completely different figures after this change has rolled out. +We are changing how the date filter works in Value Stream Analytics. Instead of filtering by the time that the issue or merge request was created, the date filter will filter by the end event time of the given stage. This will result in completely different figures after this change has rolled out. If you monitor Value Stream Analytics metrics and rely on the date filter, to avoid losing data, you must save the data prior to this change. Announced: 2021-11-22 +Planned removal: 2022-05-22 -### `AuthenticationType` for `[runners.cache.s3]` must be explicitly assigned +### apiFuzzingCiConfigurationCreate GraphQL mutation -In GitLab 15.0 and later, to access the AWS S3 cache, you must specify the `AuthenticationType` for [`[runners.cache.s3]`](https://docs.gitlab.com/runner/configuration/advanced-configuration.html#the-runnerscaches3-section). The `AuthenticationType` must be `IAM` or `credentials`. - -Prior to 14.5, if you did not define the `AuthenticationType`, GitLab Runner chose a type for you. +The API Fuzzing configuration snippet is now being generated client-side and does not require an +API request anymore. We are therefore deprecating the `apiFuzzingCiConfigurationCreate` mutation +which isn't being used in GitLab anymore. -Announced: 2021-11-22 - -### defaultMergeCommitMessageWithDescription GraphQL API field will be removed in GitLab 15.0 - -The GraphQL API field `defaultMergeCommitMessageWithDescription` has been deprecated and will be removed in GitLab 15.0. For projects with a commit message template set, it will ignore the template. - -Announced: 2021-11-22 +Announced: 2021-12-22 +Planned removal: 2022-05-22 |