Skip to content

[Feature flag] Enable rename_integrations_workers

Summary

This issue is to rollout the renamed workers for #330670 (closed) on production, which are currently behind the rename_integrations_workers feature flag.

In %15.1 we renamed some workers related to integrations in these MRs:

  • !88558 (merged): ProjectServiceWorker → Integrations::ExecuteWorker
  • !88579 (merged): IrkerWorker → Integrations::IrkerWorker
  • !88582 (merged): Clusters::Applications::(Activate|Deactive)ServiceWorker → Clusters::Applications::(Activate|Deactivate)IntegrationWorker

The old classes and their queues were kept to preserve backwards-compatibility. In %15.2 we can delete these.

Rollout plan:

Owners

  • Team: ~"group::integrations"
  • Most appropriate slack channel to reach out to: #g_ecosystem_integrations
  • Best individual to reach out to: @toupeira
  • PM: @g.hickman

Expectations

What are we expecting to happen?

No disruptions in these workers.

What might happen if this goes wrong?

What can we monitor to detect problems with this?

Sidekiq logs for affected workers (old + new names):

What can we check for monitoring production after rollouts?

Consider adding links to check for Sentry errors, Production logs for 5xx, 302s, etc.

Rollout Steps

Rollout on non-production environments

  • Ensure that the feature MRs have been deployed to non-production environments.
    • /chatops run auto_deploy status <merge-commit-of-your-feature>
  • Enable the feature globally on non-production environments.
    • /chatops run feature set <feature-flag-name> true --dev
    • /chatops run feature set <feature-flag-name> true --staging
  • Verify that the feature works as expected. Posting the QA result in this issue is preferable. The best environment to validate the feature in is staging-canary as this is the first environment deployed to. Note you will need to make sure you are configured to use canary as outlined here when accessing the staging environment in order to make sure you are testing appropriately.

Preparation before global rollout

  • [-] Check if the feature flag change needs to be accompanied with a change management issue. Cross link the issue here if it does.
  • Ensure that you or a representative in development can be available for at least 2 hours after feature flag updates in production. If a different developer will be covering, or an exception is needed, please inform the oncall SRE by using the @sre-oncall Slack alias.
  • Ensure that documentation has been updated (More info).
  • [-] Announce on the feature issue an estimated time this will be enabled on GitLab.com.
  • Ensure that any breaking changes have been announced following the release post process to ensure GitLab customers are aware.
  • Notify #support_gitlab-com and your team channel (more guidance when this is necessary in the dev docs).

Global rollout on production

For visibility, all /chatops commands that target production should be executed in the #production slack channel and cross-posted (with the command results) to the responsible team's slack channel (#g_TEAM_NAME).

  • Roll out the feature.
    • If the feature flag in code has an actor, perform actor-based rollout.
      • [-] /chatops run feature set <feature-flag-name> <rollout-percentage> --actors
    • If the feature flag in code does NOT have an actor, perform time-based rollout (random rollout).
      • [-] /chatops run feature set <feature-flag-name> <rollout-percentage> --random
    • Enable the feature globally on production environment.
      • /chatops run feature set <feature-flag-name> true
  • [-] Announce on the feature issue that the feature has been globally enabled.
  • Wait for at least one day for the verification term.

Release the feature

After the feature has been deemed stable, the clean up should be done as soon as possible to permanently enable the feature and reduce complexity in the codebase.

You can either create a follow-up issue for Feature Flag Cleanup or use the checklist below in this same issue.

  • Create a merge request to remove <feature-flag-name> feature flag. Ask for review and merge it. !90061 (merged)
    • Remove all references to the feature flag from the codebase.
    • Remove the YAML definitions for the feature from the repository.
    • Create a changelog entry.
    • Remove all 4 old worker classes.
    • Remove all 4 old worker queues.
  • Ensure that the cleanup MR has been included in the release package. If the merge request was deployed before the monthly release was tagged, the feature can be officially announced in a release blog post.
    • /chatops run release check <merge-request-url> <milestone>
  • Close the feature issue to indicate the feature will be released in the current milestone.
  • If not already done, clean up the feature flag from all environments by running these chatops command in #production channel:
    • /chatops run feature delete <feature-flag-name> --dev
    • /chatops run feature delete <feature-flag-name> --staging
    • /chatops run feature delete <feature-flag-name>
  • Close this rollout issue.

Rollback Steps

  • This feature can be disabled by running the following Chatops command:
/chatops run feature set <feature-flag-name> false
Edited by Markus Koller