Skip to content

[Feature flag] Rollout `usage_quotas_for_all_editions`

Summary

This issue is to rollout the feature on production, that is currently behind the usage_quotas_for_all_editions feature flag.

The work behind this FF is the Phase 3 of &7176 (closed) and will enable Usage Quotas view for all GitLab Editions.

You can follow the timeline of the rollout of this Feature Flag but looking at comments by @cogbot in the issue timeline, or by reading the comments from @sheldonled here #371639 (comment 1864045986)

Owners

  • Team: Utilization
  • Most appropriate slack channel to reach out to: #g_utilization
  • Best individual to reach out to: @sheldonled.
  • PM: @alex_martin

Expectations

What are we expecting to happen?

We'll enable a new frontend architecture in Group Usage Quotas. Accessible via this url:

  • https://gitlab.com/groups/<group-id>/-/usage_quotas

What can go wrong and how would we detect it?

Users might not get Usage Quotas page loading properly

No expectations of data loss, or stability/availability impact at a system level.

We'll be monitoring manually by accessing the page, and via this Sentry Dashboard.

Rollout Steps

Note: Please make sure to run the chatops commands in the Slack channel that gets impacted by the command.

Rollout on non-production environments

  • Verify the MR with the feature flag is merged to master and have been deployed to non-production environments with /chatops run auto_deploy status <merge-commit-of-your-feature>
  • Enable the feature globally on non-production environments with /chatops run feature set usage_quotas_for_all_editions true --dev --pre --staging --staging-ref
  • Verify that the feature works as expected. The best environment to validate the feature in is staging-canary as this is the first environment deployed to. Make sure you are configured to use canary.
  • If the feature flag causes end-to-end tests to fail, disable the feature flag on staging to avoid blocking deployments.
    • See #qa-staging Slack channel and look for the following messages:
      • test kicked off: Feature flag usage_quotas_for_all_editions has been set to true on **gstg**
      • test result: This pipeline was triggered due to toggling of usage_quotas_for_all_editions feature flag

For assistance with end-to-end test failures, please reach out via the #test-platform Slack channel. Note that end-to-end test failures on staging-ref don't block deployments.

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

  • Ensure that the feature MRs have been deployed to both production and canary with /chatops run auto_deploy status <merge-commit-of-your-feature>
  • Depending on the type of actor you are using, pick one of these options:
    • For project-actor: /chatops run feature set --project=gitlab-org/gitlab,gitlab-org/gitlab-foss,gitlab-com/www-gitlab-com <feature-flag-name> true
    • For group-actor: /chatops run feature set --group=gitlab-org,gitlab-com <feature-flag-name> true
    • For user-actor: /chatops run feature set --user=<gitlab-username-of-dri> <feature-flag-name> true
  • Verify that the feature works for the specific actors.

Preparation before global rollout

  • Set a milestone to this rollout issue to signal for enabling and removing the feature flag when it is stable.
  • 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 exists for the feature, and the version history text has been updated.
  • Leave a comment on the feature issue announcing estimated time when this feature flag 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 the #support_gitlab-com Slack channel 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_utilization).

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.

  • Create a merge request to remove the usage_quotas_for_all_editions feature flag (!149041 (merged)). Ask for review/approval/merge as usual. The MR should include the following changes:
    • Remove all references to the feature flag from the codebase.
    • Remove the YAML definitions for the feature from the repository.
    • Create a changelog entry.
  • 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>
  • Comment on the feature epic to indicate the feature will be released in the current milestone.
  • Clean up the feature flag from all environments by running these chatops command in #production channel: /chatops run feature delete usage_quotas_for_all_editions --dev --pre --staging --staging-ref --production
  • Close this rollout issue.

Rollback Steps

  • This feature can be disabled by running the following Chatops command:
/chatops run feature set usage_quotas_for_all_editions false
  • Disable the feature flag on non-production environments:
/chatops run feature set usage_quotas_for_all_editions false --dev --pre --staging --staging-ref
  • Delete feature flag from all environments:
/chatops run feature delete usage_quotas_for_all_editions --dev --pre --staging --staging-ref --production
Edited by Sheldon Led