Skip to content

Latest commit

聽

History

History
98 lines (66 loc) 路 3.71 KB

README.md

File metadata and controls

98 lines (66 loc) 路 3.71 KB
Raw

Stash

Stash by AppsCode - Backup your Kubernetes Volumes

TL;DR;

$ helm install chart/stash

Introduction

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

Prerequisites

  • Kubernetes 1.5+

Installing the Chart

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

$ helm install chart/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:

$ helm delete my-release

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

Configuration

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

Parameter Description Default
replicaCount Number of stash operator replicas to create (only 1 is supported) 1
operator.image operator container image appscode/stash
operator.tag operator container image tag 0.4.2
operator.pullPolicy operator container image pull policy IfNotPresent
pushgateway.image Prometheus pushgateway container image prom/pushgateway
pushgateway.tag Prometheus pushgateway container image tag v0.4.0
pushgateway.pullPolicy Prometheus pushgateway container image pull policy IfNotPresent
rbac.install install required rbac service account, roles and rolebindings false
rbac.apiVersion rbac api version v1alpha1|v1beta1 v1beta1

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

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

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

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

RBAC

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

You need to have the following parameter on the api server. See the following document for how to enable RBAC

--authorization-mode=RBAC

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

$ kubectl api-versions | grep rbac

If the output contains "alpha" and/or "beta", you can 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:

$ helm install --name my-release chart/stash --set rbac.install=true

Changing RBAC manifest apiVersion

By default the RBAC resources are generated with the "v1beta1" apiVersion. To use "v1alpha1" do the following:

$ helm install --name my-release chart/stash --set rbac.install=true,rbac.apiVersion=v1alpha1