## Summary This issue is to roll out [the migration to Vue of admin UI](https://gitlab.com/gitlab-org/gitlab/-/issues/329658) on production, which is currently behind the `runner_list_view_vue_ui` feature flag. :warning: This UI uses `runner_graphql_query` that is not yet available everywhere. See: https://gitlab.com/gitlab-org/gitlab/-/issues/328700 <img src="/uploads/8204a67e127b125e2348dc9db3f253ed/Screen_Shot_2021-07-05_at_11.06.51_AM.png" width="400px" /> ## Owners - Team: ~"group::runner" - Most appropriate slack channel to reach out to: `#g_runner` - Best individual to reach out to @mrincon - PM: @DarrenEastman ## Stakeholders - @DarrenEastman ## Testing Groups/Projects/Users - @tmaczukin - @ahanselka - @jeffersonmartin - @amyphillips ## Expectations ### What are we expecting to happen? The UI is migrated and all features work as before. ### What might happen if this goes wrong? This feature flag can be enabled/disabled for each individual administrator. As gitlab.com admins can directly notify the ~"group::runner" team and @mrincon we consider the rollout low risk. ### What can we monitor to detect problems with this? We can monitor UI errors in sentry: https://sentry.gitlab.net/gitlab/gitlabcom-clientside/?query=feature_category%3Arunner ## Rollout Steps ### Preparation before production rollout - [x] Ensure that the feature MRs have been deployed to both production and canary. (Representative sample of related commits) - [x] `/chatops run auto_deploy status ddc541bb444ccdba4be077211609c603f57eda61` https://gitlab.slack.com/archives/CB2S7NNDP/p1626080491121200 - [x] `/chatops run auto_deploy status 53e951cdb2b2b2debdb7918ab9246005cd41db12` https://gitlab.slack.com/archives/CB2S7NNDP/p1626080533121400 - [x] `/chatops run auto_deploy status d01f632f805dc8c9802a16d173dcdf7946ce2763` https://gitlab.slack.com/archives/CB2S7NNDP/p1626080556121600 - [x] `/chatops run auto_deploy status 0594750d9f897083a4883fe92971889472a42534` https://gitlab.slack.com/archives/CB2S7NNDP/p1626088194122400 - [x] 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. - [x] Ensure that documentation has been updated ([More info](https://docs.gitlab.com/ee/development/documentation/feature_flags.html#features-that-became-enabled-by-default)). - [x] If the feature flag in code has [an actor](https://docs.gitlab.com/ee/development/feature_flags/#feature-actors), enable it on GitLab.com for [testing groups/projects](#testing-groupsprojectsusers). - [x] `@tmaczukin` - `/chatops run feature set --user=tomasz.admin runner_list_view_vue_ui true` - [x] `@ahanselka` - `/chatops run feature set --user=ahanselka-admin runner_list_view_vue_ui true` - [x] Verify that the feature works as expected. Posting the QA result in this issue is preferable. - Rollout on staging.gitLab.com with testing admin users - [x] `/chatops run feature set runner_list_view_vue_ui true --staging` - Partial Rollout on other environments with testing admin users - [x] `@jeffersonmartin` (demo env.) - [ ] `@amyphillips` (demo env.) ### Global rollout on production - Rollout on GitLab.com for a certain period - This feature will be enabled for 2 days prior to release. - ~~If the feature flag in code does **NOT** have [an actor](https://docs.gitlab.com/ee/development/feature_flags/#feature-actors), perform time-based rollout (**random** rollout).~~ - [ ] ~~`/chatops run feature set runner_list_view_vue_ui <rollout-percentage>`~~ There is a only a limited amount of administrators in gitlab.com, so using a percentage rollout would no create a prepresentative sample of users. - Enable the feature globally on production environment. - [x] `/chatops run feature set runner_list_view_vue_ui true` - [x] Announce on [the feature issue](https://gitlab.com/gitlab-org/gitlab/-/issues/329658) an estimated time this will be enabled on GitLab.com. - [x] 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#communicate-the-change)) and in your team channel - [ ] Wait for [at least one day for the verification term](https://about.gitlab.com/handbook/product-development-flow/feature-flag-lifecycle/#including-a-feature-behind-feature-flag-in-the-final-release). ### (Optional) Release the feature with the feature flag If you're still unsure whether the feature is [deemed stable](https://about.gitlab.com/handbook/product-development-flow/feature-flag-lifecycle/#including-a-feature-behind-feature-flag-in-the-final-release) but want to release it in the current milestone, you can change the default state of the feature flag to be enabled. To do so, follow these steps: - [x] Create a merge request with the following changes. Ask for review and merge it. https://gitlab.com/gitlab-org/gitlab/-/merge_requests/65948 - [x] Set the `default_enabled` attribute in [the feature flag definition](https://docs.gitlab.com/ee/development/feature_flags/#feature-flag-definition-and-validation) to `true`. - [x] Create [a changelog entry](https://docs.gitlab.com/ee/development/feature_flags/#changelog). - [ ] Ensure that the above MR has been deployed to both production and canary. If the merge request was deployed before [the code cutoff](https://about.gitlab.com/handbook/engineering/releases/#self-managed-releases-1), the feature can be officially announced in a release blog post. - [ ] `/chatops run auto_deploy status <merge-commit>` - [ ] Close [the feature issue](ISSUE LINK) to indicate the feature will be released in the current milestone. **WARNING:** This approach has the downside that it makes it difficult for us to [clean up](https://docs.gitlab.com/ee/development/feature_flags/controls.html#cleaning-up) the flag. For example, on-premise users could disable the feature on their GitLab instance. But when you remove the flag at some point, they suddenly see the feature as enabled and they can't roll it back to the previous behavior. To avoid this potential breaking change, use this approach only for urgent matters. ### Release the feature After the feature has been [deemed stable](https://about.gitlab.com/handbook/product-development-flow/feature-flag-lifecycle/#including-a-feature-behind-feature-flag-in-the-final-release), the [clean up](https://docs.gitlab.com/ee/development/feature_flags/controls.html#cleaning-up) should be done as soon as possible to permanently enable the feature and reduce complexity in the codebase. <!-- The checklist here is to help stakeholders keep track of the feature flag status --> - [ ] Create a merge request to remove `runner_list_view_vue_ui` feature flag. Ask for review and merge it. - [ ] `spec/features/admin/admin_runners_spec.rb` https://gitlab.com/gitlab-org/gitlab/-/merge_requests/65738/ - [ ] `spec/controllers/admin/runners_controller_spec.rb` - [ ] Remove all references to the feature flag from the codebase. - [ ] Remove the YAML definitions for the feature from the repository. - [ ] Create [a changelog entry](https://docs.gitlab.com/ee/development/feature_flags/#changelog). - [ ] Ensure that the above MR has been deployed to both production and canary. If the merge request was deployed before [the code cutoff](https://about.gitlab.com/handbook/engineering/releases/#self-managed-releases-1), the feature can be officially announced in a release blog post. - [ ] `/chatops run auto_deploy status <merge-commit>` - [ ] Close [the feature issue](ISSUE LINK) 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 runner_list_view_vue_ui --dev` - [ ] `/chatops run feature delete runner_list_view_vue_ui --staging` - [ ] `/chatops run feature delete runner_list_view_vue_ui` - [ ] Close this rollout issue. ## Rollback Steps - [ ] This feature can be disabled by running the following Chatops command: ``` /chatops run feature set runner_list_view_vue_ui false ```