https://github.com/backube/volsync

Asynchronous data replication for Kubernetes volumes
https://github.com/backube/volsync

csi data-migration data-protection data-replication disaster-recovery kubernetes kubernetes-operator mirroring persistent-volume storage

Last synced: 11 days ago
JSON representation

Asynchronous data replication for Kubernetes volumes

• Host: GitHub
• URL: https://github.com/backube/volsync
• Owner: backube
• License: agpl-3.0
• Created: 2021-07-29T12:32:00.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2025-04-09T20:26:45.000Z (13 days ago)
• Last Synced: 2025-04-09T21:32:42.990Z (13 days ago)
• Topics: csi, data-migration, data-protection, data-replication, disaster-recovery, kubernetes, kubernetes-operator, mirroring, persistent-volume, storage
• Language: Go
• Homepage: https://volsync.readthedocs.io
• Size: 20.6 MB
• Stars: 733
• Watchers: 12
• Forks: 72
• Open Issues: 92
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-restic - volsync - Asynchronous data replication for Kubernetes volumes (Other)

README

        
# VolSync

VolSync asynchronously replicates Kubernetes persistent volumes between clusters

using either [rsync](https://rsync.samba.org/) or [rclone](https://rclone.org/).

It also supports creating backups of persistent volumes via

[restic](https://restic.net/).

[![Documentation

Status](https://readthedocs.org/projects/volsync/badge/?version=latest)](https://volsync.readthedocs.io/en/latest/?badge=latest)

[![Go Report

Card](https://goreportcard.com/badge/github.com/backube/volsync)](https://goreportcard.com/report/github.com/backube/volsync)

[![codecov](https://codecov.io/gh/backube/volsync/branch/main/graph/badge.svg)](https://codecov.io/gh/backube/volsync)

![maturity](https://img.shields.io/static/v1?label=maturity&message=alpha&color=red)

![Documentation](https://github.com/backube/volsync/workflows/Documentation/badge.svg)

![operator](https://github.com/backube/volsync/workflows/operator/badge.svg)

## Getting started

The fastest way to get started is to install VolSync in a [kind

cluster](https://kind.sigs.k8s.io/):

* Install kind if you don't already have it:  

  `$ go install sigs.k8s.io/kind@latest`

* Use our convenient script to start a cluster, install the CSI hostpath driver,

  and the snapshot controller.  

  `$ ./hack/setup-kind-cluster.sh`

* Install the latest release via [Helm](https://helm.sh/)  

  `$ helm repo add backube https://backube.github.io/helm-charts/`  

  `$ helm install --create-namespace -n volsync-system volsync backube/volsync`

* See the [usage

  instructions](https://volsync.readthedocs.io/en/stable/usage/index.html) for

  information on setting up replication relationships.

More detailed information on installation and usage can be found in the

[official documentation](https://volsync.readthedocs.io/).

## Helpful links

* [VolSync documentation](https://volsync.readthedocs.io)

* [Changelog](CHANGELOG.md)

* [Contributing guidelines](https://github.com/backube/.github/blob/master/CONTRIBUTING.md)

* [Organization code of conduct](https://github.com/backube/.github/blob/master/CODE_OF_CONDUCT.md)

## Licensing

This project is licensed under the [GNU AGPL 3.0 License](LICENSE) with the following

exceptions:

* The files within the `api/*` directories are additionally licensed under

  Apache License 2.0. This is to permit VolSync's CustomResource types to be used

  by a wider range of software.

* Documentation is made available under the [Creative Commons

  Attribution-ShareAlike 4.0 International license (CC BY-SA

  4.0)](https://creativecommons.org/licenses/by-sa/4.0/)