debian-mirror-gitlab/.gitlab/issue_templates/Feature Flag Roll Out.md

56 lines
2.5 KiB
Markdown
Raw Normal View History

2019-09-04 21:01:54 +05:30
<!-- Title suggestion: [Feature flag] Enable description of feature -->
## What
Remove the `:feature_name` feature flag ...
## Owners
- Team: NAME_OF_TEAM
- Most appropriate slack channel to reach out to: `#g_TEAM_NAME`
- Best individual to reach out to: NAME
## Expectations
2020-10-24 23:57:45 +05:30
### What are we expecting to happen?
2019-09-04 21:01:54 +05:30
### What might happen if this goes wrong?
### What can we monitor to detect problems with this?
2021-02-22 17:27:13 +05:30
<!-- Which dashboards from https://dashboards.gitlab.net are most relevant? Sentry errors reports can alse be useful to review -->
2019-09-04 21:01:54 +05:30
## Beta groups/projects
If applicable, any groups/projects that are happy to have this feature turned on early. Some organizations may wish to test big changes they are interested in with a small subset of users ahead of time for example.
2019-12-21 20:55:43 +05:30
- `gitlab-org/gitlab` project
2019-09-04 21:01:54 +05:30
- `gitlab-org`/`gitlab-com` groups
- ...
## Roll Out Steps
2021-01-03 14:25:43 +05:30
- [ ] Enable on staging (`/chatops run feature set feature_name true --staging`)
2019-09-04 21:01:54 +05:30
- [ ] Test on staging
- [ ] Ensure that documentation has been updated
2021-01-03 14:25:43 +05:30
- [ ] Enable on GitLab.com for individual groups/projects listed above and verify behaviour (`/chatops run feature set --project=gitlab-org/gitlab feature_name true`)
2021-01-29 00:20:46 +05:30
- [ ] Coordinate a time to enable the flag with the SRE oncall and release managers
2021-02-22 17:27:13 +05:30
- In `#production` mention `@sre-oncall` and `@release-managers`. Once an SRE on call and Release Manager on call confirm, you can proceed with the rollout
2019-09-04 21:01:54 +05:30
- [ ] Announce on the issue an estimated time this will be enabled on GitLab.com
2021-01-03 14:25:43 +05:30
- [ ] Enable on GitLab.com by running chatops command in `#production` (`/chatops run feature set feature_name true`)
- [ ] Cross post chatops Slack command to `#support_gitlab-com` ([more guidance when this is necessary in the dev docs](https://docs.gitlab.com/ee/development/feature_flags/controls.html#where-to-run-commands)) and in your team channel
2019-09-04 21:01:54 +05:30
- [ ] Announce on the issue that the flag has been enabled
2021-03-11 19:13:27 +05:30
- [ ] Remove feature flag and add changelog entry. Ensure that the feature flag definition YAML file has been removed in the **same MR** that is removing the feature flag from the code
2019-10-12 21:52:04 +05:30
- [ ] After the flag removal is deployed, [clean up the feature flag](https://docs.gitlab.com/ee/development/feature_flags/controls.html#cleaning-up) by running chatops command in `#production` channel
2019-09-04 21:01:54 +05:30
2021-01-29 00:20:46 +05:30
## Rollback Steps
- [ ] This feature can be disabled by running the following Chatops command:
```
/chatops run feature set --project=gitlab-org/gitlab feature_name false
```
2019-09-04 21:01:54 +05:30
/label ~"feature flag"