Install PostgreSQL Addon for Stash

Stash uses Function-Task model to backup databases. This Function-Task model enables Stash to extend its capability via addons. In order to backup PostgreSQL databases, you have to install PostgreSQL addon (stash-postgres) for Stash. This addon creates necessary Function and Task definitions to backup/restore PostgreSQL database.

You can install the addon either as a helm chart or you can create only the YAMLs of the respective resources.

Using Helm 3

Run the following script to install stash-postgres addon as a Helm chart using Helm 3.

curl -fsSL https://github.com/stashed/catalog/raw/v0.3.0/deploy/helm3.sh | bash -s -- --catalog=stash-postgres

Using Helm 2

Run the following script to install stash-postgres addon as a Helm chart using Helm 2.

curl -fsSL https://github.com/stashed/catalog/raw/v0.3.0/deploy/helm2.sh | bash -s -- --catalog=stash-postgres

Using YAML

Run the following script to install stash-postgres addon as Kubernetes YAMLs.

curl -fsSL https://github.com/stashed/catalog/raw/v0.3.0/deploy/script.sh | bash -s -- --catalog=stash-postgres

The above script uses Helm 3 for rendering the charts to generate the YAMLs.

Verify Installation

After installation is completed, this addon will create postgres-backup-* and postgres-restore-* Functions and Tasks for all supported PostgreSQL versions. To verify, run the following command:

$ kubectl get functions.stash.appscode.com
NAME                    AGE
postgres-backup-10.2    20s
postgres-backup-10.6    20s
postgres-backup-11.1    19s
postgres-backup-9.6     20s
postgres-restore-10.2   20s
postgres-restore-10.6   20s
postgres-restore-11.1   19s
postgres-restore-9.6    20s
postgres-backup-11.2    19s
postgres-restore-11.2   19s
pvc-backup              7h6m
pvc-restore             7h6m
update-status           7h6m

Also, verify that the Task have been created.

$ kubectl get tasks.stash.appscode.com
NAME                    AGE
postgres-backup-10.2    2m7s
postgres-backup-10.6    2m7s
postgres-backup-11.1    2m6s
postgres-backup-9.6     2m7s
postgres-restore-10.2   2m7s
postgres-restore-10.6   2m7s
postgres-restore-11.1   2m6s
postgres-restore-9.6    m7s
postgres-backup-11.2    2m6s
postgres-restore-11.2   2m6s
pvc-backup              7h7m
pvc-restore             7h7m

Now, Stash is ready to backup PostgreSQL databases.

Customizing Installation

In order to install Function and Task only for a specific PostgreSQL version, use --version flag to specify the desired database version.

curl -fsSL https://github.com/stashed/catalog/raw/v0.3.0/deploy/helm3.sh | bash -s -- --catalog=stash-postgres --version=11.2

The flowing flags are available for customizing PostgreSQL addon installation:

FlagUsage
--versionSpecify a specific version of a specific addon to install. Use it along with --catalog flag.
--docker-registrySpecify the docker registry to use to pull respective addon images. Default Value: stashed.
--imageSpecify the name of the docker image to use for respective addons.
--image-tagSpecify the tag of the docker image to use for respective addon.
--pg-backup-argsSpecify optional arguments to pass to pgdump command during backup. These arguments apply to all PostgreSQL instances in this cluster. To set arguments for a specific PostgreSQL database instance, set pgArgs parameter in spec.task.params field of the respective BackupConfiguration.
--pg-restore-argsSpecify optional arguments to pass to psql command during restore. These arguments apply to all PostgreSQL instances in this cluster. To set arguments for a specific PostgreSQL database instance, set pgArgs parameter in spec.task.params field of the respective RestoreSession.