Commit e1f1deda authored by Michael Kozono's avatar Michael Kozono Committed by Evan Read

Docs: Help sysadmins ensure correct Geo node URL

parent 1b4595fd
...@@ -187,14 +187,18 @@ keys must be manually replicated to the **secondary** node. ...@@ -187,14 +187,18 @@ keys must be manually replicated to the **secondary** node.
1. Visit the **primary** node's **Admin Area > Geo** 1. Visit the **primary** node's **Admin Area > Geo**
(`/admin/geo/nodes`) in your browser. (`/admin/geo/nodes`) in your browser.
1. Click the **New node** button. 1. Click the **New node** button.
1. Add the **secondary** node. Use the **exact** name you inputed for `gitlab_rails['geo_node_name']` as the Name and the full URL as the URL. **Do NOT** check the
**This is a primary node** checkbox.
![Add secondary node](img/adding_a_secondary_node.png) ![Add secondary node](img/adding_a_secondary_node.png)
1. Fill in **Name** with the `gitlab_rails['geo_node_name']` in
`/etc/gitlab/gitlab.rb`. These values must always match *exactly*, character
for character.
1. Fill in **URL** with the `external_url` in `/etc/gitlab/gitlab.rb`. These
values must always match, but it doesn't matter if one ends with a `/` and
the other doesn't.
1. **Do NOT** check the **This is a primary node** checkbox.
1. Optionally, choose which groups or storage shards should be replicated by the 1. Optionally, choose which groups or storage shards should be replicated by the
**secondary** node. Leave blank to replicate all. Read more in **secondary** node. Leave blank to replicate all. Read more in
[selective synchronization](#selective-synchronization). [selective synchronization](#selective-synchronization).
1. Click the **Add node** button. 1. Click the **Add node** button to add the **secondary** node.
1. SSH into your GitLab **secondary** server and restart the services: 1. SSH into your GitLab **secondary** server and restart the services:
```sh ```sh
......
...@@ -115,11 +115,19 @@ Any **secondary** nodes should point only to read-only instances. ...@@ -115,11 +115,19 @@ Any **secondary** nodes should point only to read-only instances.
#### Can Geo detect the current node correctly? #### Can Geo detect the current node correctly?
Geo uses the defined node from the **Admin Area > Geo** screen, and tries to match Geo finds the current machine's name in `/etc/gitlab/gitlab.rb` by first looking
it with the value defined in the `/etc/gitlab/gitlab.rb` configuration file. for `gitlab_rails['geo_node_name']`. If it is not defined, then it defaults to
The relevant line looks like: `external_url "http://gitlab.example.com"`. the external URL defined in e.g. `external_url "http://gitlab.example.com"`. To
get a machine's name, run:
To check if the node on the current machine is correctly detected type: ```sh
sudo gitlab-rails runner "puts GeoNode.current_node_name"
```
This name is used to look up the node with the same **Name** in
**Admin Area > Geo**.
To check if current machine is correctly finding its node:
```sh ```sh
sudo gitlab-rails runner "puts Gitlab::Geo.current_node.inspect" sudo gitlab-rails runner "puts Gitlab::Geo.current_node.inspect"
...@@ -511,6 +519,20 @@ to [cleanup orphan artifact files](../../../raketasks/cleanup.md#remove-orphan-a ...@@ -511,6 +519,20 @@ to [cleanup orphan artifact files](../../../raketasks/cleanup.md#remove-orphan-a
On a Geo **secondary** node, this command will also clean up all Geo On a Geo **secondary** node, this command will also clean up all Geo
registry record related to the orphan files on disk. registry record related to the orphan files on disk.
## Fixing sign in errors
### Message: The redirect URI included is not valid
If you are able to log in to the **primary** node, but you receive this error
when attempting to log into a **secondary**, you should check that the Geo
node's URL matches its external URL.
1. On the primary, visit **Admin Area > Geo**.
1. Find the affected **secondary** and click **Edit**.
1. Ensure the **URL** field matches the value found in `/etc/gitlab/gitlab.rb`
in `external_url "https://gitlab.example.com"` on the frontend server(s) of
the **secondary** node.
## Fixing common errors ## Fixing common errors
This section documents common errors reported in the Admin UI and how to fix them. This section documents common errors reported in the Admin UI and how to fix them.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment