summaryrefslogtreecommitdiff
path: root/data/deprecations
diff options
context:
space:
mode:
Diffstat (limited to 'data/deprecations')
-rw-r--r--data/deprecations/14-3-database-deprecate-legacy-database-conf.yml13
-rw-r--r--data/deprecations/14-3-repository-push-audit-events.yml14
-rw-r--r--data/deprecations/deprecation_omniauth-kerberos_gem.yml15
-rw-r--r--data/deprecations/distribution_deprecations_14-3.yml8
-rw-r--r--data/deprecations/serverless.yml13
-rw-r--r--data/deprecations/templates/_deprecation_template.md.erb32
-rw-r--r--data/deprecations/templates/example.yml33
7 files changed, 128 insertions, 0 deletions
diff --git a/data/deprecations/14-3-database-deprecate-legacy-database-conf.yml b/data/deprecations/14-3-database-deprecate-legacy-database-conf.yml
new file mode 100644
index 00000000000..f3f6553729e
--- /dev/null
+++ b/data/deprecations/14-3-database-deprecate-legacy-database-conf.yml
@@ -0,0 +1,13 @@
+- name: "Legacy database configuration"
+ announcement_milestone: "14.3"
+ announcement_date: "2021-09-22"
+ removal_milestone: "15.0"
+ body: |
+ The syntax of [GitLabs database](https://docs.gitlab.com/omnibus/settings/database.html)
+ configuration located in `database.yml` is changing and the legacy format is deprecated. The legacy format
+ supported using a single PostgreSQL adapter, whereas the new format is changing to support multiple databases. The `main:` database needs to be defined as a first configuration item.
+
+ This deprecation mainly impacts users compiling GitLab from source because Omnibus will handle this configuration automatically.
+ stage: Enablement
+ tiers: [Core, Premium, Ultimate]
+ issue_url: https://gitlab.com/gitlab-org/gitlab/-/issues/338182
diff --git a/data/deprecations/14-3-repository-push-audit-events.yml b/data/deprecations/14-3-repository-push-audit-events.yml
new file mode 100644
index 00000000000..3a39c1f4304
--- /dev/null
+++ b/data/deprecations/14-3-repository-push-audit-events.yml
@@ -0,0 +1,14 @@
+- name: "Audit events for repository push events"
+ announcement_milestone: "14.3" # The milestone when this feature was first announced as deprecated.
+ removal_milestone: "15.0" # the milestone when this feature is planned to be removed
+ body: | # Do not modify this line, instead modify the lines below.
+ 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.
+
+ These events have always been disabled by default and had to be manually enabled with a
+ 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.
+ stage: Manage
+ tiers: Premium
+ issue_url: https://gitlab.com/gitlab-org/gitlab/-/issues/337993
+ documentation_url: https://docs.gitlab.com/ee/administration/audit_events.html#repository-push
+ announcement_date: "2021-09-02" # https://gitlab.com/gitlab-org/gitlab/-/merge_requests/69024
diff --git a/data/deprecations/deprecation_omniauth-kerberos_gem.yml b/data/deprecations/deprecation_omniauth-kerberos_gem.yml
new file mode 100644
index 00000000000..8adbeb19416
--- /dev/null
+++ b/data/deprecations/deprecation_omniauth-kerberos_gem.yml
@@ -0,0 +1,15 @@
+- name: "OmniAuth Kerberos gem"
+ announcement_milestone: "14.3"
+ removal_milestone: "15.0"
+ body: | # Do not modify this line, instead modify the lines below.
+ The `omniauth-kerberos` gem will be removed in our next major release, GitLab 15.0.
+
+ This gem has not been maintained and has very little usage. We therefore plan to remove support for this authentication method and recommend using the Kerberos [SPNEGO](https://en.wikipedia.org/wiki/SPNEGO) integration instead. You can follow the [upgrade instructions](https://docs.gitlab.com/ee/integration/kerberos.html#upgrading-from-password-based-to-ticket-based-kerberos-sign-ins) to upgrade from the `omniauth-kerberos` integration to the supported one.
+
+ Note that we are not deprecating the Kerberos SPNEGO integration, only the old password-based Kerberos integration.
+ stage: Manage
+ tiers: [Premium, Ultimate]
+ issue_url: https://gitlab.com/gitlab-org/gitlab/-/issues/337384
+ documentation_url: https://docs.gitlab.com/ee/integration/kerberos.html#upgrading-from-password-based-to-ticket-based-kerberos-sign-ins
+ announcement_date: "2021-09-22"
+
diff --git a/data/deprecations/distribution_deprecations_14-3.yml b/data/deprecations/distribution_deprecations_14-3.yml
new file mode 100644
index 00000000000..05263383151
--- /dev/null
+++ b/data/deprecations/distribution_deprecations_14-3.yml
@@ -0,0 +1,8 @@
+- name: "Rename Task Runner pod to Toolbox" # The name of the feature to be deprecated
+ announcement_milestone: "14.2" # The milestone when this feature was first announced as deprecated.
+ announcement_date: "2021-09-22"
+ removal_milestone: "14.4" # the milestone when this feature is planned to be removed
+ body: | # Do not modify this line, instead modify the lines below.
+ The Task Runner pod is used to execute periodic housekeeping tasks within the GitLab application and is often confused with the GitLab Runner. Thus, [Task Runner will be renamed to Toolbox](https://gitlab.com/groups/gitlab-org/charts/-/epics/25).
+
+ 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`.
diff --git a/data/deprecations/serverless.yml b/data/deprecations/serverless.yml
new file mode 100644
index 00000000000..1b99ece154f
--- /dev/null
+++ b/data/deprecations/serverless.yml
@@ -0,0 +1,13 @@
+- name: "GitLab Serverless"
+ announcement_milestone: "14.3"
+ announcement_date: "2021-09-22"
+ removal_milestone: "15.0"
+ body: |
+ [GitLab Serverless](https://docs.gitlab.com/ee/user/project/clusters/serverless/) is a feature set to support Knative-based serverless development with automatic deployments and monitoring.
+
+ 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.
+ stage: Configure
+ tiers: [Core, Premium, Ultimate]
+ issue_url: "https://gitlab.com/groups/gitlab-org/configure/-/epics/6"
+ documentation_url: "https://docs.gitlab.com/ee/user/project/clusters/serverless/"
+
diff --git a/data/deprecations/templates/_deprecation_template.md.erb b/data/deprecations/templates/_deprecation_template.md.erb
new file mode 100644
index 00000000000..64bd6a75a5e
--- /dev/null
+++ b/data/deprecations/templates/_deprecation_template.md.erb
@@ -0,0 +1,32 @@
+---
+stage: none
+group: none
+info: "See the Technical Writers assigned to Development Guidelines: https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments-to-development-guidelines"
+---
+
+# Deprecated feature removal schedule
+
+<!--
+This page is automatically generated from the YAML files in `/data/deprecations` by the rake task
+located at `lib/tasks/gitlab/docs/compile_deprecations.rake`.
+
+Do not edit this page directly.
+
+To add a deprecation, use the example.yml file in `/data/deprecations/templates` as a template,
+then run `bin/rake gitlab:docs:compile_deprecations`.
+-->
+<% if milestones.any? -%>
+ <%- milestones.each do |milestone| %>
+## <%= milestone %>
+ <%- deprecations.select{|d| d["removal_milestone"] == milestone}.each do |deprecation| %>
+### <%= deprecation["name"]%>
+
+<%= deprecation["body"] -%>
+
+Announced: <%= deprecation["announcement_date"]%>
+ <%- end -%>
+ <%- end -%>
+<%- else -%>
+
+Deprecated features scheduled for removal will be listed here, sorted by GitLab milestone.
+<% end -%>
diff --git a/data/deprecations/templates/example.yml b/data/deprecations/templates/example.yml
new file mode 100644
index 00000000000..f665dd21530
--- /dev/null
+++ b/data/deprecations/templates/example.yml
@@ -0,0 +1,33 @@
+# This is a template for a feature deprecation
+# A deprecation typically occurs when a feature or capability is planned to be removed in a future release.
+# Deprecations should be announced at least two releases prior to removal. Any breaking changes should only be done in major releases.
+#
+# Below is an example of what a single entry should look like, it's required attributes,
+# and what types we expect those attribute values to be.
+#
+# For more information please refer to the handbook documentation here:
+# {{LINK TBD}}
+#
+# Please delete this line and above before submitting your merge request.
+
+- name: "Feature name" # The name of the feature to be deprecated
+ announcement_milestone: "XX.YY" # The milestone when this feature was first announced as deprecated.
+ announcement_date: "YYYY-MM-DD" # The date of the milestone release when this feature was first announced as deprecated
+ removal_milestone: "XX.YY" # The milestone when this feature is planned to be removed
+ body: | # Do not modify this line, instead modify the lines below.
+ <!-- START OF BODY COMMENT
+
+ This area supports markdown. Delete this entire comment and replace it with your markdown content.
+
+ Make sure to run `bin/rake gitlab:docs:compile_deprecations` locally before committing and pushing your changes.
+
+ When ready, assign to your tech writer to review and merge.
+
+ END OF BODY COMMENT -->
+ stage: # (optional - may be required in the future) String value of the stage that the feature was created in. e.g., Growth
+ 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]
+ issue_url: # (optional) This is a link to the deprecation issue in GitLab
+ documentation_url: # (optional) This is a link to the current documentation page
+ image_url: # (optional) This is a link to a thumbnail image depicting the feature
+ video_url: # (optional) Use the youtube thumbnail URL with the structure of https://img.youtube.com/vi/UNIQUEID/hqdefault.jpg
+ removal_date: # (optional - may be required in the future) YYYY-MM-DD format - the date of the milestone release when this feature is planned to be removed