Commit ce7d47f8 authored by Achilleas Pipinellis's avatar Achilleas Pipinellis

Add the steps list in all docs

parent a8e6ebd9
# GitLab Geo # GitLab Geo
> **Notes:** > **Notes:**
- This feature was introduced in GitLab Enterprise Edition 8.5 as Alpha.
We recommend you use with at least GitLab Enterprise Edition 8.6.
- GitLab Geo is part of [GitLab Enterprise Edition Premium][ee]. - GitLab Geo is part of [GitLab Enterprise Edition Premium][ee].
- Introduced in GitLab Enterprise Edition 8.5 as Alpha.
We recommend you use it with at least GitLab Enterprise Edition 8.14.
GitLab Geo allows you to replicate your GitLab instance to other geographical GitLab Geo allows you to replicate your GitLab instance to other geographical
locations as a read-only fully operational version. locations as a read-only fully operational version.
...@@ -32,36 +32,34 @@ Keep in mind that: ...@@ -32,36 +32,34 @@ Keep in mind that:
## Setup instructions ## Setup instructions
In order to set up one or more GitLab Geo instances, follow the steps below in In order to set up one or more GitLab Geo instances, follow the steps below in
this **exact order**: the **exact order** they appear.
1. Follow the first 3 steps to [install GitLab Enterprise Edition][install-ee] ### Using Omnibus GitLab
on the server that will serve as the secondary Geo node. Do not login or
set up anything else in the secondary node for the moment. If you installed GitLab using the Omnibus packages (highly recommended):
1. [Setup the database replication](database.md) (`primary <-> secondary (read-only)` topology)
1. [Configure GitLab](configuration.md) to set the primary and secondary nodes.
## After setup 1. [Install GitLab Enterprise Edition][install-ee] on the server that will serve
as the **secondary** Geo node. Do not login or set up anything else in the
secondary node for the moment.
1. [Setup the database replication](database.md) (`primary (read-write) <-> secondary (read-only)` topology).
1. [Configure GitLab](configuration.md) to set the primary and secondary nodes.
1. [Follow the after setup steps](after_setup.md).
After you set up the database replication and configure the GitLab Geo nodes, [install-ee]: https://about.gitlab.com/downloads-ee/ "GitLab Enterprise Edition Omnibus packages downloads page"
there are a few things to consider:
1. When you create a new project in the primary node, the Git repository will ### Using GitLab installed from source
appear in the secondary only _after_ the first `git push`.
1. You need an extra step to be able to fetch code from the `secondary` and push
to `primary`:
1. Clone your repository as you would normally do from the `secondary` node If you installed GitLab from source:
1. Change the remote push URL following this example:
```bash 1. [Install GitLab Enterprise Edition][install-ee-source] on the server that
git remote set-url --push origin git@primary.gitlab.example.com:user/repo.git will serve as the **secondary** Geo node. Do not login or set up anything
``` else in the secondary node for the moment.
1. [Setup the database replication](database_source.md) (`primary (read-write) <-> secondary (read-only)` topology).
1. [Configure GitLab](configuration_source.md) to set the primary and secondary
nodes.
1. [Follow the after setup steps](after_setup.md).
>**Important**: [install-ee-source]: https://docs.gitlab.com/ee/install/installation.html "GitLab Enterprise Edition installation from source"
The initialization of a new Geo secondary node on versions older than 8.14
requires data to be copied from the primary, as there is no backfill
feature bundled with those versions.
See more details in the [Configure GitLab](configuration.md) step.
## Current limitations ## Current limitations
...@@ -75,3 +73,4 @@ Read more in the [Geo FAQ](faq.md). ...@@ -75,3 +73,4 @@ Read more in the [Geo FAQ](faq.md).
[ee]: https://about.gitlab.com/gitlab-ee/ "GitLab Enterprise Edition landing page" [ee]: https://about.gitlab.com/gitlab-ee/ "GitLab Enterprise Edition landing page"
[install-ee]: https://about.gitlab.com/downloads-ee/ "GitLab Enterprise Edition Omnibus packages downloads page" [install-ee]: https://about.gitlab.com/downloads-ee/ "GitLab Enterprise Edition Omnibus packages downloads page"
[install-ee-source]: https://docs.gitlab.com/ee/install/installation.html "GitLab Enterprise Edition installation from source"
# After setup
After you set up the [database replication and configure the GitLab Geo nodes][req],
there are a few things to consider:
1. When you create a new project in the primary node, the Git repository will
appear in the secondary only _after_ the first `git push`.
1. You need an extra step to be able to fetch code from the `secondary` and push
to `primary`:
1. Clone your repository as you would normally do from the `secondary` node
1. Change the remote push URL following this example:
```bash
git remote set-url --push origin git@primary.gitlab.example.com:user/repo.git
```
[req]: README.md#setup-instructions
# GitLab Geo configuration # GitLab Geo configuration
1. [Install GitLab Enterprise Edition][install-ee] on the server that will serve
as the secondary Geo node. Do not login or set up anything else in the
secondary node for the moment.
1. [Setup the database replication](database.md) (`primary (read-write) <-> secondary (read-only)` topology).
1. **Configure GitLab to set the primary and secondary nodes.**
1. [Follow the after setup steps](after_setup.md).
[install-ee]: https://about.gitlab.com/downloads-ee/ "GitLab Enterprise Edition Omnibus packages downloads page"
>**Note:** >**Note:**
This is the documentation for the Omnibus GitLab packages. For installations This is the documentation for the Omnibus GitLab packages. For installations
from source, follow the [**GitLab Geo nodes configuration for installations from source, follow the [**GitLab Geo nodes configuration for installations
...@@ -235,7 +244,7 @@ gitlab-rake gitlab:shell:setup ...@@ -235,7 +244,7 @@ gitlab-rake gitlab:shell:setup
This will enable `git` operations to authorize against your existing users. This will enable `git` operations to authorize against your existing users.
New users and SSH keys updated after this step, will be replicated automatically. New users and SSH keys updated after this step, will be replicated automatically.
### Next steps ## Next steps
Your nodes should now be ready to use. You can login to the secondary node Your nodes should now be ready to use. You can login to the secondary node
with the same credentials as used in the primary. Visit the secondary node's with the same credentials as used in the primary. Visit the secondary node's
...@@ -245,6 +254,8 @@ correctly identified as a secondary Geo node and if Geo is enabled. ...@@ -245,6 +254,8 @@ correctly identified as a secondary Geo node and if Geo is enabled.
If your installation isn't working properly, check the If your installation isn't working properly, check the
[troubleshooting](#troubleshooting) section. [troubleshooting](#troubleshooting) section.
Point your users to the [after setup steps](after_setup.md).
## Adding another secondary Geo node ## Adding another secondary Geo node
To add another Geo node in an already Geo configured infrastructure, just follow To add another Geo node in an already Geo configured infrastructure, just follow
......
# GitLab Geo configuration # GitLab Geo configuration
1. [Install GitLab Enterprise Edition][install-ee-source] on the server that
will serve as the secondary Geo node. Do not login or set up anything else
in the secondary node for the moment.
1. [Setup the database replication](database_source.md) (`primary (read-write) <-> secondary (read-only)` topology).
1. **Configure GitLab to set the primary and secondary nodes.**
1. [Follow the after setup steps](after_setup.md).
[install-ee-source]: https://docs.gitlab.com/ee/install/installation.html "GitLab Enterprise Edition installation from source"
>**Note:** >**Note:**
This is the documentation for installations from source. For installations This is the documentation for installations from source. For installations
using the Omnibus GitLab packages, follow the using the Omnibus GitLab packages, follow the
...@@ -235,7 +244,7 @@ sudo -u git -H bundle exec rake gitlab:shell:setup RAILS_ENV=production ...@@ -235,7 +244,7 @@ sudo -u git -H bundle exec rake gitlab:shell:setup RAILS_ENV=production
This will enable `git` operations to authorize against your existing users. This will enable `git` operations to authorize against your existing users.
New users and SSH keys updated after this step, will be replicated automatically. New users and SSH keys updated after this step, will be replicated automatically.
### Next steps ## Next steps
Your nodes should now be ready to use. You can login to the secondary node Your nodes should now be ready to use. You can login to the secondary node
with the same credentials as used in the primary. Visit the secondary node's with the same credentials as used in the primary. Visit the secondary node's
...@@ -245,6 +254,8 @@ correctly identified as a secondary Geo node and if Geo is enabled. ...@@ -245,6 +254,8 @@ correctly identified as a secondary Geo node and if Geo is enabled.
If your installation isn't working properly, check the If your installation isn't working properly, check the
[troubleshooting](configuration.md#troubleshooting) section. [troubleshooting](configuration.md#troubleshooting) section.
Point your users to the [after setup steps](after_setup.md).
## Adding another secondary Geo node ## Adding another secondary Geo node
To add another Geo node in an already Geo configured infrastructure, just follow To add another Geo node in an already Geo configured infrastructure, just follow
......
# GitLab Geo database replication # GitLab Geo database replication
1. [Install GitLab Enterprise Edition][install-ee] on the server that will serve
as the secondary Geo node. Do not login or set up anything else in the
secondary node for the moment.
1. **Setup the database replication (`primary (read-write) <-> secondary (read-only)` topology).**
1. [Configure GitLab](configuration.md) to set the primary and secondary nodes.
1. [Follow the after setup steps](after_setup.md).
[install-ee]: https://about.gitlab.com/downloads-ee/ "GitLab Enterprise Edition Omnibus packages downloads page"
>**Note:** >**Note:**
This is the documentation for the Omnibus GitLab packages. For installations This is the documentation for the Omnibus GitLab packages. For installations
from source, follow the from source, follow the
......
# GitLab Geo database replication # GitLab Geo database replication
1. [Install GitLab Enterprise Edition][install-ee-source] on the server that
will serve as the secondary Geo node. Do not login or set up anything else
in the secondary node for the moment.
1. **Setup the database replication (`primary (read-write) <-> secondary (read-only)` topology).**
1. [Configure GitLab](configuration_source.md) to set the primary and secondary
nodes.
1. [Follow the after setup steps](after_setup.md).
[install-ee-source]: https://docs.gitlab.com/ee/install/installation.html "GitLab Enterprise Edition installation from source"
>**Note:** >**Note:**
This is the documentation for installations from source. For installations This is the documentation for installations from source. For installations
using the Omnibus GitLab packages, follow the using the Omnibus GitLab packages, follow the
......
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