[Feature flag] Enable `all_commits_compliance_report` feature flag

Summary

This issue is to rollout Chain of Custody Report: Expand the scope from Merge Commits to All Commits on production, that is currently behind the all_commits_compliance_report feature flag.

Owners

  • Team: gitlab-org/govern/compliance
  • Most appropriate slack channel to reach out to: #g_govern_compliance
  • Best individual to reach out to: @wandering_person
  • PM: @nrosandich

Expectations

  • no new errors generated when users export the report
  • users find the report more useful

What are we expecting to happen?

  • continuing feedback on how to tweak the contents of the report to be most useful to customers

What might happen if this goes wrong?

  • turn the feature flag off if urgent, otherwise address feedback in follow-up MRs

What can we monitor to detect problems with this?

https://dashboards.gitlab.net/d/stage-groups-detail-compliance/stage-groups-compliance-group-error-budget-detail?orgId=1&from=now-7d&to=now

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

Note: Please make sure to run the chatops commands in the slack channel that gets impacted by the command.

Rollout on non-production environments

  • Verify the MR with the feature flag is merged to master.
  • Verify that the feature MRs have been deployed to non-production environments with:
    • /chatops run auto_deploy status <merge-commit-of-your-feature>
  • Enable the feature globally on non-production environments.
    • /chatops run feature set <feature-flag-name> true --dev --staging --staging-ref
  • Verify that the feature works as expected. Posting the QA result in this issue is preferable. The best environment to validate the feature in is staging-canary as this is the first environment deployed to. Note you will need to make sure you are configured to use canary as outlined here when accessing the staging environment in order to make sure you are testing appropriately.

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 (#g_TEAM_NAME).

  • Ensure that the feature MRs have been deployed to both production and canary.
    • /chatops run auto_deploy status <merge-commit-of-your-feature>
  • Depending on the type of actor you are using, pick one of these options:
    • If you're using project-actor, you must enable the feature on these entries:
      • /chatops run feature set --project=gitlab-org/gitlab,gitlab-org/gitlab-foss,gitlab-com/www-gitlab-com <feature-flag-name> true
    • If you're using group-actor, you must enable the feature on these entries:
      • /chatops run feature set --group=gitlab-org,gitlab-com <feature-flag-name> true
    • If you're using user-actor, you must enable the feature on these entries:
      • /chatops run feature set --user=<your-username> <feature-flag-name> true
  • Verify that the feature works on the specific entries. Posting the QA result in this issue is preferable.

Preparation before global rollout

  • Set a milestone to the rollout issue to signal for enabling and removing the feature flag when it is stable.
  • 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).
  • Leave a comment on the feature issue announcing estimated time when this feature flag will be enabled on GitLab.com.
  • Ensure that any breaking changes have been announced following the release post process to ensure GitLab customers are aware.
  • 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 and cross-posted (with the command results) to the responsible team's slack channel (#g_TEAM_NAME).

  • Incrementally roll out the feature.
    • Between every step wait for at least 15 minutes and monitor the appropriate graphs on https://dashboards.gitlab.net.
    • If the feature flag in code has an actor, perform actor-based rollout.
      • /chatops run feature set <feature-flag-name> <rollout-percentage> --actors
    • If the feature flag in code does NOT have an actor, perform time-based rollout (random rollout).
      • /chatops run feature set <feature-flag-name> <rollout-percentage> --random
    • 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.

Rollback Steps

  • This feature can be disabled by running the following Chatops command:
/chatops run feature set <feature-flag-name> false
Edited by Michael Becker