You are looking at the documentation of a prior release. To read the documentation of the latest release, please
visit here.
Install Stash Enterprise Edition
Stash Enterprise edition is the closed-sourced version of Stash. It comes with all the functionalities of Stash Community edition as well as some advanced features such as Auto-Backup, Batch Backup, and Local Backend support, etc. A full features comparison between Stash Enterprise Edition and community version can be found here.
If you are willing to try Stash Enterprise Edition, you can grab a 7 days trial license from here.
Get a Trial License
In this section, we are going to show you how you can get a 7 days trial license for Stash Enterprise edition. You can get a license for your Kubernetes cluster by going through the following steps:
- At first, go to AppsCode License Server and fill up the form. It will ask for your Name, Email, the product you want to install, and your cluster ID (UID of the
kube-system
namespace). - Provide your name and email address. You must provide your work email address.
- Then, select
Stash Enterprise Edition
in the product field. - Now, provide your cluster ID. You can get your cluster ID easily by running the following command:
kubectl get ns kube-system -o=jsonpath='{.metadata.uid}'
- Then, you have to agree with the terms and conditions. We recommend reading it before checking the box.
- Now, you can submit the form. After you submit the form, the AppsCode License server will send an email to the provided email address with a link to your license file.
- Navigate to the provided link and save the license into a file. Here, we save the license to a
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.
Get an Enterprise License
If you are interested in purchasing Enterprise 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 purchasing Enterprise 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.
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-enterprise
:
$ helm repo add appscode https://charts.appscode.com/stable/
$ helm repo update
$ helm search repo appscode/stash-enterprise --version v2020.08.26-rc.0
NAME CHART VERSION APP VERSION DESCRIPTION
appscode/stash-enterprise v2020.08.26-rc.0 v2020.08.26-rc.0 Stash Enterprise by AppsCode - Enterprise features for Stash
$ helm install stash appscode/stash-enterprise \
--version v2020.08.26-rc.0 \
--namespace kube-system \
--set-file license=/path/to/the/license.txt
To see the detailed configuration options, visit here.
Using Helm 2
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-enterprise --version v2020.08.26-rc.0
NAME CHART VERSION APP VERSION DESCRIPTION
appscode/stash-enterprise v2020.08.26-rc.0 v2020.08.26-rc.0 Stash by AppsCode - Backup your Kubernetes Volumes
$ helm install appscode/stash-enterprise --name stash \
--version v2020.08.26-rc.0 \
--namespace kube-system \
--set-file license=/path/to/the/license.txt
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 repo add appscode https://charts.appscode.com/stable/
$ helm repo update
$ helm search repo appscode/stash-enterprise --version v2020.08.26-rc.0
NAME CHART VERSION APP VERSION DESCRIPTION
appscode/stash-enterprise v2020.08.26-rc.0 v2020.08.26-rc.0 Stash by AppsCode - Backup your Kubernetes Volumes
$ helm template stash appscode/stash-enterprise \
--version v2020.08.26-rc.0 \
--namespace kube-system \
--set-file license=/path/to/the/license.txt \
--no-hooks | 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-enterprise-568c884795-hzbgg 2/2 Running 0 5h35m
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
Now, you are ready to take your first backup using Stash.