2019-07-08 08:50:38 +00:00
# Docker Registry for a secondary node **(PREMIUM ONLY)**
2019-05-05 16:08:21 +00:00
2019-09-11 02:52:00 +00:00
You can set up a [Docker Registry ](https://docs.docker.com/registry/ ) on your
2019-05-05 16:08:21 +00:00
**secondary** Geo node that mirrors the one on the **primary** Geo node.
## Storage support
Docker Registry currently supports a few types of storages. If you choose a
distributed storage (`azure`, `gcs` , `s3` , `swift` , or `oss` ) for your Docker
Registry on the **primary** node, you can use the same storage for a **secondary**
Docker Registry as well. For more information, read the
2019-09-11 02:52:00 +00:00
[Load balancing considerations ](https://docs.docker.com/registry/deploying/#load-balancing-considerations )
2019-05-05 16:08:21 +00:00
when deploying the Registry, and how to set up the storage driver for GitLab's
2019-09-17 12:06:48 +00:00
integrated [Container Registry ](../../packages/container_registry.md#container-registry-storage-driver ).
2019-09-11 02:52:00 +00:00
## Replicating Docker Registry
You can enable a storage-agnostic replication so it
can be used for cloud or local storages. Whenever a new image is pushed to the
2020-02-25 09:09:10 +00:00
**primary** node, each **secondary** node will pull it to its own container
2019-09-11 02:52:00 +00:00
repository.
To configure Docker Registry replication:
1. Configure the [**primary** node ](#configure-primary-node ).
1. Configure the [**secondary** node ](#configure-secondary-node ).
1. Verify Docker Registry [replication ](#verify-replication ).
### Configure **primary** node
Make sure that you have Container Registry set up and working on
the **primary** node before following the next steps.
We need to make Docker Registry send notification events to the
**primary** node.
1. SSH into your GitLab **primary** server and login as root:
2020-01-30 15:09:15 +00:00
```shell
2019-09-11 02:52:00 +00:00
sudo -i
```
1. Edit `/etc/gitlab/gitlab.rb` :
```ruby
registry['notifications'] = [
{
'name' => 'geo_event',
'url' => 'https://example.com/api/v4/container_registry_event/events',
'timeout' => '500ms',
'threshold' => 5,
'backoff' => '1s',
'headers' => {
2020-03-23 06:09:28 +00:00
'Authorization' => ['< replace_with_a_secret_token > ']
2019-09-11 02:52:00 +00:00
}
}
]
```
2020-03-23 06:09:28 +00:00
NOTE: **Note:**
Replace `<replace_with_a_secret_token>` with a case sensitive alphanumeric string
that starts with a letter. You can generate one with `< /dev/urandom tr -dc _A-Z-a-z-0-9 | head -c 32 | sed "s/^[0-9]*//"; echo`
2019-09-11 02:52:00 +00:00
NOTE: **Note:**
If you use an external Registry (not the one integrated with GitLab), you must add
2019-12-10 07:53:40 +00:00
these settings to its configuration yourself. In this case, you will also have to specify
2019-09-11 02:52:00 +00:00
notification secret in `registry.notification_secret` section of
`/etc/gitlab/gitlab.rb` file.
2019-09-17 14:16:34 +00:00
NOTE: **Note:**
If you use GitLab HA, you will also have to specify
the notification secret in `registry.notification_secret` section of
`/etc/gitlab/gitlab.rb` file for every web node.
2019-09-11 02:52:00 +00:00
1. Reconfigure the **primary** node for the change to take effect:
2020-01-30 15:09:15 +00:00
```shell
2019-09-11 02:52:00 +00:00
gitlab-ctl reconfigure
```
### Configure **secondary** node
Make sure you have Container Registry set up and working on
the **secondary** node before following the next steps.
The following steps should be done on each **secondary** node you're
expecting to see the Docker images replicated.
Because we need to allow the **secondary** node to communicate securely with
the **primary** node Container Registry, we need to have a single key
pair for all the nodes. The **secondary** node will use this key to
generate a short-lived JWT that is pull-only-capable to access the
**primary** node Container Registry.
1. SSH into the **secondary** node and login as the `root` user:
2020-01-30 15:09:15 +00:00
```shell
2019-09-11 02:52:00 +00:00
sudo -i
```
1. Copy `/var/opt/gitlab/gitlab-rails/etc/gitlab-registry.key` from the **primary** to the **secondary** node.
1. Edit `/etc/gitlab/gitlab.rb` :
```ruby
2019-09-17 14:16:34 +00:00
gitlab_rails['geo_registry_replication_enabled'] = true
2019-12-10 07:53:40 +00:00
gitlab_rails['geo_registry_replication_primary_api_url'] = 'http://primary.example.com:4567/' # Primary registry address, it will be used by the secondary node to directly communicate to primary registry
2019-09-11 02:52:00 +00:00
```
1. Reconfigure the **secondary** node for the change to take effect:
2020-01-30 15:09:15 +00:00
```shell
2019-09-11 02:52:00 +00:00
gitlab-ctl reconfigure
```
### Verify replication
2019-05-05 16:08:21 +00:00
2020-02-25 09:09:10 +00:00
To verify Container Registry replication is working, go to ** {admin}** **Admin Area >** ** {location-dot}** **Geo**
(`/admin/geo/nodes`) on the **secondary** node.
2019-09-11 02:52:00 +00:00
The initial replication, or "backfill", will probably still be in progress.
You can monitor the synchronization process on each Geo node from the **primary** node's **Geo Nodes** dashboard in your browser.