Skip to content

[Feature flag] Enable downstream retry from the pipeline graph

Summary

This issue is to rollout adding a retry button on the downstream card in the pipeline graph on production, that is currently behind the downstream_retry_action feature flag.

Owners

Stakeholders

EM: @samdbeckham Support: @calebcooper QA: @treagitlab

Expectations

What are we expecting to happen?

A new retry button will appear on failed/canceled/passed with warnings downstream pipelines inside the graph. It will allow user to retry their pipeline right from the upstream instead of having to change project. We are fetching additional graphql data: retryable and cancelable + userPermissions { updatePipeline } to determine whether or not to show the action.

When is the feature viable?

As soon as the flag is turned on, anyone can see it.

What might happen if this goes wrong?

The pipeline graph could not render due to an error fetching the data. Or the actions of retrying the card might fail for an unexpected reasons.

What can we monitor to detect problems with this?

If the action fails (retrying or cancelling), we log it in sentry with the name of the component graph_component_wrapper and the type action_failure

What can we check for monitoring production after rollouts?

https://sentry.gitlab.net/gitlab/gitlabcom-clientside/?query=is%3Aunresolved+component%3APipelineGraphWrapper

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 downstream_retry_action true --dev
    • /chatops run feature set downstream_retry_action 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 downstream_retry_action true
    • /chatops run feature set --project=gitlab-org/gitlab-foss downstream_retry_action true
    • /chatops run feature set --project=gitlab-com/www-gitlab-com downstream_retry_action 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.
  • 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.
    • If the feature flag in code does NOT have an actor, perform time-based rollout (random rollout).
      • /chatops run feature set downstream_retry_action <rollout-percentage> --random
    • Enable the feature globally on production environment.
      • /chatops run feature set downstream_retry_action true
  • Announce on the feature issue that the feature has been globally enabled.
  • Wait for at least one day for the verification term.

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.

You can either create a follow-up issue for Feature Flag Cleanup or use the checklist below in this same issue.

  • Create a merge request to remove downstream_retry_action 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 downstream_retry_action --dev
    • /chatops run feature delete downstream_retry_action --staging
    • /chatops run feature delete downstream_retry_action
  • Close this rollout issue.

Rollback Steps

  • This feature can be disabled by running the following Chatops command:
/chatops run feature set downstream_retry_action false
Edited by Frédéric Caplette