@helm-charts/appscode-stash v0.8.3-0.1.0
@helm-charts/appscode-stash
Stash by AppsCode - Backup your Kubernetes Volumes
Field | Value |
---|---|
Repository Name | appscode |
Chart Name | stash |
Chart Version | 0.8.3 |
NPM Package Version | 0.1.0 |
# Default values for stash.
# This is a YAML-formatted file.
# Declare variables to be passed into your templates.
replicaCount: 1
# Docker registry containing Stash images
operator:
registry: appscode
repository: stash
tag: 0.8.3
pushgateway:
registry: prom
repository: pushgateway
tag: v0.5.2
cleaner:
registry: appscode
repository: kubectl
tag: v1.12
## Optionally specify an array of imagePullSecrets.
## Secrets must be manually created in the namespace.
## ref: https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod
##
# imagePullSecrets:
# - name: myRegistryKeySecretName
## Specify a imagePullPolicy
## ref: http://kubernetes.io/docs/user-guide/images/#pre-pulling-images
##
imagePullPolicy: IfNotPresent
## Installs Stash operator as critical addon
## https://kubernetes.io/docs/tasks/administer-cluster/guaranteed-scheduling-critical-addon-pods/
criticalAddon: false
## Log level for operator
logLevel: 3
## Annotations passed to operator pod(s).
##
annotations: {}
## Node labels for pod assignment
## Ref: https://kubernetes.io/docs/user-guide/node-selection/
##
nodeSelector:
beta.kubernetes.io/os: linux
beta.kubernetes.io/arch: amd64
## Tolerations for pod assignment
## Ref: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
##
tolerations: {}
## Affinity for pod assignment
## Ref: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#affinity-and-anti-affinity
##
affinity: {}
## Install Default RBAC roles and bindings
rbac:
# Specifies whether RBAC resources should be created
create: true
serviceAccount:
# Specifies whether a ServiceAccount should be created
create: true
# The name of the ServiceAccount to use.
# If not set and create is true, a name is generated using the fullname template
name:
apiserver:
# groupPriorityMinimum is the minimum priority the group should have. Please see
# https://github.com/kubernetes/kube-aggregator/blob/release-1.9/pkg/apis/apiregistration/v1beta1/types.go#L58-L64
# for more information on proper values of this field.
groupPriorityMinimum: 10000
# versionPriority is the ordering of this API inside of the group. Please see
# https://github.com/kubernetes/kube-aggregator/blob/release-1.9/pkg/apis/apiregistration/v1beta1/types.go#L66-L70
# for more information on proper values of this field
versionPriority: 15
# enableMutatingWebhook is used to configure mutating webhook for Kubernetes workloads
enableMutatingWebhook: true
# enableValidatingWebhook is used to configure validating webhook for Stash CRDss
enableValidatingWebhook: true
# CA certificate used by main Kubernetes api server
ca: not-ca-cert
# If true, disables status sub resource for crds.
# Otherwise, enables status sub resource for Kubernetes version >= 1.11 and disables for other versions.
disableStatusSubresource: false
# If true, bypasses validating webhook xray checks
bypassValidatingWebhookXray: false
# If true, uses kube-apiserver FQDN for AKS cluster to workaround https://github.com/Azure/AKS/issues/522 (default true)
useKubeapiserverFqdnForAks: true
# healthcheck configures the readiness and liveliness probes for the operator pod.
healthcheck:
enabled: true
# Send usage events to Google Analytics
enableAnalytics: true
monitoring:
# specify monitoring agent (either "prometheus.io/builtin" or "prometheus.io/coreos-operator")
agent: 'none'
# specify whether to monitor backup and recovery
backup: false
# specify whether to monitor stash operator
operator: false
# specify where ServiceMonitor crd will be created
prometheus:
namespace: ''
serviceMonitor:
labels: {}
Stash
Stash by AppsCode - Backup your Kubernetes Volumes
TL;DR;
$ helm repo add appscode https://charts.appscode.com/stable/
$ helm repo update
$ helm install appscode/stash --name stash-operator --namespace kube-system
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 stash-operator
:
$ helm install appscode/stash --name stash-operator
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 stash-operator
:
$ helm delete stash-operator
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.
Parameter | Description | Default |
---|---|---|
replicaCount | Number of stash operator replicas to create (only 1 is supported) | 1 |
operator.registry | Docker registry used to pull operator image | appscode |
operator.repository | operator container image | stash |
operator.tag | operator container image tag | 0.8.3 |
pushgateway.registry | Docker registry used to pull Prometheus pushgateway image | prom |
pushgateway.repository | Prometheus pushgateway container image | pushgateway |
pushgateway.tag | Prometheus pushgateway container image tag | v0.5.2 |
cleaner.registry | Docker registry used to pull Webhook cleaner image | appscode |
cleaner.repository | Webhook cleaner container image | kubectl |
cleaner.tag | Webhook cleaner container image tag | v1.11 |
imagePullPolicy | container image pull policy | IfNotPresent |
criticalAddon | If true, installs Stash operator as critical addon | false |
logLevel | Log level for operator | 3 |
affinity | Affinity rules for pod assignment | {} |
annotations | Annotations applied to operator pod(s) | {} |
nodeSelector | Node labels for pod assignment | {} |
tolerations | Tolerations used pod assignment | {} |
rbac.create | If true , create and use RBAC resources | true |
serviceAccount.create | If true , create a new service account | true |
serviceAccount.name | Service account to be used. If not set and serviceAccount.create is true , a name is generated using the fullname template |
|
apiserver.groupPriorityMinimum | The minimum priority the group should have. | 10000 |
apiserver.versionPriority | The ordering of this API inside of the group. | 15 |
apiserver.enableValidatingWebhook | Enable validating webhooks for Stash CRDs | true |
apiserver.enableMutatingWebhook | Enable mutating webhooks for Kubernetes workloads | true |
apiserver.ca | CA certificate used by main Kubernetes api server | not-ca-cert |
apiserver.disableStatusSubresource | If true, disables status sub resource for crds. Otherwise enables based on Kubernetes version | false |
apiserver.bypassValidatingWebhookXray | If true, bypasses validating webhook xray checks | false |
apiserver.useKubeapiserverFqdnForAks | If true, uses kube-apiserver FQDN for AKS cluster to workaround https://github.com/Azure/AKS/issues/522 | true |
apiserver.healthcheck.enabled | Enable readiness and liveliness probes | true |
enableAnalytics | Send usage events to Google Analytics | true |
monitoring.agent | Specify which monitoring agent to use for monitoring Stash. It accepts either prometheus.io/builtin or prometheus.io/coreos-operator . | none |
monitoring.backup | Specify whether to monitor Stash backup and recovery. | false |
monitoring.operator | Specify whether to monitor Stash operator. | false |
monitoring.prometheus.namespace | Specify the namespace where Prometheus server is running or will be deployed. | Release namespace |
monitoring.serviceMonitor.labels | Specify the labels for ServiceMonitor. Prometheus crd will select ServiceMonitor using these labels. Only usable when monitoring agent is prometheus.io/coreos-operator . | app: <generated app name> and release: <release name> |
Specify each parameter using the --set key=value[,key=value]
argument to helm install
. For example:
$ helm install --name stash-operator --set image.tag=v0.2.1 appscode/stash
Alternatively, a YAML file that specifies the values for the parameters can be provided while installing the chart. For example:
$ helm install --name stash-operator --values values.yaml appscode/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:
$ 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:
$ helm install --name stash-operator appscode/stash --set rbac.create=true
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago