Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/catalogicsoftware/kubedr
An open source, disaster-recovery, Kubernetes project that backs up, and restores, etcd cluster data.
https://github.com/catalogicsoftware/kubedr
backup-certificates cluster-data data-protection etcd kubernetes restore
Last synced: 9 days ago
JSON representation
An open source, disaster-recovery, Kubernetes project that backs up, and restores, etcd cluster data.
- Host: GitHub
- URL: https://github.com/catalogicsoftware/kubedr
- Owner: catalogicsoftware
- License: apache-2.0
- Created: 2020-01-08T19:39:40.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2020-03-01T21:30:10.000Z (over 4 years ago)
- Last Synced: 2024-08-01T13:24:37.345Z (3 months ago)
- Topics: backup-certificates, cluster-data, data-protection, etcd, kubernetes, restore
- Language: Go
- Homepage: https://catalogicsoftware.com/clabs
- Size: 12.5 MB
- Stars: 61
- Watchers: 13
- Forks: 6
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://goreportcard.com/report/github.com/catalogicsoftware/kubedr)
[![Discuss at [email protected]](https://img.shields.io/badge/discuss-kubedr--discuss%40googlegroups.com-blue)](https://groups.google.com/d/forum/kubedr-discuss)
[](https://opensource.org/licenses/Apache-2.0)
[](https://github.com/ellerbrock/open-source-badges/)
# Kubernetes Cluster Backup
Welcome to KubeDR!
## Overview
Kubernetes stores all the cluster data (such as resource specs) in
[etcd](https://etcd.io/). The *KubeDR* project implements data
protection for this data. In addition, certificates can be backed up
as well but that is optional.
**The project is currently in Alpha state and hence is not meant for
production use.**
## Rationale
There are projects and products that backup application data (stored
in *Persistent Volumes*) but there is no project that provides same
first class backup support for the very important Kubernetes cluster
data stored in *etcd*.
For sure, there are recipes on how to take *etcd* snapshot but the
*KubeDR* project from
[Catalogic Software](https://www.catalogicsoftware.com/)
aims to provide complete end to end data protection for Kubernetes
data stored in *etcd*. In addition, this project will backup
certificates as well so if a master needs to be rebuilt, all the data
is available.
## Features
Here is a list of high level features provided by *KubeDR*. For more
details, please see
[User Guide](https://www.catalogicsoftware.com/clab-docs/kubedr/userguide).
- Backup cluster data in *etcd* to any S3 compatible storage.
- Backup certificates
- Pause and resume backups
- Clean up older snapshots based on a retention setting.
- Restore *etcd* snapshot
- Restore certificates
## Roadmap
The following list shows many items that are planned for
*KubeDR*. Some of them are improvements while others are new
features.
- Improve monitoring/reporting.
- Support *Helm* installs.
- Implement referential integrity semantics.
- Improve restore capabilities.
- Support file system as a target for backups.
## Documentation
We use [Sphinx](http://www.sphinx-doc.org/en/master/) for docs. Source
for the documentation is in "docs" directory. For built documentation,
see below:
- [User Guide](https://catalogicsoftware.com/clab-docs/kubedr/userguide)
- [Developer Guide](https://catalogicsoftware.com/clab-docs/kubedr/devguide)
## Feedback
We would love to hear feedback from our users. Please feel free to open
issues for bugs as well as for any feature requests.
For any questions and discussions, please join us over at our Google Group:
[kubedr-discuss](https://groups.google.com/d/forum/kubedr-discuss).
Please note that the project is in Alpha so there may be many
corner cases where things may not work as expected. We are actively
working on fixing any bugs and on adding new features.