Skip to content

[Feature flag] Enable inline build hook execution

Summary

This issue is to rollout inline execution of build hooks on production, that is currently behind the execute_build_hooks_inline feature flag.

This enables the computation of web-hook payloads when the events are triggered, and not when they are consumed from the by the job-hooks worker.

Owners

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

Stakeholders

Expectations

What are we expecting to happen?

We expect the number of occasions where stale data is seen in pipeline build hooks to decrease.

What might happen if this goes wrong?

Resource consumption in pipeline workers (especially the pipeline finished worker) could become unacceptable.

What can we monitor to detect problems with this?

What can we check for monitoring production after rollouts?

Production errors are not anticipated, but any errors would include reference to the Ci::Build.execute_hooks method.

Rollout Steps

Rollout on non-production environments

  • Ensure that the feature MRs have been deployed to non-production environments.
    • /chatops run auto_deploy status f6c5c15d
  • Enable the feature globally on non-production environments.
    • /chatops run feature set execute_build_hooks_inline 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

  • Ensure that the feature MRs have been deployed to both production and canary.
    • /chatops run auto_deploy status f6c5c15d
  • 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 execute_build_hooks_inline 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 has an actor, perform actor-based rollout.
      • /chatops run feature set execute_build_hooks_inline <rollout-percentage> --actors
    • If the feature flag in code does NOT have an actor, perform time-based rollout (random rollout).
      • /chatops run feature set execute_build_hooks_inline <rollout-percentage> --random
    • Enable the feature globally on production environment.
      • /chatops run feature set execute_build_hooks_inline 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 execute_build_hooks_inline 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 included in the release package. If the merge request was deployed before the monthly release was tagged, the feature can be officially announced in a release blog post.
    • /chatops run release check <merge-request-url> <milestone>
  • Close the feature issue to indicate the feature will be released in the current milestone.
  • If not already done, clean up the feature flag from all environments by running these chatops command in #production channel:
    • /chatops run feature delete execute_build_hooks_inline --dev --staging --staging-ref --production
  • Create a follow-up issue to remove the worker #370387 (comment 1057860468).
  • Close this rollout issue.

Rollback Steps

  • This feature can be disabled by running the following Chatops command:
/chatops run feature set execute_build_hooks_inline false
Edited by Alex Kalderimis