[15.0 Feature flag] Rollout of legacy approval_status removal for License Compliance
Summary
Remove legacy approval_status for License Compliance.
Owners
- Team: groupcomposition analysis
- Most appropriate slack channel to reach out to:
#g_secure-composition-analysis
- Best individual to reach out to: @ifrenkel
- PM: @NicoleSchwartz
- Feature Flag name:
lc_remove_legacy_approval_status
Stakeholders
N/A
Expectations
What are we expecting to happen?
Once enabled, legacy approval_status for License Compliance will be removed.
When is the feature viable?
Upon the completion of the following 2 issues and milestone %15.0:
- #333578 (closed) [backend]
- #335868 (closed) [frontend]
What might happen if this goes wrong?
- the license policy list in the MR widget will be broken (unknown policies only)
- the api will return classification rather than legacy status prematurely (before official removal in %15.0)
What can we monitor to detect problems with this?
- the license policy list in the MR widget will be broken
What can we check for monitoring production after rollouts?
This is a user facing feature flag - errors won't show up in logs or other monitoring tools.
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 lc_remove_legacy_approval_status true --dev
-
/chatops run feature set lc_remove_legacy_approval_status true --staging
-
-
Verify that the feature works as expected. Posting the QA result in this issue is preferable.
Specific rollout on production
- Ensure that the feature MRs have been deployed to both production and canary.
-
/chatops run auto_deploy status <merge-commit-of-your-feature>
-
- This FF uses project-actor, and must be enabled this way:
-
/chatops run feature set --project=gitlab-org/gitlab lc_remove_legacy_approval_status true
-
/chatops run feature set --project=gitlab-org/gitlab-foss lc_remove_legacy_approval_status true
-
/chatops run feature set --project=gitlab-com/www-gitlab-com lc_remove_legacy_approval_status true
-
-
Verify that the feature works on the specific entries. Posting the QA result in this issue is preferable.
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. -
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_secure-composition-analysis
).
-
Incrementally roll out the feature. - If the feature flag in code has an actor, perform actor-based rollout.
-
/chatops run feature set lc_remove_legacy_approval_status <rollout-percentage> --actors
-
- If the feature flag in code does NOT have an actor, perform time-based rollout (random rollout).
-
/chatops run feature set lc_remove_legacy_approval_status <rollout-percentage>
-
- Enable the feature globally on production environment.
-
/chatops run feature set lc_remove_legacy_approval_status true
-
- If the feature flag in code has an actor, perform actor-based rollout.
-
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 lc_remove_legacy_approval_status
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 cleanup 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 <merge-commit-of-cleanup-mr>
-
-
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 lc_remove_legacy_approval_status --dev
-
/chatops run feature delete lc_remove_legacy_approval_status--staging
-
/chatops run feature delete lc_remove_legacy_approval_status
-
-
Close this rollout issue.
Rollback Steps
-
This feature can be disabled by running the following Chatops command:
/chatops run feature set lc_remove_legacy_approval_status false