Skip to content

[Feature flag] Rollout of `api_v3_commits_skip_diff_files`

Summary

This issue is to rollout protecting API v3 commits/:sha endpoint from causing frequent Gitaly timeouts #331326 (closed) on production, that is currently behind the api_v3_commits_skip_diff_files feature flag.

Owners

  • Team: ~"group::integrations"
  • Most appropriate slack channel to reach out to: #g_ecosystem_integrations
  • Best individual to reach out to: @.luke
  • PM: @mushakov

Stakeholders

Expectations

What are we expecting to happen?

Fewer Gitaly timeout errors and lower latency for commits/:sha.

What might happen if this goes wrong?

Customers might experience problems with their Jira integration.

What can we monitor to see if the change works?

What can we monitor to detect problems with this?

Kibana should display that overall requests continue to be fulfilled

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 api_v3_commits_skip_diff_files true --dev
    • /chatops run feature set api_v3_commits_skip_diff_files 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 api_v3_commits_skip_diff_files true
    • /chatops run feature set --project=gitlab-org/gitlab-foss api_v3_commits_skip_diff_files true
    • /chatops run feature set --project=gitlab-com/www-gitlab-com api_v3_commits_skip_diff_files true
  • If you're using group-actor, you must enable the feature on these entries:
    • /chatops run feature set --group=gitlab-org api_v3_commits_skip_diff_files true
    • /chatops run feature set --group=gitlab-com api_v3_commits_skip_diff_files true
  • If you're using user-actor, you must enable the feature on these entries:
    • /chatops run feature set --user=<your-username> api_v3_commits_skip_diff_files 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

All /chatops commands that target production should be done in the #production slack channel for visibility.

  • Incrementally roll out the feature.
    • If the feature flag in code has an actor, perform actor-based rollout.
      • /chatops run feature set api_v3_commits_skip_diff_files <rollout-percentage> --actors
    • If the feature flag in code does NOT have an actor, perform time-based rollout (random rollout).
      • /chatops run feature set api_v3_commits_skip_diff_files <rollout-percentage>
    • Enable the feature globally on production environment.
      • /chatops run feature set api_v3_commits_skip_diff_files true
  • Announce on the feature issue that the feature has been globally enabled.
  • Wait for at least one day for the verification term.

(Optional) Release the feature with the feature flag

If you're still unsure whether the feature is deemed stable 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.
  • Ensure that the default-enabling 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-default-enabling-mr>
  • Close the feature issue to indicate the feature will be released in the current milestone.
  • Set the next milestone to this rollout issue for scheduling the flag removal.
  • (Optional) You can create a separate issue for scheduling the steps below to Release the feature.
    • Set the title to "[Feature flag] Cleanup api_v3_commits_skip_diff_files".
    • Execute the /copy_metadata <this-rollout-issue-link> 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 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, 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 api_v3_commits_skip_diff_files 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 api_v3_commits_skip_diff_files --dev
    • /chatops run feature delete api_v3_commits_skip_diff_files --staging
    • /chatops run feature delete api_v3_commits_skip_diff_files
  • Close this rollout issue.

Rollback Steps

  • This feature can be disabled by running the following Chatops command:
/chatops run feature set api_v3_commits_skip_diff_files false
Edited by Luke Duncalfe