Skip to content

Geo - Alter the steps for creating an external tracking database

Anton Smith requested to merge docs/geo-explicitly-create-tracking-db into master

What does this MR do?

  1. The current instructions imply that the user already has a database to use for their tracking database. Borrowing the instructions from steps 1-2 in https://docs.gitlab.com/ee/administration/postgresql/external.html, let's make this more explicit here so there is no confusion.
  2. I've added If you are **not** using a cloud managed PostgreSQL database to step 3 - this currently leads to confusion for the reader if this does not apply to them. Not sure if a note would be more appropriate here - let me know.
  3. Fixed spelling mistake in one of the links.
  4. When reconfiguring the secondary node after entering in the tracking database details, GitLab will automatically migrate the tracking database. This makes me wonder if the gitlab-rake geo:db:create and gitlab-rake geo:db:migrate commands are actually worth mentioning. I feel the gitlab-rake geo:db:migrate comes in handy if you ever need to run it manually (and no harm in running it again after the reconfigure), but unsure about the gitlab-rake geo:db:create command - this could generate an error if the database already exists or the database user is not a superuser. cc @fzimmer - could you give some direction here or help me find someone who can?

Related issues

Author's checklist (required)

Do not add the feature, frontend, backend, ~"bug", or database labels if you are only updating documentation. These labels will cause the MR to be added to code verification QA issues.

When applicable:

Review checklist

All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.

1. Primary Reviewer

  • Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.

2. Technical Writer

  • Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.

For more information about labels, see Technical Writing workflows - Labels.

For suggestions that you are confident don't need to be reviewed, change them locally and push a commit directly to save others from unneeded reviews. For example:

  • Clear typos, like this is a typpo.
  • Minor issues, like single quotes instead of double quotes, Oxford commas, and periods.

For more information, see our documentation on Merging a merge request.

3. Maintainer

  1. Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  2. Ensure a release milestone is set.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.
Edited by Anton Smith

Merge request reports