Skip to content

Deprecation - Make `gitlab-runner-helper-images` an optional dependency of `gitlab-runner` package

Deprecation Summary

Starting with %18.0, the gitlab-runner-helper-images OS rpm and deb packages published to our package-cloud instance will be an optional dependency of the gitlab-runner package.

Currently the gitlab-runner OS package has a hard dependency on the gitlab-runner-helper-images, which means users are forced to install the latter package even if they do not need the exported helper images. Breaking Change - Make `gitlab-runner-helper-im... (gitlab-runner#38353) proposes making the dependency optional, so users that only want/need the gitlab-runner binary can install just that.

Breaking Change - Make `gitlab-runner-helper-im... (gitlab-runner#38353) is the final step in a long standing issue Fix GitLab Runner Docker Packaging + bare insta... (gitlab-runner#28014 - closed).

Documentation

Product Usage

Making gitlab-runner-helper-images an optional dependency of gitlab-runner, described here is the final step in a long standing issue Fix GitLab Runner Docker Packaging + bare insta... (gitlab-runner#28014 - closed). This change will allow users that only want the gitlab-runner binary to install just that. Users that need the exported helper images can explicitly install the gitlab-runner-helper-images package.

See gitlab-runner#38353 (comment 2337803178) for an estimate on the number of affected customers.

Unfortunately we do not collect data indicating how many users rely on exported helper images, so we have no way of knowing how many users may be impacted by this change. However, the change only affects users that:

  1. Host their own gitlab-runner fleet.
  2. Install gitlab-runner from the OS packages we provide (i.e. they do not install binaries directly or use one of the docker image we provide).
  3. Use the the docker-executor.
  4. Operate in so-called "air-gapped" environments.
  5. Do not use the fips flavour of the gitlab-runner package.
  6. On deb systems, are upgrading to the latest version of gitlab-runner (i.e. not installing a specific version).

Users that are concerned with security enough to operate in "air-gapped" environments likely also use the fips version of the gitlab-runner package (they should do); the gitlab-runner-fips package already includes the exported fips helper image, which further decreases the potentially affected user-base.

Users affected by this change must explicitly install the gitlab-runner-helper-images package:

For rpm based systems

> dnf install gitlab-runner-helper-images

For deb based systems

> apt install gitlab-runner-helper-images

Breaking Change?

Does this deprecation contain a breaking change? Yes

Affected Customers

Users in all tiers are affected equally, as are users of GitLab.com or self-hosted. Unfortunately we do not collect data indicating how many users rely on exported helper images, so we have no way of knowing how many users may be impacted by this change. However, the change only affects users that:

  1. Host their own gitlab-runner fleet.
  2. Install gitlab-runner from the OS packages we provide (i.e. they do not install binaries directly or use one of the docker image we provide).
  3. Use the the docker-executor.
  4. Operate in so-called "air-gapped" environments.
  5. Do not use the fips flavour of the gitlab-runner package.
  6. On deb systems, are upgrading to the latest version of gitlab-runner (i.e. not installing a specific version).
  • GitLab.com
  • Self-managed
  • Dedicated

What pricing tiers are impacted?

  • GitLab Free

  • GitLab Premium

  • GitLab Ultimate

  • Internal note outlining details of customer impact has been created

Deprecation Milestone

This deprecation will be announced in milestone: 17.9.0

Planned Removal Milestone

The feature / functionality will be removed in milestone: 18.0

Links

Checklists

Timeline

Rollout Plan

  • DRI Engineers: @engineer(s)

  • DRI Engineering Manager: @EM

  • Describe rollout plans on GitLab.com

    • Link to a feature flag rollout issue that covers:
      • Expected release date on GitLab.com and GitLab version
      • Rollout timelines, such as a percentage rollout on GitLab.com
      • Creation of any clean-up issues, such as code removal

  • Determine how to migrate users still using the existing functionality

  • Document ways to migrate with the tooling available

  • Automate any users who have not yet migrated, but ensure it's a two-way door decision

Communication Plan

Internal Communication Plan

  • Create an internal note in the comment thread of this issue with a comprehensive narrative of customer impacts, with the intended audience of internal stakeholders who directly interact with customers.
    • Consider: what will the CSM / AE / SA teams need to tell their customers? What will they want to know about customer sentiment and impact?
    • If customers must take an action, include in this internal note the following information: what action is needed, the steps they can take to complete it, the due date for that action, and the consequences of not completing the action in time.
  • Internal announcement plan (timeline for notifications, audience, channels, etc)
  • Support and enablement plan
    • Support readiness: Document how the support team should handle tickets related to this deprecation / breaking change.
    • Customer Success readiness: Ensure the CS team knows how to bring questions or concerns from clients to the right internal team members.

External Communication Plan

  • Customer announcement plan (timeline for notifications, audience, channels, etc)
  • Ensure you have approvals from legal and corp comms for any communication being sent directly to customers.
  • As soon as possible, but no later than the third milestone preceding the major release, ensure that the following are complete (for example, given the following release schedule: 17.8, 17.9, 17.10, 17.11, 18.0 – 17.9 is the third milestone preceding the major release).
  • On the major milestone:
    • The deprecated item has been removed. Add link to the relevant merge request.
    • If the removal of the deprecated item is a breaking change, the merge request is labeled breaking change.
    • Document the migration plan for users, clearly outlining the actions they need to take to mitigate the impact of the breaking change.

Development

  • DRI Engineers: @avonbertoldi

  • DRI Engineering Manager: @nicolewilliams

  • Measure usage of the impacted product feature

    • Evaluate metrics across GitLab.com, Self-Managed, Dedicated
    • add issue link
    • list any metrics and/or dashboards

  • Create tooling for customers to manually migrate their data or workflows

    • add issue link

  • Build mechanism for users to manually enable the breaking change ahead of time

    • add issue link

  • Automate the migration for those who do not take any manual steps (ensure the automation can be reverted)

    • add issue link

  • Develop rollout plan of breaking change on GitLab.com

    • add feature flag rollout issue

  • Dogfood the changes on GitLab.com or a Self-Managed test instance

    • add issue link

  • (Optional) Create UI controls for instance admins to disable the breaking change, providing flexibility to Self-Managed / Dedicated customers. Optional as this depends on the breaking change.

    • add issue link

Approvals

  • Product Manager @PM
  • Engineering Manager @nicolewilliams`
  • Senior Engineering Manager / Director @senior-eng-leader
  • Group / Director of Product Management @jreporter

Keep in mind that approval check boxes and deprecations notices alone are not sufficient communication about breaking changes. Despite having approvals documented here, the PM/EM will still need to take active steps to partner with internal stakeholders and customers to ensure a positive user experience.

Stakeholder Mentions

  • Product Designer @ProductDesigner
  • Tech Writer @TW
  • Software Engineering in Test @SET
  • Any other stable counterparts based on the product categories:
    • Add Sales/CS counterpart or mention @timtams
    • Add Support counterpart or mention @gitlab-com/support/managers
    • Add Marketing counterpart or mention @martin_klaus
    • Add Corp comms if direct customer comms are needed @jmalleo
    • Add Product Security counterpart, if relevant to your deprecation
    • Mention (in internal note) Customer Success Managers / Acount Managers / Solutions Architects for impacted customers

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.

References

Edited by Darren Eastman