https://github.com/sgaunet/gitlab-backup2s3

Backup your gitlab repository to S3
https://github.com/sgaunet/gitlab-backup2s3

backup gitlab golang s3

Last synced: 14 days ago
JSON representation

Backup your gitlab repository to S3

• Host: GitHub
• URL: https://github.com/sgaunet/gitlab-backup2s3
• Owner: sgaunet
• License: mit
• Created: 2022-07-09T14:08:12.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-09-16T19:11:10.000Z (3 months ago)
• Last Synced: 2024-09-16T23:51:35.682Z (3 months ago)
• Topics: backup, gitlab, golang, s3
• Language: Go
• Homepage:
• Size: 165 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Go Report Card](https://goreportcard.com/badge/github.com/sgaunet/gitlab-backup2s3)](https://goreportcard.com/report/github.com/sgaunet/gitlab-backup2s3)

[![GitHub release](https://img.shields.io/github/release/sgaunet/gitlab-backup2s3.svg)](https://github.com/sgaunet/gitlab-backup2s3/releases/latest)

[![Maintainability](https://api.codeclimate.com/v1/badges/6a67a6c0a15b3fad5da7/maintainability)](https://codeclimate.com/github/sgaunet/gitlab-backup2s3/maintainability)

![GitHub Downloads](https://img.shields.io/github/downloads/sgaunet/gitlab-backup2s3/total)

[![License](https://img.shields.io/github/license/sgaunet/gitlab-backup2s3.svg)](LICENSE)

# gitlab-backup2s3

gitlab-backup2s3 is an enhanced docker image to export gitlab projects, encrypt the archive (optional) and save them in a S3.

You can use the binary but it will need some prerequisites :

* [gocrypt](https://github.com/sgaunet/gocrypt) >= v1.2.0 (if you like to encrypt archives with AES)

* [gitlab-backup](https://github.com/sgaunet/gitlab-backup) >= v1.0.0

## Configuration

It needs some environement variables to run:

* GOCRYPT_KEY (if you want to encrypt archives)

* POSTBACKUP (if you want to encrypt archives, set it to: gocrypt enc --i %INPUTFILE% )

* GITLAB_TOKEN

* GITALB_URI (if the endpoint differs from https://gitlab.com)

* GITLABPROJECTID: id of the project to export

* GITLABGROUPID: id of the group to export (will export all sub projects)

* DEBUGLEVEL: info by default

* TMPDIR: /tmp by default

* LOCALPATH: if you want to export archives locally (let empty if you prefer to copy archives to s3)

* S3ENDPOINT: Example https://s3.eu-west-3.amazonaws.com   or http://localhost:9090 for a local minio instance

* S3REGION: region of s3

* S3BUCKETNAME

* S3BUCKETPATH

* AWS_SECRET_ACCESS_KEY: not mandatory if you associate an IAM role to the pod or ec2

* AWS_ACCESS_KEY_ID: not mandatory too

# Development

This project is using :

* Golang

* [task for development](https://taskfile.dev/)

* docker

* [docker buildx](https://github.com/docker/buildx)

* docker manifest

* [goreleaser](https://goreleaser.com/)

* [pre-commit](https://pre-commit.com/)

There are hooks executed in the precommit stage. Once the project cloned on your disk, please install pre-commit:

```

brew install pre-commit

```

Install tools:

```

task dev:install-prereq

```

And install the hooks:

```

task dev:install-pre-commit

```

If you like to launch manually the pre-commmit hook:

```

task dev:pre-commit

```

## Example of deployment

### raw kubernetes manifests

In the [deploy/k8s folder](deploy/k8s/), you will find manifests to deploy a cronjob in kubernetes.

### helm

Another github project contains the helm chart. This is [https://github.com/sgaunet/helm-gitlab-backup2s3](https://github.com/sgaunet/helm-gitlab-backup2s3), check the README.

[Configuration of the helm chart is available here.](https://github.com/sgaunet/helm-gitlab-backup2s3/blob/main/charts/gitlab-backup2s3/README.md)