Skip to content

Add database connection planning

What does this MR do?

This merge request adds comprehensive documentation for planning database connections in GitLab installations. The changes create a new PostgreSQL tuning guide that explains how to calculate the number of database connections needed based on your GitLab configuration (like number of Puma workers, Sidekiq processes, etc.).

The documentation includes formulas and examples for both single-node and multi-node setups, with special consideration for GitLab 16.0+ which uses dual database connections and effectively doubles connection usage. It also adds cross-references from the Puma and Sidekiq configuration pages to this new tuning guide, and updates the installation requirements to specify a minimum of 400 database connections with guidance to calculate the actual needs.

The goal is to help administrators properly size their PostgreSQL max_connections setting to prevent connection exhaustion and performance issues.

Related issues

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 you aren't sure which tech writer to ask, use roulette or ask in the #docs Slack channel.

  • 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 Anton Smith

Merge request reports

Loading