Skip to main content

Backup Jenkins to S3

Project description

jenkins-backup-s3

A collection of scripts to backup Jenkins configuration to S3, as well as manage and restore those backups. By default runs silently (no output) with proper exit codes. Log Level option enables output.

Setup

pip install jenkins-backup-s3

Configure S3 and IAM

  • Create an S3 bucket to store backups.

  • Create an IAM role with STS:AssumeRole and a trust Service ec2.amazonaws.com. The IAM role must have the GetObject, DeleteObject, PutObject and ListBucket S3 permissions for that bucket.

Usage

Setup with cron for ideal usage.

backup-jenkins {OPTIONS} {COMMAND} {COMMAND_OPTIONS}

Options can be set directly or via and environment variable.

The only required option is your S3 bucket:

  • backup-jenkins --bucket={BUCKET_NAME}

Other available options are:

Bucket prefix (defaults to "jenkins-backups"):

  • backup-jenkins --bucket-prefix={BUCKET_PREFIX}

Bucket region (defaults to "us-east-1"):

  • backup-jenkins --bucket-region={BUCKET_REGION}

Available commands:

  • create
  • restore
  • list
  • delete
  • prune

Run backup-jenkins {COMMAND} --help for command-specific options.

Running a daily backup on Jenkins

Create a new item in Jenkins and configure a build of this repository.

Set the shell / virtualenv builder (if you have it installed) to run backup-jenkins create.

Set the build on a daily CRON schedule.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jenkins-backup-s3-0.1.9.tar.gz (4.5 kB view details)

Uploaded Source

Built Distribution

jenkins_backup_s3-0.1.9-py3-none-any.whl (6.1 kB view details)

Uploaded Python 3

File details

Details for the file jenkins-backup-s3-0.1.9.tar.gz.

File metadata

  • Download URL: jenkins-backup-s3-0.1.9.tar.gz
  • Upload date:
  • Size: 4.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.13.0 setuptools/40.2.0 requests-toolbelt/0.8.0 tqdm/4.23.1 CPython/2.7.15

File hashes

Hashes for jenkins-backup-s3-0.1.9.tar.gz
Algorithm Hash digest
SHA256 78080b1a541f826c9b343aba4f97e00fcab767bb1370887a295a2f52d71a45bc
MD5 818ff2c6af6cc66416f20c79e77b25cf
BLAKE2b-256 67d58836f375d0acafd839764b34cc6fcdac7413091915d2216f52693ebff993

See more details on using hashes here.

File details

Details for the file jenkins_backup_s3-0.1.9-py3-none-any.whl.

File metadata

  • Download URL: jenkins_backup_s3-0.1.9-py3-none-any.whl
  • Upload date:
  • Size: 6.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.13.0 setuptools/40.2.0 requests-toolbelt/0.8.0 tqdm/4.23.1 CPython/2.7.15

File hashes

Hashes for jenkins_backup_s3-0.1.9-py3-none-any.whl
Algorithm Hash digest
SHA256 d7a07618a95d684c2c24a335661ce36bd17d7df43644e1b5d4792292f1157ce2
MD5 3299b1e274be099798180ef46836981a
BLAKE2b-256 7541c6756fd28c60f038660c0231ccdf18dd54a1dedf62015a72c3562020b068

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page