# 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: "Removal of `promote-to-primary-node` command from `gitlab-ctl`" # The name of the feature to be deprecated
  announcement_milestone: "14.5" # The milestone when this feature was first announced as deprecated.
  announcement_date: "2021-11-22" # 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: "15.0" # The milestone when this feature is planned to be removed
  body: | # Do not modify this line, instead modify the lines below.
    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.
  stage: "Enablement"
  tiers: [Premium, Ultimate]
  issue_url: "https://gitlab.com/gitlab-org/gitlab/-/issues/345207"
  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: "2022-05-22"