### Deprecation Summary Spawned from https://gitlab.com/gitlab-org/gitlab/-/issues/411950#note_1426993114 With the introduction of `runner managers` in the runner API, some fields no longer make sense for [CiRunner](https://docs.gitlab.com/ee/api/graphql/reference/#cirunner) as they can differ for each `runner managers` that belong to the same `runner configuration`. In this context, `runner manager` refers to a runner entity that is a member of a runner configuration group. A runner configuration group is the terminology we use now with the new runner creation workflows and the ability to [reuse a runner authentication token](https://docs.gitlab.com/ee/architecture/blueprints/runner_tokens/#reusing-the-runner-authentication-token-across-many-machines). ### Breaking Change **Yes** #### GraphQL The following fields will be removed from the GraphQL [CiRunner type](https://docs.gitlab.com/ee/api/graphql/reference/#cirunner): ``` architectureName executorName ipAddress platformName revision version ``` #### REST API #### Description `ip_address` for an individual GitLab runner doesn't make sense now when we can have multiple runner managers assigned to the same runner with different IP's. - Starting from 17.0 it will return `""` or `null`. - In the Rest API v5 it will be removed #### How to migrate Use `RunnerManager` fields instead for GraphQL. We don't have REST API for runner managers, so use GraphQL, if you need to retrieve ip addresses for each runner entity. ### Affected Topology Both self-managed and SAAS. ### 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): - [x] A [deprecation announcement entry](https://about.gitlab.com/handbook/marketing/blog/release-posts/#creating-the-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). - [x] 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/#creating-the-announcement-1) 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** - [x] 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` - [x] 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 ? --> %"16.2" ### Planned Removal Milestone <!-- In which milestone will the feature or functionality be removed and announced? --> %"17.0" ### 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/ --> ### Deployment We're planning to merge this in the second breaking change window: `2024-04-29 09:00 UTC to 2024-05-01 22:00 UTC` <!-- 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 -->