Skip to content

consul-snapshot job from consul/23.0.1

Github source: 82be6cf8 or master branch

Properties

consul-snapshot

aws_access_key_id

the access key id used to access the bucket

aws_secret_access_key

the secret key used to access the bucket

backupinterval

how often you want the backup to run in seconds

consul_snapshot_s3_sse

optional server-side encryption algorithm, e.g., aes256 or aws:kms

consul_snapshot_s3_sse_kms_key_id

optional kms key id, if server-side encryption is used, and aws:kms is used for the encryption algorithm

consul_snapshot_upload_prefix

an arbitrary prefix to be prepended to the name of each uploaded object, e.g., consul-dc1. default is backups

Default
backups

crypto_password

sets a password for encrypting and decrypting backups

s3bucket

the s3 bucket where backups should be delivered

s3region

the region the s3 bucket is located

snapshot_tmp_dir

sets the directory for temporary files, defaults to “/tmp”

Default
/tmp

Templates

Templates are rendered and placed onto corresponding instances during the deployment process. This job's templates will be placed into /var/vcap/jobs/consul-snapshot/ directory (learn more).

  • bin/consul-snapshot_ctl (from bin/consul-snapshot_ctl)
  • bin/monit_debugger (from bin/monit_debugger)
  • data/properties.sh (from data/properties.sh.erb)

Packages

Packages are compiled and placed onto corresponding instances during the deployment process. Packages will be placed into /var/vcap/packages/ directory.