Skip to content

Container Registry: document general scaling recommendations

Hayley Swimelar requested to merge docs-registry-scaling into master

What does this MR do?

This update to the container registry documentation introduces a new section on scaling by component. It provides guidance on identifying potential performance bottlenecks and offers recommendations for scaling various components of the registry, including the database, registry server, Redis cache, and storage. Additionally, it includes information on adjusting online garbage collection settings and scaling horizontally with the registry server.

This MR adds a new section outlining how to scale the container registry. In this initial effort, we hope to provide a rough guide for self-managed admins on what techniques are available, without being prescriptive about when and how to apply these techniques. We may become more prescriptive in the future, but since registry usage can vary somewhat independently from GitLab usage, this would need to be informed by user feedback, with the changes here serving as a template.

Related issues

Original discussion: #480742 (comment 2076151030)

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.

Merge request reports

Loading