You are looking at the documentation of a prior release. To read the documentation of the latest release, please
visit here.
Install Stash
Get a Free License
Download a FREE license from AppsCode License Server.
Stash licensing process has been designed to work with CI/CD workflow. You can automatically obtain a license from your CI/CD pipeline by following the guide from here.
Install
Stash operator can be installed as a Helm chart or simply as Kubernetes manifests.
Using Helm 3
Stash can be installed via Helm using the chart from AppsCode Charts Repository. To install the chart with the release name stash:
$ helm install stash oci://ghcr.io/appscode-charts/stash \
--version v2024.9.30 \
--namespace stash --create-namespace \
--set features.enterprise=true \
--set-file global.license=/path/to/the/license.txt \
--wait --burst-limit=10000 --debug
To see the detailed configuration options, visit here.
Using YAML
If you prefer to not use Helm, you can generate YAMLs from Stash chart and deploy using kubectl. Here we are going to show the prodecure using Helm 3.
$ helm template stash oci://ghcr.io/appscode-charts/stash \
--version v2024.9.30 \
--namespace stash --create-namespace \
--set features.enterprise=true \
--set global.skipCleaner=true \
--set-file global.license=/path/to/the/license.txt | kubectl apply -f -
To see the detailed configuration options, visit here.
Verify installation
To check if Stash operator pods have started, run the following command:
❯ kubectl get pods --all-namespaces -l app.kubernetes.io/name=stash-enterprise --watch
NAMESPACE NAME READY STATUS RESTARTS AGE
kube-system stash-stash-enterprise-678bcb6db4-267vk 2/2 Running 0 3m
Once the operator pod is running, you can cancel the above command by typing Ctrl+C.
Now, to confirm CRD groups have been registered by the operator, run the following command:
$ kubectl get crd -l app.kubernetes.io/name=stash
NAME CREATED AT
backupbatches.stash.appscode.com 2020-08-24T08:20:54Z
backupblueprints.stash.appscode.com 2020-08-24T08:20:55Z
backupconfigurations.stash.appscode.com 2020-08-24T08:20:54Z
backupsessions.stash.appscode.com 2020-08-24T08:20:55Z
functions.stash.appscode.com 2020-08-24T08:20:55Z
recoveries.stash.appscode.com 2020-08-24T08:20:54Z
repositories.stash.appscode.com 2020-08-24T08:20:54Z
restics.stash.appscode.com 2020-08-24T08:20:54Z
restorebatches.stash.appscode.com 2020-08-24T08:20:55Z
restoresessions.stash.appscode.com 2020-08-24T08:20:55Z
tasks.stash.appscode.com 2020-08-24T08:20:55Z
Verify Catalogs
Stash automatically installs the necessary Addon catalogs for database backup. Verify that the Addon catalogs have been installed using the following command.
❯ kubectl get tasks.stash.appscode.com
NAME AGE
elasticsearch-backup-5.6.4 5m8s
elasticsearch-backup-6.2.4 5m8s
elasticsearch-backup-6.3.0 5m8s
elasticsearch-backup-6.4.0 5m8s
elasticsearch-backup-6.5.3 5m8s
elasticsearch-backup-6.8.0 5m8s
elasticsearch-backup-7.2.0 5m8s
elasticsearch-backup-7.3.2 5m8s
elasticsearch-restore-5.6.4 5m8s
elasticsearch-restore-6.2.4 5m8s
elasticsearch-restore-6.3.0 5m8s
elasticsearch-restore-6.4.0 5m8s
elasticsearch-restore-6.5.3 5m8s
elasticsearch-restore-6.8.0 5m8s
elasticsearch-restore-7.2.0 5m8s
elasticsearch-restore-7.3.2 5m8s
mariadb-backup-10.5.8 5m8s
mariadb-restore-10.5.8 5m8s
mongodb-backup-3.4.17 5m8s
mongodb-backup-3.4.22 5m8s
mongodb-backup-3.6.13 5m8s
mongodb-backup-4.0.11 5m8s
mongodb-backup-4.0.3 5m8s
mongodb-backup-4.1.13 5m8s
mongodb-backup-4.1.4 5m8s
mongodb-backup-4.1.7 5m8s
mongodb-backup-4.2.3 5m8s
mongodb-restore-3.4.17 5m8s
mongodb-restore-3.4.22 5m8s
mongodb-restore-3.6.13 5m8s
mongodb-restore-4.0.11 5m8s
mongodb-restore-4.0.3 5m8s
mongodb-restore-4.1.13 5m8s
mongodb-restore-4.1.4 5m8s
mongodb-restore-4.1.7 5m8s
mongodb-restore-4.2.3 5m8s
mysql-backup-5.7.25 5m8s
mysql-backup-8.0.14 5m8s
mysql-backup-8.0.21 5m8s
mysql-backup-8.0.3 5m8s
mysql-restore-5.7.25 5m8s
mysql-restore-8.0.14 5m8s
mysql-restore-8.0.21 5m8s
mysql-restore-8.0.3 5m8s
perconaxtradb-backup-5.7 5m8s
perconaxtradb-restore-5.7 5m8s
postgres-backup-10.14 5m8s
postgres-backup-11.9 5m8s
postgres-backup-12.4 5m8s
postgres-backup-13.1 5m8s
postgres-backup-9.6.19 5m8s
postgres-restore-10.14 5m8s
postgres-restore-11.9 5m8s
postgres-restore-12.4 5m8s
postgres-restore-13.1 5m8s
postgres-restore-9.6.19 5m8s
pvc-backup 5m2s
pvc-restore 5m2s
As you can see from the above output that Stash has created Task objects for each supported databases.
Now, you are ready to take your first backup using Stash.
Purchase Stash License
If you are interested in purchasing Stash license, please contact us via [email protected] for further discussion. You can also set up a meeting via our calendly link.
If you are willing to purchase Stash license but need more time to test in your dev cluster, feel free to contact [email protected]. We will be happy to extend your trial period.