Gitlab Backup Manager (GLBM)

Gitlab Backup Manager is a tool to help manage Backups of Gitlab in one place.

Main Backup = gitlab-rake gitlab:backup:create
Backup Config = gitlab-ctl backup-etc

Getting started

Configuration Options

Configuration settings are used in the following order:

1. Config YAML file ( see order below )
2. OS Environment Variables

The order of config file checking location

1. local directory where executable is running (Mostly used for dev.) - config.yaml
2. $HOME/.config/glbm/config.yaml
3. /etc/glbm_config.yaml

OS Environment Variables

GLBM_S3_BUCKET # Bucket name (required)
GLBM_S3_ENDPOINT_URL # URL to S3 (required)
GLBM_S3_DIRECTORY # Directory path in bucket (required)
GLBM_DAYS_TO_KEEP # Keep X days worth of backups (default: 30)
GLBM_NOTIFICATIONS_ENABLED #Send to Slack (default: "false")
GLBM_SLACK_TOKEN
GLBM_SLACK_CHANNEL_ID
GLBM_LOGGING_LEVEL # INFO, DEBUG, WARNING, ERROR & CRITICAL (defualt: INFO)
GLBM_SKIP_BACKUP_OPTIONS # db, repositories, uploads, artifacts, lfs, registry, and pages (optional)

Config file example

*Config file used same settings as OS Env above, but lowercase, and remove GLBM_

s3_bucket: bucket1
s3_endpoint_url: https://<domain>/<path>:<port>
s3_directory: gl_backups
days_to_keep: 14
notifications_enabled: "true"
slack_token: xoxb-xxxxxxxxxxxxx-xxxxxxxxxxx-xxxxxxxxxxxx
slack_channel_id: "ABCDEFGHIJC"
logging_level: "DEBUG"
skip_backup_options: ['registry', 'artifacts']

Installation (Preferred)

$ pip installl gitlab_bm

After install run the following to see default opitions:

$ glbm
Usage: glbm [OPTIONS] COMMAND [ARGS]...

  Gitlab Backup Manager (GLBM) Ver. (x.x.x)

Options:
  --version  Show application Version
  --help     Show this message and exit.

Commands:
  backup              Run main backup
  backup-etc          Run Backup Config and upload to S3
  complete            Run backup, backup_etc, upload_to_s3 and delete_files
  delete-files        Delete old files on S3 based on (X) days to keep
  show-active-config  Show Active Config

Current Limitations

• Only supports Slack Notifications
• Manual setup of Main Backup in gitlab.rb still needed
• (Scheduling of jobs) - Need to manually setup.

Development

Want to contribute? Great! No specifics at this point. Just basic GitHub Fork and Pull request.
For further info, see github guide on contributing to opensource project.

After cloning your Forked branch locally, and installing Poetry, you can run the following to setup dev env and test:

$ poetry install

Then to run, do the following:

$ poetry run glbm

License

MIT LICENSE.txt