Skip to content

Remove runnerPlatforms and runnerSetup GraphQL queries

Everyone can contribute. Help move this issue forward while earning points, leveling up and collecting rewards.

For guidance on the overall deprecations, removals and breaking changes workflow, please visit Breaking changes, deprecations, and removing features

Deprecation Summary

In #383139 (comment 1235826920) we decided to have the frontend generate the runner CLI commands to install and register.

These commands are currently generated in the backend, but they will not be maintained anymore.

Documentation

  • Deprecation notice: mr
  • Migration guidelines: N/A - this capability is fully retired.

Breaking Change

Two GraphQL queries are to be deprecated:

query runnerSetupInstructions($platform: String!, $architecture: String!) {
  runnerSetup(platform: $platform, architecture: $architecture) {
    installInstructions
    registerInstructions
  }
}
query getRunnerPlatforms {
  runnerPlatforms {
    nodes {
      name
      humanReadableName
      architectures {
        nodes {
          name
          downloadLocation
        }
      }
    }
  }
}

Affected Customers

Who is affected by this deprecation, Self-managed users, SaaS users, or both? This is especially important when nearing the annual major release where breaking changes and removals are typically introduced. These changes might be seen on GitLab.com before the official release date.

GraphQL API users that rely on this to fetch CLI commands and/or instructions. The operations describe here are manual, so we expect that users automation will not be generally impacted.

Who is affected by this deprecation: GitLab.com users, Self-managed users, or Dedicated users? (choose all that apply)

  • GitLab.com
  • Self-managed
  • Dedicated

Affected Tier

What pricing tiers are impacted?

  • GitLab Free
  • GitLab Premium
  • GitLab Ultimate

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.014.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

Planned Removal Milestone

The feature / functionality will be removed in milestone: 18.0

Links

Edited by 🤖 GitLab Bot 🤖