scribe

README

Scribe

Scribe asynchronously replicates Kubernetes persistent volumes between clusters using either rsync or rclone depending on the number of destinations.

Getting started

Try Scribe in Kind

For a convenient script to start a kind cluster, try this script to setup a kind cluster.

Try Scribe in a Kind, Kubernetes, or Openshift cluster

Follow the steps in the installation instructions. Here are useful commands to configure cluster storage classes.

Scribe kubectl plugin

To try out Scribe with a command line interface scribe:

make scribe
cp bin/kubectl-scribe /usr/local/bin/

NOTE: scribe tool is being actively developed. Options, flags, and names are likely to be updated frequently. PRs and new issues are welcome!

Available commands:

kubectl scribe start-replication
kubectl scribe set-replication
kubectl scribe continue-replication
kubectl scribe remove-replication

• Try the current examples:
  • single cluster cross namespace example
  • multiple cluster example

Helpful links

• Scribe documentation
• Changelog
• Contributing guidelines
• Organization code of conduct

Licensing

This project is licensed under the GNU AGPL 3.0 License with the following exceptions:

• The files within the api/* directories are additionally licensed under Apache License 2.0. This is to permit Scribe'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)