Back to Charts

⚠️ Repo Archive Notice

stable/katafygio/README.md

latest5.3 KB
Original Source

⚠️ Repo Archive Notice

As of Nov 13, 2020, charts in this repo will no longer be updated. For more information, see the Helm Charts Deprecation and Archive Notice, and Update.

Katafygio

Katafygio discovers Kubernetes objects (deployments, services, ...), and continuously saves them as YAML files in a Git repository. This provides real-time, continuous backups, and keeps detailed changes history.

DEPRECATION NOTICE

This chart is deprecated and no longer supported.

TL;DR;

bash
$ helm install stable/katafygio

Introduction

This chart installs a Katafygio deployment on a Kubernetes cluster using the Helm package manager.

Prerequisites

  • Kubernetes 1.9+

Chart Details

You may filter out irrelevant objects using the excludeKind and excludeObject options, to keep your backups' repository lean.

By default, the chart will dump (and version) the clusters content in /var/lib/katafygio/data (configurable with localDir). This can be useful as is, to keep a local changes history. To benefit from long term, out of cluster, and centrally reachable persistence, you may provide the address of a remote Git repository (with gitUrl), where all changes will be pushed.

Installing the Chart

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

bash
$ helm install --name my-release stable/katafygio

Uninstalling the Chart

To uninstall/delete the my-release deployment:

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 Katafygio chart and their default values.

ParameterDescriptionDefault
replicaCountDesired number of pods1
image.repositoryKatafygio container image namebpineau/katafygio
image.tagKatafygio container image tagv0.8.1
image.pullPolicyKatafygio container image pull policyIfNotPresent
localDirContainer's local path where Katafygio will dump and commit/tmp/kf-dump
gitUrlOptional remote repository where changes will be pushednil
noGitDisable Git versioningfalse
filterLabel selector to dump only matched objectsnil
healthcheckPortThe port Katafygio will listen for health checks requests8080
excludeKindObject kinds to ignore{"replicaset","endpoints","event"}
excludeObjectSpecific objects to ignore (eg. "configmap:default/foo")nil
rbac.createEnable or disable RBAC roles and bindingstrue
serviceAccount.createWhether a ServiceAccount should be createdtrue
serviceAccount.nameService account to be usednil
resyncIntervalSeconds between full catch-up resyncs. 0 to disable300
logLevelLog verbosity (ie. info, warning, error)warning
logOutputLogs destination (stdout, stderr or syslog)stdout
logServerSyslog server address (eg. "rsyslog:514")nil
resourcesCPU/Memory resource requests/limits{}
tolerationsList of node taints to tolerate[]
affinityNode affinity for pod assignment{}
nodeSelectorNode labels for pod assignment{}

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

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

bash
$ helm install --name my-release -f values.yaml stable/katafygio

Tip: You can use the default values.yaml