gitlab-org--gitlab-foss/doc/administration/geo/replication/object_storage.md

3.8 KiB

stage group info type
Systems Geo To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments howto

Geo with Object storage (PREMIUM SELF)

Geo can be used in combination with Object Storage (AWS S3, or other compatible object storage).

Currently, secondary sites can use either:

  • The same storage bucket as the primary site.
  • A replicated storage bucket.
  • Local storage, if the primary uses local storage.

The storage method (local or object storage) for files is recorded in the database, and the database is replicated from the primary Geo site to the secondary Geo site.

When accessing an uploaded object, we get its storage method (local or object storage) from the database, so the secondary Geo site must match the storage method of the primary Geo site.

Therefore, if the primary Geo site uses object storage, the secondary Geo site must use it too.

To have:

Read more about using object storage with GitLab.

Enabling GitLab-managed object storage replication

Introduced in GitLab 12.4.

WARNING: This is a Beta feature and is not ready yet for production use at any scale. The main limitations are a lack of testing at scale and no verification of any replicated data.

Secondary sites can replicate files stored on the primary site regardless of whether they are stored on the local file system or in object storage.

To enable GitLab replication:

  1. On the top bar, select Menu > Admin.
  2. On the left sidebar, select Geo > Nodes.
  3. Select Edit on the secondary site.
  4. In the Synchronization Settings section, find the Allow this secondary node to replicate content on Object Storage checkbox to enable it.

For LFS, follow the documentation to set up LFS object storage.

For CI job artifacts, there is similar documentation to configure jobs artifact object storage

For user uploads, there is similar documentation to configure upload object storage

If you want to migrate the primary site's files to object storage, you can configure the secondary in a few ways:

  • Use the exact same object storage.
  • Use a separate object store but leverage your object storage solution's built-in replication.
  • Use a separate object store and enable the Allow this secondary node to replicate content on Object Storage setting.

GitLab does not currently support the case where both:

  • The primary site uses local storage.
  • A secondary site uses object storage.

Third-party replication services

When using Amazon S3, you can use Cross-Region Replication (CRR) to have automatic replication between the bucket used by the primary site and the bucket used by secondary sites.

If you are using Google Cloud Storage, consider using Multi-Regional Storage. Or you can use the Storage Transfer Service, although this only supports daily synchronization.

For manual synchronization, or scheduled by cron, see: