diff options
author | James Fargher <jfargher@gitlab.com> | 2021-11-24 02:03:32 +0300 |
---|---|---|
committer | James Fargher <jfargher@gitlab.com> | 2021-11-24 04:22:19 +0300 |
commit | fed7a2e35c2083aa195a455ed7d3e33195011799 (patch) | |
tree | 4ed8b18b3236f273590c2b87252e0843154afd78 | |
parent | 1dcc934bcbe0f712306913a5a3d7963d77ae2e70 (diff) |
Document object storage support in gitaly-backupdocs-backup-object
-rw-r--r-- | doc/gitaly-backup.md | 25 |
1 files changed, 23 insertions, 2 deletions
diff --git a/doc/gitaly-backup.md b/doc/gitaly-backup.md index cf2f1651c..b50bfeedb 100644 --- a/doc/gitaly-backup.md +++ b/doc/gitaly-backup.md @@ -101,9 +101,30 @@ Gitaly and Gitaly Cluster. | `-parallel-storage` | integer | no | Maximum number of parallel restores per storage. | | `-layout` | string | no | Determines the file-system layout. Any of `legacy`, `pointer` (default `legacy`). Note: The feature is not ready for production use. | -## How Git repository backups work +## Path -The way backup files are arranged on the filesystem or on object storages is determined by the layout. +Path determines where on the local filesystem or in object storage backup files +are created on or restored from. The path is set using the `-path` flag. + +### Local Filesystem + +If `-path` specifies a local filesystem, it is the root of where all backup +files are created. + +### Object Storage + +`gitaly-backup` supports streaming backup files directly to object storage +using the [`gocloud.dev/blob`](https://pkg.go.dev/gocloud.dev/blob) library. +`-path` can be used with: + +- [Amazon S3](https://pkg.go.dev/gocloud.dev/blob/s3blob). For example `-path=s3://my-bucket?region=us-west-1`. +- [Azure Blob Storage](https://pkg.go.dev/gocloud.dev/blob/azureblob). For example `-path=azblob://my-container`. +- [Google Cloud Storage](https://pkg.go.dev/gocloud.dev/blob/gcsblob). For example `-path=gs//my-bucket`. + +## Layouts + +The way backup files are arranged on the filesystem or on object storage is +determined by the layout. The layout is set using the `-layout` flag. ### Legacy layout |