xsystems/postgres-gs-restore repository overview

⁠xSystems PostgreSQL Google Storage Restore

⁠Usage

⁠Run

Create a GCP service account⁠ and create a key for that service account⁠. Next, assign the service account the role⁠ Storage Admin w.r.t. the Google Cloud Storage bucket.

Create a PostgreSQL password file⁠, matching your database's configuration AND environment variables mentioned later on.

When running a container of this image you MUST mount both before mentioned credentials under /run/secrets/ inside the container. That is, the following files MUST be available inside the container:

• /run/secrets/gcp-credentials.json
• /run/secrets/.pgpass

This can either be achieved using Docker Volumes or Docker Secrets.

Also, when running a container of this image you MUST specify the environment variables GCP_PROJECT, GCP_BUCKET, POSTGRES_DATABASE. Other environment variables are available, but are optional.

All available environment variables are:

⁠Example

This image can be used as follows:

docker run  --tty \
            --interactive \
            --rm \
            --env GCP_PROJECT=<REPLACE_WITH_PROJECT_NAME> \
            --env GCP_BUCKET=<REPLACE_WITH_BUCKET_NAME> \
            --env POSTGRES_DATABASE=<REPLACE_WITH_DATABASE_NAME> \
            --volume `pwd`/gcp-credentials.json:/run/secrets/gcp-credentials.json \
            --volume `pwd`/.pgpass:/run/secrets/.pgpass \
            xsystems/postgres-gs-restore

⁠Build the Image

Run build.sh⁠ to build an image of the current codebase state with tag latest.

⁠Release the Image

1. Set the VERSION environment variable to the version that needs to be released.
2. Optionally, set the COMMIT environment variable to the hash of the Git commit that needs to be released. It defaults to the latest commit.
3. Run release.sh⁠.

Example release statement:

VERSION=1.3.42 ./release.sh