Omnibus contains a configuration option omnibus_gitconfig which was historically used to pass git configuration options. Nowadays Gitaly has gitaly[:configuration][:git][:config] where the git configuration should go. There's currently fallback code in Omnibus to place the configuration from omnibus_gitconfig to the correct key. Since the legacy key is no longer needed, let's deprecate it and remove it in 17.0 so we can get rid of the fallback code.
From a purely Quality perspective I don't think this will have any impact on our test infrastructure as I don't think we are using it anywhere. However to be sure, when this is rolled out, let's make sure we run a full suite of the E2E tests, and ensure we don't see any deprecation warnings relating to this change.
@samihiltunen@mjwood This came in too late to meet our requirements of announcing deprecations 3 milestones in advance of the major (cc @swiskow).
As this configuration can be changed in one known place by an admin, I would classify the impact as medium, even though it impacts availability (failing to reconfigure will mean gitaly doesn't work, right?).
Sami, can you make sure this lands in the version specific upgrade notes for the milestone it can be configured in as well as 17.0 when it is needed?
@mbruemmer - We actually informed users to migrate to the gitaly['configuration'] structure in %15.10, so we announced in plenty of time -- this change just deprecates the omnibus_gitconfig which was not removed in %16.0 like the rest of the config structure.
It should also be noted that this only impact self-managed customers.
Sami, can you make sure this lands in the version specific upgrade notes for the milestone it can be configured in as well as 17.0 when it is needed?
@mbruemmer as Mark mentioned above, this has been possible to configure since %15.10. Is there are particular version we should add these docs to? Is it necessary to duplicate the note under %17.0?
@samihiltunenLooking at 16, we provided a lot of guidance around migrating Praefect and Gitaly configuration structure, including the change mentioned here (but not mentioning the fallback that still was in place). From that point, the guidance has already been in place for the last major and would be superfluous here.
I'll go ahead and close this issue. We've added the deprecation note with instructions how to migrate and we've added the relevant deprecation item in Omnibus so it warns now and errors out when upgrading to 17.0 without migrating the config.