# K8s-Borg

K8s-Borg is a self-hosted backup app. A Helm chart that backs up Kubernetes clusters with BorgBackup by deploying node, cluster-data, and console workloads to separate Borg repositories. It is open source and self-hosted, installable on Kubernetes (Helm).

Canonical page: https://ourlocalhost.com/app/7763/k8s-borg

## Description

A Helm chart that backs up Kubernetes clusters with BorgBackup by deploying node, cluster-data, and console workloads to separate Borg repositories. It includes an optional Borg UI server with managed agents and an optional Borg 1/Borg 2 repository server for cluster operators needing deduplicated, encrypted backups.

## Platform availability

Available on 1 of 10 platforms: Helm.

## Health score

55/100 (Fair), based on 3 of 4 factors.
- Maintained: 100 (last commit 5 days ago)
- Popular: 6 (1 GitHub stars)
- Easy to install: 25 (1 install platform, install notes)

## Links

- Documentation: https://k8s-borg.ioanalytica.com/
- Kubernetes (Helm): https://artifacthub.io/packages/helm/k8s-borg/k8s-borg
- GitHub: https://github.com/ioanalytica/k8s-borg
- Official website: https://k8s-borg.ioanalytica.com/

## Common questions

### How do I specify which paths k8s-borg should back up?

The chart names no paths by default. You provide them as R roots, for example by adding /node/etc to a node.include value.

### Can k8s-borg run both the Borg UI and a Borg repository server in one release?

Yes. The chart can optionally deploy a Borg UI server with managed agents, and a repository server for Borg 1 or Borg 2 can run in the same release.

### How should I pass the repository passphrase and SSH key in a real cluster?

For anything beyond a smoke test, put the sensitive values in a pre-created Secret and reference that Secret with existingSecret.

### Is there a way to test k8s-borg without a dedicated Borg machine?

The try-locally guide runs the whole chart in a throwaway k3d cluster, with Borg UI and managed agents, up to a first backup and restore.

---
Source: Our Local Host (https://ourlocalhost.com/app/7763/k8s-borg), the self-hosted and open-source app directory.
