Rollout ci_catalog_create_metadata
Summary
This issue is to roll out the ci_catalog_create_metadata
feature flag. This is done as a precautionary measure for performance reasons, so it will follow a different workflow.
MR: !134148 (diffs)
Owners
- Most appropriate Slack channel to reach out to:
#g_pipeline_authoring
- Best individual to reach out to: Laura
Rollout Steps
Rollout on non-production environments -
This feature will be rolled out in production only.
-
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 18e8bd6735be3528edb9aa4810507d882afeb44d
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>
-
Enable for staging -
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 ci_catalog_create_metadata true
- For project-actor:
-
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. -
Leave a comment on the feature issue announcing estimated time when this feature flag will be enabled on GitLab.com. -
Notify the #support_gitlab-com
Slack channel and your team channel (more guidance when this is necessary in the dev docs). -
Ensure that the feature flag rollout plan is reviewed by another developer familiar with the domain.
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_TEAM_NAME
).
-
(Optional) Incrementally roll out the feature on production environment. - Between every step wait for at least 15 minutes and monitor the appropriate graphs on https://dashboards.gitlab.net.
- Perform actor-based rollout:
/chatops run feature set <feature-flag-name> <rollout-percentage> --actors
-
Enable the feature globally on production environment: /chatops run feature set <feature-flag-name> true
-
Observe appropriate graphs on https://dashboards.gitlab.net and verify that services are not affected. -
Leave a comment on the feature issue announcing that the feature has been globally enabled. -
Wait for at least one day for the verification term.
Release the feature
-
Create a merge request to remove the <feature-flag-name>
feature flag. 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>
-
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 <feature-flag-name> --dev --ops --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 ci_catalog_create_metadata false
Edited by Laura Montemayor