For guidance on the overall deprecations, removals and breaking changes workflow, please visit [Breaking changes, deprecations, and removing features](https://about.gitlab.com/handbook/product/gitlab-the-product/#deprecations-removals-and-breaking-changes) <!-- Use this template as a starting point for deprecations. --> This came up from these discussions: - https://gitlab.com/gitlab-org/gitlab/-/merge_requests/103170#note_1166261095 - [Sync standup discussion (7 November 2022), item 3 raised by `Pam`](https://docs.google.com/document/d/1QafnAEZ90WdsE8UAH8UPRh_TS4QnNlMdYQF2seG9vLw/edit#heading=h.v0y9kjlghi5p) ### Deprecation Summary Currently, the Cluster Agents API -> Agent Tokens endpoints return the revoked tokens on GET requests. We (~"group::configure") came to the agreement that, in the medium term (ie next major milestone), revoked tokens should not be shown/included in the APIs (REST and GraphQL) and the UI. In the short term, a deprecation note should be added to indicate that the behavior of these endpoints will change: - REST API - List tokens - [documentation](https://docs.gitlab.com/ee/api/cluster_agents.html#list-tokens-for-an-agent) | [code](https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/api/clusters/agent_tokens.rb#L20-L33) - Get a single token - [documentation](https://docs.gitlab.com/ee/api/cluster_agents.html#get-a-single-agent-token) | [code](https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/api/clusters/agent_tokens.rb#L35-L49) - GraphQL - `ClusterAgent.tokens` - [documentation](https://docs.gitlab.com/ee/api/graphql/reference/#clusteragenttokens) | [code](https://gitlab.com/gitlab-org/gitlab/-/blob/master/app/graphql/types/clusters/agent_type.rb#L36-L39) Notes from deprecation issue template: > The description of the deprecation should state what actions the user should take to rectify the behavior. If the deprecation is scheduled for an upcoming release, the content should remain in the deprecations documentation page until it has been completed. For example, if a deprecation is announced in 14.9 and scheduled to be completed in 15.0, the same content would be included in the documentation for 14.9, 14.10, and 15.0. ### Breaking Change Users should review their calls to these endpoints and check if they are using the revoked tokens. - REST API [List tokens](https://docs.gitlab.com/ee/api/cluster_agents.html#list-tokens-for-an-agent) - REST API [Get a single token](https://docs.gitlab.com/ee/api/cluster_agents.html#get-a-single-agent-token) API endpoints . - GraphQL [`ClusterAgent.tokens`](https://docs.gitlab.com/ee/api/cluster_agents.html#get-a-single-agent-token) ### Affected Topology This affects self-managed and SaaS users ### Affected Tier * Free ### Checklists **Labels** - [x] This issue is labeled ~deprecation, and with the relevant `~devops::`, `~group::`, and `~Category:` labels. - [x] This issue is labeled ~"breaking change" if the removal of the deprecated item will be a [breaking change](https://about.gitlab.com/handbook/product/gitlab-the-product/#examples-of-breaking-changes). **Timeline** Please add links to the relevant merge requests. - As soon as possible, but no later than the third milestone preceding the major release (for example, given the following release schedule: `14.8, 14.9, 14.10, 15.0` – `14.8` is the third milestone preceding the major release): - [ ] A [deprecation announcement entry](https://about.gitlab.com/handbook/marketing/blog/release-posts/#creating-a-deprecation-announcement) has been created so the deprecation will appear in release posts and on the [general deprecation page](https://docs.gitlab.com/ee/update/deprecations). - [ ] Documentation has been updated to mark the feature as [deprecated](https://docs.gitlab.com/ee/development/documentation/versions.html#deprecations-and-removals). - [ ] On or before the major milestone: A [removal entry](https://about.gitlab.com/handbook/marketing/blog/release-posts/#removals) has been created so the removal will appear on the [removals by milestones](https://docs.gitlab.com/ee/update/removals) page and be announced in the release post. - On the major milestone: - [ ] The deprecated item has been removed. - [ ] If the removal of the deprecated item is a [breaking change](https://about.gitlab.com/handbook/product/gitlab-the-product/#examples-of-breaking-changes), the merge request is labeled ~"breaking change". **Mentions** - [ ] Your stage's stable counterparts have been `@mentioned` on this issue. For example, Customer Support, Customer Success (Technical Account Manager), Product Marketing Manager. - To see who the stable counterparts are for a product team visit [product categories](https://about.gitlab.com/handbook/product/categories/) - If there is no stable counterpart listed for Sales/CS please mention `@timtams` - If there is no stable counterpart listed for Support please mention `@gitlab-com/support/managers` - If there is no stable counterpart listed for Marketing please mention `@cfoster3` - [ ] Your GPM has been `@mentioned` so that they are aware of planned deprecations. The goal is to have reviews happen at least two releases before the final removal of the feature or introduction of a breaking change. ### Deprecation Milestone <!-- In which milestone will this deprecation be announced ? --> ### Planned Removal Milestone <!-- In which milestone will the feature or functionality be removed and announced? --> ### Links <!-- Add links to any relevant documentation or code that will provide additional details or clarity regarding the planned change. This issue is the main SSOT for the deprecations and removals process. Be sure to link all issues and MRs related to this deprecation/removal to this issue. This can include removal issues that were created ahead of time, and the MRs doing the actual deprecation/removal work. --> <!-- Label reminders - you should have one of each of the following labels. Use the following resources to find the appropriate labels: - https://gitlab.com/gitlab-org/gitlab/-/labels - https://about.gitlab.com/handbook/product/categories/features/ --> <!-- Populate the Section, Group, and Category --> <!-- Choose the Pricing Tier(s) --> <!-- Identifies that this Issue is related to deprecating a feature --> <!-- Add the ~"breaking change" label to this issue if necessary -->