Skip to content

Provide separate steps for external Geo tracking databases

Ben Prescott_ requested to merge docs-bprescott/20230717-geodbsetup into master

What does this MR do?

Geo needs two databases on the secondary, and supports either Omnibus PostgreSQL or 3rd party databases.

Geo works with GitLab deployed with helm, CNG.

But, we've only documented how to do helm deployed Geo with Omnibus PostgreSQL.

To provide guidance on CNG with 3rd party databases - which I'm doing in gitlab-org/charts/gitlab!3065 - generic external DB steps need to be teased apart from the from the Omnibus specific Rails steps.

Requested in https://gitlab.zendesk.com/agent/tickets/382516 and actually, I think this would be a pretty common request. If customers are running CNG in cloud, they can get Kubernetes, Redis, and PostgreSQL from their cloud provider. Using Geo to provide DR in another region means they need these steps.

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.

Merge request reports