[Feature flag] Enable use of transactional updates for symbolic references
What
Enable the :gitaly_transactional_symbolic_ref_updates
feature flag. This feature flag enables transactional locking and voting when writing symbolic references in a Git repository. This is required such that we can ensure consistency across replicas and thus don't have to create replication jobs.
Owners
- Team: Gitaly
- Most appropriate slack channel to reach out to:
#g_create_gitaly
- Best individual to reach out to: jcaigitlab
Expectations
What release does this feature occur in first?
What are we expecting to happen?
Updates to symbolic references should start to use transactional voting. We shouldn't see any more replication jobs being created for the WriteRef RPC call.
What might happen if this goes wrong?
Updating of symbolic references starts to fail.
What can we monitor to detect problems with this?
Roll Out Steps
-
Enable on staging -
Is the required code deployed on staging? (howto) -
Enable on staging (howto) -
Add featureflagstaging to this issue (howto) -
Test on staging (howto) -
Verify the feature flag was used by checking Prometheus metric gitaly_feature_flag_checks_total
-
-
Enable on production -
Is the required code deployed on production? (howto) -
Enable on production in #production
(howto) -
Add featureflagproduction to this issue -
Verify the feature flag was used by checking Prometheus metric gitaly_feature_flag_checks_total
-
-
Default-enable the feature flag (optional, only required if backwards-compatibility concerns exist) -
Wait for release containg default-disabled feature flag. -
Change the feature flag to default-enabled (howto) -
Wait for release containing default-enabled feature flag.
-
-
Remove feature flag
Please refer to the documentation of feature flags for further information.
Edited by John Cai