<!-- Title suggestion: [Feature flag] Enable description of feature --> ## Summary This issue is to roll out [the feature](https://gitlab.com/groups/gitlab-org/-/epics/6870) on production, that is currently behind the `compliance_violations_report` feature flag. The compliance violations report updates the existing compliance dashboard with a new table that pulls in individual violations from merged MR's. Previously, these were dynamically calculated when the dashboard was loaded and was limited to the most recent merged MR of a given project. Now with https://gitlab.com/groups/gitlab-org/-/epics/7222 these violations are saved when the MR is merged and are passed to the ~frontend via GraphQL. This will improve the usability of the compliance report, make it more performant and give us the tools to expand its feature set. ## Owners - Team: Manage::Compliance - Most appropriate slack channel to reach out to: `#g_manage_compliance` - Best individual to reach out to: @rob.hunt - PM: @stkerr ## Stakeholders <!-- Are there any other stages or teams involved that need to be kept in the loop? - Name of a PM - The Support Team - The Delivery Team --> ## Expectations ### What are we expecting to happen? We swap over the UI without issues ### When is the feature viable? Once the feature flag is rolled out ### What might happen if this goes wrong? Turn off the feature flag ### What can we monitor to detect problems with this? <!-- Which dashboards from https://dashboards.gitlab.net are most relevant? --> _Consider mentioning checks for 5xx errors or other anomalies like an increase in redirects (302 HTTP response status)_ ### What can we check for monitoring production after rollouts? _Consider adding links to check for Sentry errors, Production logs for 5xx, 302s, etc._ ## Rollout Steps ### Rollout on non-production environments - Ensure that the feature MRs have been deployed to non-production environments. - [x] `/chatops run auto_deploy status <merge-commit-of-your-feature>` - [x] Enable the feature globally on non-production environments. - [x] `/chatops run feature set compliance_violations_report true --dev` - [x] `/chatops run feature set compliance_violations_report true --staging` - [x] 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. - [x] `/chatops run auto_deploy status <merge-commit-of-your-feature>` - If you're using [group-actor](https://docs.gitlab.com/ee/development/feature_flags/#feature-actors), you must enable the feature on these entries: - [x] `/chatops run feature set --group=gitlab-org compliance_violations_report true` - [x] `/chatops run feature set --group=gitlab-com compliance_violations_report true` - [x] Verify that the feature works on the specific entries. Posting the QA result in this issue is preferable. ### Preparation before global rollout - [x] Check if the feature flag change needs to be accompanied with a [change management issue](https://about.gitlab.com/handbook/engineering/infrastructure/change-management/#feature-flags-and-the-change-management-process). Crosslink the issue here if it does. - [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 on-call 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] Announce on [the feature issue](https://gitlab.com/groups/gitlab-org/-/epics/6870) an estimated time this will be enabled on GitLab.com. - [x] Notify `#support_gitlab-com` and your team channel ([more guidance when this is necessary in the dev docs](https://docs.gitlab.com/ee/development/feature_flags/controls.html#communicate-the-change)). ### 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`). - [x] [Incrementally roll out](https://docs.gitlab.com/ee/development/feature_flags/controls.html#process) the feature. - If the feature flag in code has [an actor](https://docs.gitlab.com/ee/development/feature_flags/#feature-actors), perform **actor-based** rollout. - [ ] `/chatops run feature set compliance_violations_report <rollout-percentage> --actors` - Enable the feature globally on production environment. - [x] `/chatops run feature set compliance_violations_report true` - [x] Announce on [the feature issue](https://gitlab.com/groups/gitlab-org/-/epics/6870) that the feature has been globally enabled. - [ ] 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: - [ ] Create a merge request with the following changes. Ask for review and merge it. - [ ] 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`. - [ ] Create [a changelog entry](https://docs.gitlab.com/ee/development/feature_flags/#changelog). - [ ] Ensure that the default-enabling 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-of-default-enabling-mr>` - [ ] Close [the feature issue](https://gitlab.com/groups/gitlab-org/-/epics/6870) to indicate the feature will be released in the current milestone. - [ ] Set the next milestone to this rollout issue for scheduling [the flag removal](#release-the-feature). - [ ] (Optional) You can create a separate issue for scheduling the steps below to [Release the feature](#release-the-feature). - [ ] Set the title to "[Feature flag] Cleanup `compliance_violations_report`". - [ ] Execute the `/copy_metadata https://gitlab.com/gitlab-org/gitlab/-/issues/346266` quick action to copy the labels from this rollout issue. - [ ] Link this rollout issue as a related issue. - [ ] Close this rollout issue. **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 --> - [x] Create a merge request to remove `compliance_violations_report` feature flag. Ask for review and merge it. - [x] Remove all references to the feature flag from the codebase. - [x] Remove the YAML definitions for the feature from the repository. - [x] Create [a changelog entry](https://docs.gitlab.com/ee/development/feature_flags/#changelog). - [x] Ensure that the cleanup 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-of-cleanup-mr>` - [ ] Close [the feature issue](https://gitlab.com/groups/gitlab-org/-/epics/6870) to indicate the feature will be released in the current milestone. - [x] Clean up the feature flag from all environments by running these chatops command in `#production` channel: - [x] `/chatops run feature delete compliance_violations_report --dev` - [x] `/chatops run feature delete compliance_violations_report --staging` - [x] `/chatops run feature delete compliance_violations_report` - [x] Close this rollout issue. ## Rollback Steps - [ ] This feature can be disabled by running the following Chatops command: ``` /chatops run feature set compliance_violations_report false ```