Skip to content

Update Omnibus global server hook guidance based on v15 changes

James Reed requested to merge docs-update-omnibus-server-hooks-guide into master

What does this MR do?

This MR aims to provide updated details on how to configure global server hooks, aligning with the changes & deprecation that landed in GitLab Omnibus v15:

As of GitLab Omnibus v15 it appears that:

  1. A default global server hook directory is no longer enabled, and must be explicitly set by uncommenting gitaly['custom_hooks_dir'] within the gitlab.rb configuration. The pre-filled directory path on this value is set to "/var/opt/gitlab/gitaly/custom_hooks"

  2. It's no longer possible to setup single server hooks globally, for example with a pre-receive hook located at /var/opt/gitlab/gitaly/custom_hooks/pre-receive. Instead it looks like it's required that global server hooks are setup under a subdirectory, for example with a pre-receive hook located at /var/opt/gitlab/gitaly/custom_hooks/pre-receive.d/*. In this case it looks like the current guidance on "To create many server hooks" has to be applied irrespective of if only a single server hook is being configured.

Related issues

This was discovered during troubleshooting and testing for a customer ticket:

Author's checklist

If you are a GitLab team member and only adding documentation, do not add any of the following labels:

  • ~"frontend"
  • ~"backend"
  • ~"type::bug"
  • ~"database"

These labels cause the MR to be added to code verification QA issues.

Reviewer's checklist

Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.

  • If the content requires it, ensure the information is reviewed by a subject matter expert.
  • Technical writer review items:
    • Ensure docs metadata is present and up-to-date.
    • Ensure the appropriate labels are added to this MR.
    • Ensure a release milestone is set.
    • If relevant to this MR, ensure content topic type principles are in use, including:
      • The headings should be something you'd do a Google search for. Instead of Default behavior, say something like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure GDK.
      • Any task steps should be written as a numbered list.
      • If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
  • Review by assigned maintainer, who can always request/require the reviews above. Maintainer's review can occur before or after a technical writer review.
Edited by James Reed

Merge request reports

Loading