Back to Charts

Stash

stable/stash/README.md

latest4.5 KB
Original Source

This chart is DEPRECATED and moved to https://github.com/appscode/charts

Stash

Stash by AppsCode - Backup your Kubernetes Volumes

TL;DR;

console
$ helm install stable/stash

Introduction

This chart bootstraps a Stash controller deployment on a Kubernetes cluster using the Helm package manager.

Prerequisites

  • Kubernetes 1.8+

Installing the Chart

To install the chart with the release name my-release:

console
$ helm install stable/stash --name my-release

The command deploys Stash operator on the Kubernetes cluster in the default configuration. The configuration section lists the parameters that can be configured during installation.

Tip: List all releases using helm list

Uninstalling the Chart

To uninstall/delete the my-release:

console
$ helm delete my-release

The command removes all the Kubernetes components associated with the chart and deletes the release.

Configuration

The following table lists the configurable parameters of the Stash chart and their default values.

ParameterDescriptionDefault
replicaCountNumber of Stash operator replicas to create (only 1 is supported)1
operator.imageoperator container imageappscode/stash
operator.tagoperator container image tag0.7.0-rc.1
operator.pullPolicyoperator container image pull policyIfNotPresent
pushgateway.imagePrometheus pushgateway container imageprom/pushgateway
pushgateway.tagPrometheus pushgateway container image tagv0.4.0
pushgateway.pullPolicyPrometheus pushgateway container image pull policyIfNotPresent
criticalAddonIf true, installs Stash operator as critical addonfalse
rbac.createIf true, create and use RBAC resourcestrue
serviceAccount.createIf true, create a new service accounttrue
serviceAccount.nameService account to be used. If not set and serviceAccount.create is true, a name is generated using the fullname template``
apiserver.groupPriorityMinimumThe minimum priority the group should have10000
apiserver.versionPriorityThe ordering of this API inside of the group15
apiserver.enableValidatingWebhookEnable validating webhooks for Stash CRDsfalse
apiserver.enableMutatingWebhookEnable mutating webhooks for Kubernetes workloadsfalse
apiserver.caCA certificate used by main Kubernetes api server``

Specify each parameter using the --set key=value[,key=value] argument to helm install. For example:

console
$ helm install --name my-release --set image.tag=v0.2.1 stable/stash

Alternatively, a YAML file that specifies the values for the parameters can be provided while installing the chart. For example:

console
$ helm install --name my-release --values values.yaml stable/stash

RBAC

By default the chart will not install the recommended RBAC roles and rolebindings.

You need to have the flag --authorization-mode=RBAC on the api server. See the following document for how to enable RBAC.

To determine if your cluster supports RBAC, run the following command:

console
$ kubectl api-versions | grep rbac

If the output contains "beta", you may install the chart with RBAC enabled (see below).

Enable RBAC role/rolebinding creation

To enable the creation of RBAC resources (On clusters with RBAC). Do the following:

console
$ helm install --name my-release stable/stash --set rbac.create=true