[Feature flag] Enable arel package scopes
Summary
This issue is to rollout the feature on production,
that is currently behind the arel_package_scopes
feature flag.
Owners
- Team: Package
- Most appropriate slack channel to reach out to:
#s_package
- Best individual to reach out to: Steve Abrams
@sabrams
- PM: Tim Rizzi
@trizzi
The Rollout Plan
- Percentage Rollout on GitLab.com
The group package API endpoints should be monitored to ensure there are no errors or performance degradations.
https://log.gprd.gitlab.net/app/lens#/edit/1c45f420-be5b-11eb-bfb9-1fcb9ca7f31a?_g=h@c823129
Expectations
What are we expecting to happen?
No change should be noted in the GitLab application. The group package API endpoints should be monitored to ensure there are no errors or performance degradations.
What might happen if this goes wrong?
The feature flag should be turned off if there are indicators in decreased performance, or new errors being thrown from group-level APIs.
What can we monitor to detect problems with this?
Rollout Steps
Rollout on non-production environments
-
Ensure that the feature MRs have been deployed to non-production environments. -
/chatops run auto_deploy status 8375fd59
-
-
Enable the feature globally on non-production environments. -
/chatops run feature set arel_package_scopes true --dev
-
/chatops run feature set arel_package_scopes true --staging
-
-
Verify that the feature works as expected. Posting the QA result in this issue is preferable.
Preparation before production rollout
-
Ensure that the feature MRs have been deployed to both production and canary. -
/chatops run auto_deploy status 8375fd59
-
-
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.
Global rollout on production
-
Incrementally roll out the feature. -
If the feature flag in code does NOT have an actor, perform time-based rollout (random rollout).
-
/chatops run feature set arel_package_scopes 10
-
/chatops run feature set arel_package_scopes 30
-
/chatops run feature set arel_package_scopes 60
-
/chatops run feature set arel_package_scopes 100
-
-
Enable the feature globally on production environment.
-
/chatops run feature set arel_package_scopes true
-
-
-
Announce on the feature issue that the feature has been globally enabled. -
Cross-post chatops slack command to #support_gitlab-com
. (more guidance when this is necessary in the dev docs) and in your team channel -
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.
-
Create a merge request to remove arel_package_scopes
feature flag. Ask for review and merge it.-
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 above MR has been deployed to both production and canary. If the merge request was deployed before the code cutoff, the feature can be officially announced in a release blog post. -
/chatops run auto_deploy status 0a3917de
-
-
Close the feature issue 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 arel_package_scopes --dev
-
/chatops run feature delete arel_package_scopes --staging
-
/chatops run feature delete arel_package_scopes
-
-
Close this rollout issue.
Rollback Steps
-
This feature can be disabled by running the following Chatops command:
/chatops run feature set arel_package_scopes false