[Feature flag] Rollout of `shimo_integration`
Summary
This issue is to rollout Integrate Shimo on production,
that is currently behind the shimo_integration
feature flag.
Use Shimo as a Wiki tool.
Owners
- Team: ~"group::integrations"
- Most appropriate slack channel to reach out to:
#g_ecosystem_integrations
- Best individual to reach out to: @.luke (GitLab.com assisting @icbd from JH)
- PM: @lpeng1991
Stakeholders
Expectations
What are we expecting to happen?
The feature should be enabled with no negative effects to services.
After saving the integration of shimo, will get a Shimo
sidebar menu.
What might happen if this goes wrong?
What can we monitor to detect problems with this?
- Partial Rollout on GitLab.com with testing groups
- Monitor Sentry for errors
- Monitor Kibana and Prometheus latency for all actions of
Projects::Integrations::ShimoController
- Rollout Feature for everyone
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 shimo_integration true --dev
-
/chatops run feature set shimo_integration 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>
-
- If you're using project-actor, you must enable the feature on these entries:
-
/chatops run feature set --project=gitlab-org/gitlab shimo_integration true
-
/chatops run feature set --project=gitlab-org/gitlab-foss shimo_integration true
-
/chatops run feature set --project=gitlab-com/www-gitlab-com shimo_integration true
-
- If you're using group-actor, you must enable the feature on these entries:
-
/chatops run feature set --group=gitlab-org shimo_integration true
-
/chatops run feature set --group=gitlab-com shimo_integration true
-
- If you're using user-actor, you must enable the feature on these entries:
-
/chatops run feature set --user=<your-username> shimo_integration 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. -
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).
Global rollout on production
For visibility, all /chatops
commands that target production should be:
-
Executed in the
#production
slack channel. -
Cross-posted (with the command results) to the responsible team's slack channel (
#g_TEAM_NAME
). -
Incrementally roll out the feature. - If the feature flag in code has an actor, perform actor-based rollout.
-
/chatops run feature set shimo_integration <rollout-percentage> --actors
-
- If the feature flag in code does NOT have an actor, perform time-based rollout (random rollout).
-
/chatops run feature set shimo_integration <rollout-percentage>
-
- Enable the feature globally on production environment.
-
/chatops run feature set shimo_integration 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.
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 shimo_integration
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 shimo_integration --dev
-
/chatops run feature delete shimo_integration --staging
-
/chatops run feature delete shimo_integration
-
-
Close this rollout issue.
Rollback Steps
-
This feature can be disabled by running the following Chatops command:
/chatops run feature set shimo_integration false