Skip to content

Docs: Update 1k Ref Arch with Diagram and Overview of Service Scaling

DarwinJS requested to merge DarwinJS-add-diagram-to-1k into master

What does this MR do?

Anyone new to GitLab instance architecture can have challenges understanding GitLab's incredible flexibility and why scaling it becomes complex because in it's simplest form GitLab can run on a single node.

It can be easy to assume that scaling it is a simple process.

This information intends to show:

  • that within a single instance GitLab Instance there are multiple services - all communicating at hardware speeds (memory & disk & network)
  • scaling this requires that many of these services scale as independent service layers, become data storing clusters and may require ancillary services to support the horizontal scaling.

Related issues

Author's checklist

If you are 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.

Review 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.
    • 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.
  • Ensure a release milestone is set.

Merge request reports