You are looking at the documentation of a prior release. To read the documentation of the latest release, please
visit here.
Stash Community edition is available under AppsCode-Community-1.0.0 license and free to use for both commercial and non-commercial purposes. It comes with all the basic backup functionalities. However, it lacks some advanced features such as Database Backup, Auto-Backup, Batch Backup, and Local Backend support, etc. compared to the Enterprise edition. A full features comparison between the Stash Community edition and Enterprise edition can be found here.
To use Stash Community edition, you can grab 1 year free license from here.
In this section, we are going to show you how you can get a 1 year free license for Stash Community edition. You can get a license for your Kubernetes cluster by going through the following steps:
kube-system
namespace).Stash Community Edition
in the product field.kubectl get ns kube-system -o=jsonpath='{.metadata.uid}'
license.txt
file.Here is a screenshot of the license form.
You can create licenses for as many clusters as you want. You can upgrade your license any time without re-installing Stash by following the upgrading guide from here.
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.
Stash operator can be installed as a Helm chart or simply as Kubernetes manifests.
Stash can be installed via Helm using the chart from AppsCode Charts Repository. To install the chart with the release name stash
:
$ helm repo add appscode https://charts.appscode.com/stable/
$ helm repo update
$ helm search repo appscode/stash --version v0.11.7
NAME CHART VERSION APP VERSION DESCRIPTION
appscode/stash v0.11.7 v0.11.7 Stash by AppsCode - Backup your Kubernetes Volumes
$ helm install stash appscode/stash \
--version v0.11.7 \
--namespace kube-system \
--set-file license=/path/to/the/license.txt
To see the detailed configuration options, visit here.
Stash can be installed via Helm using the chart from AppsCode Charts Repository. To install the chart with the release name stash
:
$ helm repo add appscode https://charts.appscode.com/stable/
$ helm repo update
$ helm search appscode/stash --version v0.11.7
NAME CHART VERSION APP VERSION DESCRIPTION
appscode/stash v0.11.7 v0.11.7 Stash by AppsCode - Backup your Kubernetes Volumes
$ helm install appscode/stash --name stash \
--version v0.11.7 \
--namespace kube-system \
--set-file license=/path/to/the/license.txt
To see the detailed configuration options, visit here.
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 repo add appscode https://charts.appscode.com/stable/
$ helm repo update
$ helm search repo appscode/stash --version v0.11.7
NAME CHART VERSION APP VERSION DESCRIPTION
appscode/stash v0.11.7 v0.11.7 Stash by AppsCode - Backup your Kubernetes Volumes
$ helm template stash appscode/stash \
--version v0.11.7 \
--namespace kube-system \
--set-file license=/path/to/the/license.txt \
--no-hooks | kubectl apply -f -
To see the detailed configuration options, visit here.
To check if Stash operator pods have started, run the following command:
$ kubectl get pods --all-namespaces -l app.kubernetes.io/name=stash --watch
NAMESPACE NAME READY STATUS RESTARTS AGE
kube-system stash-859d6bdb56-m9br5 2/2 Running 2 5s
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
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
restoresessions.stash.appscode.com 2020-08-24T08:20:55Z
tasks.stash.appscode.com 2020-08-24T08:20:55Z
Now, you are ready to take your first backup using Stash.