S3

Prerequisites

First of all, you need to have an AWS account, an IAM user and S3 bucket.

To create an IAM user:

1. Sign in to the AWS Management Console and open the IAM console.

2. In the navigation pane, choose Users and then choose Add users.

3. Type the user name for the new user.

4. Select the type of access to be both programmatic access and access to the AWS Management Console.

5. Choose Next: Permissions.

6. On the Set permissions page, select attach existing policies directly, search for AmazonS3FullAccess and choose it, then choose Next: Review, then choose Add permissions.

7. Choose Next: Tags.

8. Choose Next: Review to see all of the choices you made up to this point. When you are ready to proceed, choose Create user.

9. To view the users' access keys (access key IDs and secret access keys), choose Show next to each password and access key that you want to see. To save the access keys, choose Download .csv and then save the file to a safe location.

You are now ready to create a S3 bucket, To create a S3 bucket:

1. Sign in to the AWS Management Console using your IAM user credentials and open the Amazon S3 console.

2. Choose Create bucket.

3. In Bucket name, enter a name for your bucket.

4. In Region, choose the AWS Region where you want the bucket to reside.

5. Keep the default values as it is and Choose Create bucket.

Modify the pgmoneta configuration

You need to have a storage space for 1 backup on your local computer.

Change pgmoneta.conf to add

storage_engine = s3
s3_region = the-aws-region
s3_access_key_id = your-access-key-id-from-the-downloaded-file
s3_secret_access_key = your-secret-access-key-from-the-downloaded-file
s3_bucket = your-s3-bucket-name
s3_base_dir = directory-where-backups-will-be-stored-in

under the [pgmoneta] section.

Garage tutorial

If Garage is already downloaded and configured with an S3 access key, secret key, and bucket, the flow is:

1. Start Garage.
2. Configure pgmoneta for the Garage S3 endpoint.
3. Start pgmoneta.
4. Run pgmoneta-cli s3 ls primary.

Example pgmoneta.conf entries under [pgmoneta]:

storage_engine = s3
s3_access_key_id = your-garage-access-key-id
s3_secret_access_key = your-garage-secret-access-key
s3_bucket = your-garage-bucket
s3_base_dir = pgmoneta
s3_endpoint = your-garage-endpoint-host
s3_port = 3900
s3_region = garage
s3_use_tls = off

Start pgmoneta:

pgmoneta -c pgmoneta.conf -u pgmoneta_users.conf

List remote objects:

pgmoneta-cli s3 ls primary

pgmoneta-cli s3 ls lists objects recursively in the configured remote path and prints all discovered objects in one output.

Delete remote objects by prefix:

pgmoneta-cli s3 delete primary <prefix>

pgmoneta-cli s3 delete removes all objects under <s3_base_dir>/<server>/backup/<prefix>.

Restore a backup from S3:

pgmoneta-cli s3 restore primary <label> [position] <directory>

pgmoneta-cli s3 restore downloads all files from S3 for the given backup label, stages them locally, and restores the backup into the requested target directory using the standard restore workflow.

Metadata files (backup.info, backup.sha512, backup.manifest) are downloaded as temporary files first. backup.info is verified before file download starts, then renamed into place so the staged backup metadata matches the downloaded objects before the restore workflow runs.