Skip to content

[Feature flag] Enable `ci_process_catalog_resource_sync_events`

Summary

This issue is to roll out the feature on production, that is currently behind the ci_process_catalog_resource_sync_events feature flag.

This feature implements background syncing of catalog_resources and projects (#429376 (closed)). The process involves a PG trigger which adds sync events to a queue table; then the sync events are processed by a worker.

The worker Ci::Catalog::Resources::ProcessSyncEventsWorker is enqueued in 3 ways:

  1. By Project model callback after updating name, description, or visibility_level (if the project is marked as a catalog resource.)
  2. Every minute by cron job. This ensures we process SyncEvents from direct/bulk database updates that do not use the Project AR model.
  3. By Ci::ProcessSyncEventsService if there are any remaining pending SyncEvents after processing.

This FF enables/disables the worker's "perform" action. (Turning off the FF also prevents enqueuing the worker in (1) and (3) above).

It does not have an FF actor, so it should should be rolled out at 100%.

Owners

  • Most appropriate Slack channel to reach out to: #g_pipeline-authoring
  • Best individual to reach out to: @lma-git

Expectations

What are we expecting to happen?

No user visible change. New Ci::Catalog::Resources::ProcessSyncEventsWorker will be enqueued by one of 3 ways described in summary.

What can go wrong and how would we detect it?

Sidekiq logs for Ci::Catalog::Resources::ProcessSyncEventsWorker, including extra metadata from Ci::ProcessSyncEventsService: https://log.gprd.gitlab.net/app/r/s/l3zh3

Sidekiq queue detail (urgent_other): https://dashboards.gitlab.net/d/sidekiq-queue-detail/sidekiq3a-queue-detail?orgId=1&var-PROMETHEUS_DS=PA258B30F88C30650&var-environment=gprd&var-stage=main&var-queue=urgent_other

Sidekiq worker detail: https://dashboards.gitlab.net/d/sidekiq-worker-detail/sidekiq3a-worker-detail?orgId=1&var-PROMETHEUS_DS=PA258B30F88C30650&var-environment=gprd&var-stage=main&var-worker=Ci::Catalog::Resources::ProcessSyncEventsWorker

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 and 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 with /chatops run feature set <feature-flag-name> true --dev --staging --staging-ref
  • Verify that the feature works as expected. The best environment to validate the feature in is staging-canary as this is the first environment deployed to. Make sure you are configured to use canary.
  • If the feature flag causes end-to-end tests to fail, disable the feature flag on staging to avoid blocking deployments.

For assistance with end-to-end test failures, please reach out via the #quality Slack channel. Note that end-to-end test failures on staging-ref don't block deployments.

Preparation before global rollout

  • Set a milestone to this 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 exists for the feature, and the version history text has been updated.
  • 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 the #support_gitlab-com Slack channel and your team channel (more guidance when this is necessary in the dev docs).
  • Ensure that the feature flag rollout plan is reviewed by another developer familiar with the domain.

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).

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 the <feature-flag-name> feature flag. Ask for review/approval/merge as usual. The MR should include the following changes:
    • 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.
  • Clean up the feature flag from all environments by running these chatops command in #production channel: /chatops run feature delete <feature-flag-name> --dev --ops --pre --staging --staging-ref --production
  • Close this rollout issue.

Rollback Steps

  • This feature can be disabled by running the following Chatops command:
/chatops run feature set ci_process_catalog_resource_sync_events false
Edited by Leaminn Ma