pgbackup job from pgbackup/2
Github source:
c01e71c1
or
master branch
Properties¶
pgbackup
¶
debug
¶Enable debug output, can be ‘true’ or ‘false’ (default).
- Default
"false"
host
¶Hostname or IP address to connect to PostgreSQL on
- Default
localhost
name
¶Name of the backup to create - will be -.tar
- Default
pgdumpall
password
¶Password to authenticate to PostgreSQL with
- Default
PLEASE-CHANGE-THIS
pgdump
¶
arguments
¶Extra arguments to pass to PostgreSQL’s pg_dump utility
- Default
""
port
¶TCP port to connect to PostgreSQL on
- Default
5432
s3
¶
access_key_id
¶Access Key ID for storing backups in Amazon S3
- Default
""
bucket
¶Amazon S3 bucket to store backups in
- Default
pgbackup
endpoint
¶endpoint for backup/restore
- Default
s3.amazonaws.com
path
¶Path to prepend to backup filenames when storing in Amazon S3
- Default
""
secret_access_key
¶Secret Access key for storing backups in Amazon S3
- Default
""
schedule
¶
hour
¶Backup schedule - hour (00-23)
- Default
"01"
minute
¶Backup schedule - minute (00-59)
- Default
"00"
month
¶Backup schedule - month (1-12, or *)
- Default
'*'
monthday
¶Backup schedule - day of the month (1-31, or *)
- Default
'*'
weekday
¶Backup schedule - weekday (0-7, sun/mon/tue/etc., or *)
- Default
'*'
username
¶User to connect to PostgreSQL as
- Default
pgbackup
version
¶Version of PostgreSQL to be backed up/restored
- Default
"9.5"
Templates¶
Templates are rendered and placed onto corresponding
instances during the deployment process. This job's templates
will be placed into /var/vcap/jobs/pgbackup/
directory
(learn more).
bin/control
(frombin/control
)bin/cronwatch
(frombin/cronwatch
)bin/pgbackup
(frombin/pgbackup
)bin/pgrestore
(frombin/pgrestore
)config/pgbackup.cron
(fromconfig/pgbackup.cron
)shell/env
(fromshell/env
)shell/functions
(fromshell/functions
)
Packages¶
Packages are compiled and placed onto corresponding
instances during the deployment process. Packages will be
placed into /var/vcap/packages/
directory.