1
0
Fork 0
mirror of https://github.com/roles-ansible/role-postgresql-backup.git synced 2024-08-16 10:19:49 +02:00

Add some docs to README

This commit is contained in:
L3D 2020-07-09 17:28:35 +02:00 committed by L3D
parent 85bae6785f
commit 8ea34f07a6
No known key found for this signature in database
GPG key ID: 5215C3441797AB2B

View file

@ -1,4 +1,65 @@
# role-postgresql-backup # role-postgresql-backup
Ansible role to automaticcally backup your postgresql database you created with ansible Ansible role to automaticcally backup your postgresql database you created with ansible
```
WÖRK IN PROGRESS, obviously! WÖRK IN PROGRESS, obviously!
```
Configuration
------------------
* required packages to create postgres dump and add a cronjob
```yaml
postgresql_backup:
required_packages:
- postgresql-client
- cron
```
* Where do we store our database backups:
```yaml
postgresql_backup:
backup_dir: /var/backup/postgresql
```
+ Dateformat we use to create daily backup folder
```yaml
postgresql_backup:
date_format: '%Y-%m-%d_%H-%M'
```
+ Create cronjob to run backup script?
```yaml
postgresql_backup:
cron: true
```
+ User that should run the backup script as cronjob
```yaml
postgresql_backup:
user: root
```
* Minute and hour to run the cronjob
```yaml
postgresql_backup:
cron_minute: '*'
cron_hour: '0'
```
+ Which database*(s)* do we want to backup` *(example)*
*The values for host and port are optional!*
```yaml
postgresql_backup:
databases:
- name: psql_database_name
user: psql_database_user
password: Topf_Secret1
host: localhost
port: 5432
```
+ Perform basic versionscheck *(true is recomended)*
```
submodules_versioncheck: false
```