Clarify Geo proxying docs
What does this MR do?
Clarify Geo proxying docs.
-
Help these users: It sounds like disabling Geo proxying should disable SSH proxying. But it doesn't! -
Direct users to upvote or comment with their use-cases for read-only sites. -
Answer this question: Is there is an alternative way to disable SSH proxying?
-
Make it clear early in the Geo docs that: Secondary Geo sites transparently behave like the primary, by default. Therefore Geo sites can be load balanced, with the caveat that you must use sticky sessions to avoid authentication failures and cross-site request errors.
-
Search the docs for read-only
and adjust for the fact that secondary proxying is enabled by default -
Remove https://docs.gitlab.com/ee/user/admin_area/geo_sites.html#multiple-secondary-sites-behind-a-load-balancer since it is now superseded by https://docs.gitlab.com/ee/administration/geo/secondary_proxy/location_aware_external_url.html
-
Incorporate this MR and its discussions: !148269 (closed) -
Fix this: We link to a separate page for URL configuration that I think can simply be merged into this page -
Search for links to location_aware_external_url
in other projects and change them toindex
https://docs.gitlab.com/ee/development/documentation/redirects.html => gitlab-docs!4966 (merged) and gitlab-com/www-gitlab-com!135777 (merged) -
Fix this: The nomenclature is inconsistent - For instance, the Set up a unified URL for Geo sites and Geo proxying with Separate URLs should use more similar phrasing
-
Incorporate this info: Javiera and I today tested "round-robin" Google Cloud DNS with a Geo environment and it worked fine. I think this is normally to be expected, since DNS is inherently sticky due to caching by the client as well as DNS caching in many possible places in-between. - If using a load-balancer, then routing must be sticky. Not round-robin.
-
Reflow some the text to highlight proxying is the default and disabling it is an exception. -
Move limitations to a location that it easier more visible on the page.
Related issues
Resolves #436973 (closed)
Resolves #388996 (closed)
Resolves #437562 (closed)
Partially resolves #408102
Author's checklist
-
Optional. Consider taking the GitLab Technical Writing Fundamentals course. -
Follow the: -
If you're adding a new page, add the product availability details under the H1 topic title. -
If you are a GitLab team member, request a review based on: - The documentation page's metadata.
- The associated Technical Writer.
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 likeDefault behavior when you close an issue
. -
The headings (other than the page title) should be active. Instead of Configuring GDK
, say something likeConfigure 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.