[Feature flag] Roll out reimplementation of GetTreeEntries via git-ls-tree
What
Enable the :gitaly_tree_entries_via_ls_tree
feature flag. With this feature flag enabled, calls to GetTreeEntries with the recursive flag set to true
will use a new implementation via git-ls-tree(1). This implementation is more efficient compared to the old one via git-cat-file(1).
Owners
- Team: Gitaly
- Most appropriate slack channel to reach out to:
#g_create_gitaly
- Best individual to reach out to: pks-t
Expectations
What release does this feature occur in first?
What are we expecting to happen?
The new git-ls-tree(1) implementation should be more efficient. No change in behaviour should be visible.
What might happen if this goes wrong?
Recursive tree listings may start to misbehave.
What can we monitor to detect problems with this?
Roll Out Steps
-
Read the documentation of feature flags -
Add featureflagstaging to this issue (howto) -
Is the required code deployed? (howto) -
Do we need to create a change management issue? (howto) -
Enable on staging (howto) -
Test on staging (howto) -
Verify the feature flag was used by checking Prometheus metric gitaly_feature_flag_checks_total
-
Announce on this issue an estimated time this will be enabled on GitLab.com -
Add featureflagproduction to this issue -
Enable on GitLab.com by running chatops command in #production
(howto) -
Cross post chatops slack command to #support_gitlab-com
and in your team channel -
Verify the feature flag is being used by checking Prometheus metric gitaly_feature_flag_checks_total
-
Announce on the issue that the flag has been enabled -
Did you set the feature to both 100%
andtrue
(howto) -
Submit a MR to have the feature OnByDefault: true
and add changelog entry (howto) -
Have that MR merged -
Possibly wait for at least one deployment cycle (howto) -
Submit an MR to remove the pre-feature code from the codebase and add changelog entry (howto) -
Have that MR merged -
Remove the feature flag via chatops (howto) -
Close this issue
Edited by Patrick Steinhardt