Skip to content

Deprecate CiRunner fields duplicated in runner manager

Deprecation Summary

Spawned from #411950 (comment 1426993114)

With the introduction of runner managers in the runner API, some fields no longer make sense for 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.

Breaking Change

Yes

GraphQL

The following fields will be removed from the GraphQL CiRunner type:

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

  • This issue is labeled deprecation, and with the relevant ~devops::, ~group::, and ~Category: labels.
  • This issue is labeled breaking change if the removal of the deprecated item will be a breaking change.

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):
  • On or before the major milestone: A removal entry has been created so the removal will appear on the removals by milestones page and be announced in the release post.
  • On the major milestone:

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
      • 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

%16.2

Planned Removal Milestone

%17.0

Links

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

Edited by Pedro Pombeiro