[Feature flag] Rollout of `pages_smart_check_outdated_sha`
Summary
This issue is to rollout the feature on production,
that is currently behind the pages_smart_check_outdated_sha
feature flag.
Owners
- Team: ~"group::release"
- Most appropriate slack channel to reach out to:
#s_release
- Best individual to reach out to: @jaime @vshushlin
- PM: @kbychu
Stakeholders
The Rollout Plan
- Partial Rollout on GitLab.com with testing groups
- Rollout on GitLab.com for a 1 week
- Rollout Feature for everyone as soon as it's ready
Testing Groups/Projects/Users
-
gitlab-org/gitlab
project -
gitlab-org
/gitlab-com
groups - ...
Expectations
What are we expecting to happen?
This feature flag should mitigate the problem described in #208322 (closed). Meaning less Pages deployments should fail with the error build SHA is outdated for this ref
What might happen if this goes wrong?
Pipelines with pages
jobs:
- may succeed publishing content that might not be the latest.
- may fail even though they are the latest ones.
What can we monitor to detect problems with this?
Check pages:deploy
jobs for failures, for example for gitlab-org/gitlab
#336642 (closed)
Rollout Steps
Rollout on non-production environments
-
Ensure that the feature MRs have been deployed to non-production environments. -
/chatops run auto_deploy status 8a0389fe2caf91ff289b67374a5993c54ca4fd45
-
-
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 <merge-commit-of-your-feature>
-
-
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. -
If the feature might impact the user experience, notify #support_gitlab-com
and your team channel (more guidance when this is necessary in the dev docs). -
If the feature flag in code has an actor, enable it on GitLab.com for testing groups/projects. -
/chatops run feature set --<actor-type>=<actor> pages_smart_check_outdated_sha true
-
-
Verify that the feature works as expected. Posting the QA result in this issue is preferable.
Global rollout on production
-
Incrementally roll out the feature. - If the feature flag in code has an actor, perform actor-based rollout.
-
/chatops run feature set pages_smart_check_outdated_sha 10 --actors
2021-09-07 -
/chatops run feature set pages_smart_check_outdated_sha 25 --actors
2021-09-09 -
/chatops run feature set pages_smart_check_outdated_sha 50 --actors
2021-09-17 -
/chatops run feature set pages_smart_check_outdated_sha 75 --actors
2021-09-21 -
/chatops run feature set pages_smart_check_outdated_sha 100 --actors
2021-09-29
-
- 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.
-
Create a merge request to remove pages_smart_check_outdated_sha
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 e60ba66fa56b2de7e1b2546783682bf12305ca96
-
-
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 pages_smart_check_outdated_sha --dev
-
/chatops run feature delete pages_smart_check_outdated_sha --staging
-
/chatops run feature delete pages_smart_check_outdated_sha
-
-
Close this rollout issue.
Rollback Steps
-
This feature can be disabled by running the following Chatops command:
/chatops run feature set pages_smart_check_outdated_sha false