You are looking at the documentation of a prior release. To read the documentation of the latest release, please
visit here.
This is an Enterprise-only feature. Please install Stash Enterprise Edition to try this feature.
Install Percona XtraDB 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 Percona XtraDB databases, you have to install Percona XtraDB addon (stash-percona-xtradb) for Stash. This addon creates necessary Function and Task definitions to backup/restore Percona XtraDB 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-percona-xtradb addon as a Helm chart using Helm 3.
curl -fsSL https://github.com/stashed/catalog/raw/v2021.03.08/deploy/helm3.sh | bash -s -- --catalog=stash-percona-xtradb
Using Helm 2
Run the following script to install stash-percona-xtradb addon as a Helm chart using Helm 2.
curl -fsSL https://github.com/stashed/catalog/raw/v2021.03.08/deploy/helm2.sh | bash -s -- --catalog=stash-percona-xtradb
Using YAML
Run the following script to install stash-percona-xtradb addon as Kubernetes YAMLs.
curl -fsSL https://github.com/stashed/catalog/raw/v2021.03.08/deploy/script.sh | bash -s -- --catalog=stash-percona-xtradb
The above script uses Helm 3 for rendering the charts to generate the YAMLs.
Verify Installation
After installation is completed, this addon will create percona-xtradb-backup-* and percona-xtradb-restore-* Functions and Tasks for all supported Percona XtraDB versions. To verify, run the following command:
$ kubectl get functions.stash.appscode.com
NAME AGE
percona-xtradb-backup-5.7 20s
percona-xtradb-restore-5.7 20s
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
percona-xtradb-backup-5.7 2m7s
percona-xtradb-restore-5.7 2m7s
pvc-backup 7h7m
pvc-restore 7h7m
Now, Stash is ready to backup Percona XtraDB databases.
Customizing Installation
In order to install Function and Task only for a specific Percona XtraDB version, use --version flag to specify the desired database version.
curl -fsSL https://github.com/stashed/catalog/raw/v2021.03.08/deploy/helm3.sh | bash -s -- --catalog=stash-percona-xtradb --version=5.7
The flowing flags are available for customizing Percona XtraDB addon installation:
| Flag | Usage |
|---|---|
--version | Specify a specific version of a specific addon to install. Use it along with --catalog flag. |
--docker-registry | Specify the docker registry to use to pull respective addon images. Default Value: stashed. |
--image | Specify the name of the docker image to use for respective addons. |
--image-tag | Specify the tag of the docker image to use for respective addon. |
--backup-args | Specify optional arguments to pass to xtrabackup command during backup. These arguments apply to all Percona XtraDB instances in this cluster. To set arguments for a specific Percona XtraDB database instance, set args parameter in spec.task.params field of the respective BackupConfiguration. |
--restore-args | Specify optional arguments to pass to xtrabackup command during restore. These arguments apply to all Percona XtraDB instances in this cluster. To set arguments for a specific Percona XtraDB database instance, set args parameter in spec.task.params field of the respective RestoreSession. |