[Feature flag] background_pipeline_retry_endpoint rollout
Summary
This issue is to rollout moving the PipelinesController#retry endpoint to be async on production,
that is currently behind the background_pipeline_retry_endpoint
rollout feature flag. Introduced by !61270 (merged)
This feature flag is needed because the switch introduces a new background job. We don't have Sidekiq deployments for canary which means we'd schedule jobs without being able to execute them until this hits production unless we hide it behind a feature flag.
Owners
- Team: Pipeline Authoring
- Most appropriate slack channel to reach out to:
#g_pipeline-authoring
- Best individual to reach out to: Matija Čupić
- PM: No PM, this is a ~"technical debt" change
The Rollout Plan
- Rollout Feature for everyone as soon as it's ready
Expectations
What are we expecting to happen?
Pipeline retry jobs start getting scheduled.
What might happen if this goes wrong?
I don't see how this can go wrong.
What can we monitor to detect problems with this?
Ci::RetryPipelineWorker
background jobs count.
Rollout Steps
Rollout on non-production environments
-
Ensure that the feature MRs have been deployed to non-production environments. -
/chatops run auto_deploy status 8c77a798eabd37175a7ba5f5121e6f9cf5c96be3
-
-
Enable the feature globally on non-production environments. -
/chatops run feature set background_pipeline_retry_endpoint true --dev
-
/chatops run feature set background_pipeline_retry_endpoint 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 8c77a798eabd37175a7ba5f5121e6f9cf5c96be3
-
-
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. -
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 does NOT have an actor, perform time-based rollout (random rollout).
- Enable the feature globally on production environment.
-
/chatops run feature set background_pipeline_retry_endpoint 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 background_pipeline_retry_endpoint
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 102e6724b44e37e45ae591ad09c9968c2648fd45
-
-
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 background_pipeline_retry_endpoint --dev
-
/chatops run feature delete background_pipeline_retry_endpoint --staging
-
/chatops run feature delete background_pipeline_retry_endpoint
-
-
Close this rollout issue.
Rollback Steps
-
This feature can be disabled by running the following Chatops command:
/chatops run feature set background_pipeline_retry_endpoint false