|
2 | 2 |
|
3 | 3 | * Takes the dump of the Postgres database |
4 | 4 | * Uploads it to AWS' object storage service S3 |
5 | | -* Reports to WebGazer Pulse (optional) |
| 5 | +* Reports to [WebGazer](https://www.webgazer.io) (optional) |
6 | 6 |
|
7 | 7 | ## Usage |
8 | 8 |
|
9 | 9 | ### Environment variables |
10 | 10 |
|
11 | | -| Variable | Required | Default value | Description | |
12 | | -|-----------------------|:--------:|---------------|-------------------------------------------------------------------------------------------------------------------------------| |
13 | | -| AWS_ACCESS_KEY_ID | ✔ | | Access key id for the AWS account | |
14 | | -| AWS_REGION | ✔ | | Region for the AWS bucket | |
15 | | -| AWS_S3_ENDPOINT | ✔ | | AWS S3 endpoint with bucket and path (e.g. "my-bucket/postgres-backup") | |
16 | | -| AWS_S3_STORAGE_CLASS | | STANDARD_IA | AWS S3 storage class (see https://aws.amazon.com/s3/storage-classes/ and https://rclone.org/s3/#s3-storage-class for options. | |
17 | | -| AWS_SECRET_ACCESS_KEY | ✔ | | Secret access key for the AWS account | |
18 | | -| POSTGRES_DB | ✔ | | Postgres server database | |
19 | | -| POSTGRES_HOST | | postgres | Postgres server host | |
20 | | -| POSTGRES_PASSWORD | ✔ | | Postgres server password | |
21 | | -| POSTGRES_PORT | | 5432 | Postgres server port | |
22 | | -| POSTGRES_USER | | postgres | Postgres server user | |
23 | | -| POSTGRES_VERSION | | 16 | Postgres server version (13, 14, 15 or 16) | |
24 | | -| WEBGAZER_PULSE_URL | | | [WebGazer Pulse](https://www.webgazer.io/pulse) URL | |
| 11 | +| Variable | Required | Default value | Description | |
| 12 | +|------------------------|:--------:|---------------|-------------------------------------------------------------------------------------------------------------------------------| |
| 13 | +| AWS_ACCESS_KEY_ID | ✔ | | Access key id for the AWS account | |
| 14 | +| AWS_REGION | ✔ | | Region for the AWS bucket | |
| 15 | +| AWS_S3_ENDPOINT | ✔ | | AWS S3 endpoint with bucket and path (e.g. "my-bucket/postgres-backup") | |
| 16 | +| AWS_S3_STORAGE_CLASS | | STANDARD_IA | AWS S3 storage class (see https://aws.amazon.com/s3/storage-classes/ and https://rclone.org/s3/#s3-storage-class for options. | |
| 17 | +| AWS_SECRET_ACCESS_KEY | ✔ | | Secret access key for the AWS account | |
| 18 | +| POSTGRES_DB | ✔ | | Postgres server database | |
| 19 | +| POSTGRES_HOST | | postgres | Postgres server host | |
| 20 | +| POSTGRES_PASSWORD | ✔ | | Postgres server password | |
| 21 | +| POSTGRES_PORT | | 5432 | Postgres server port | |
| 22 | +| POSTGRES_USER | | postgres | Postgres server user | |
| 23 | +| POSTGRES_VERSION | | 16 | Postgres server version (13, 14, 15 or 16) | |
| 24 | +| WEBGAZER_HEARTBEAT_URL | | | [WebGazer Heartbeat Monitor](https://www.webgazer.io/services/cron-job-monitoring) URL | |
25 | 25 |
|
26 | 26 | ### Running |
27 | 27 |
|
|
37 | 37 | -e POSTGRES_PORT=<postgres_port[5432]> \ |
38 | 38 | -e POSTGRES_USER=<postgres_user[postgres]> \ |
39 | 39 | -e POSTGRES_VERSION=<postgres_version[15]> \ |
40 | | - -e WEBGAZER_PULSE_URL=<webgazer_pulse_url> |
| 40 | + -e WEBGAZER_HEARTBEAT_URL=<webgazer_heartbeat_url> |
41 | 41 |
|
42 | 42 | ### Example |
43 | 43 |
|
|
53 | 53 | -e POSTGRES_PORT=5432 \ |
54 | 54 | -e POSTGRES_USER=postgres_user \ |
55 | 55 | -e POSTGRES_VERSION=15 \ |
56 | | - -e WEBGAZER_PULSE_URL=https://pulse.webgazer.io/1-8f713c75d659 |
| 56 | + -e WEBGAZER_HEARTBEAT_URL=https://heartbeat.webgazer.io/1-8f713c75d659 |
57 | 57 |
|
58 | 58 | ## Shameless plug |
59 | 59 |
|
|
0 commit comments