2017-11-08 22:33:13 +01:00
|
|
|
.. zrepl documentation master file, created by
|
|
|
|
|
sphinx-quickstart on Wed Nov 8 22:28:10 2017.
|
|
|
|
|
You can adapt this file completely to your liking, but it should at least
|
|
|
|
|
contain the root `toctree` directive.
|
|
|
|
|
|
2017-11-10 14:31:04 +01:00
|
|
|
.. include:: global.rst.inc
|
|
|
|
|
|
2017-11-09 20:33:09 +01:00
|
|
|
zrepl - ZFS replication
|
|
|
|
|
-----------------------
|
2017-11-08 22:33:13 +01:00
|
|
|
|
2017-11-09 20:33:09 +01:00
|
|
|
.. ATTENTION::
|
|
|
|
|
zrepl as well as this documentation is still under active development.
|
|
|
|
|
It is neither feature complete nor is there a stability guarantee on the configuration format.
|
|
|
|
|
Use & test at your own risk ;)
|
|
|
|
|
|
|
|
|
|
Getting started
|
|
|
|
|
~~~~~~~~~~~~~~~
|
|
|
|
|
|
2017-11-09 21:17:09 +01:00
|
|
|
The :ref:`5 minute tutorial setup <tutorial>` gives you a first impression.
|
2017-11-09 20:33:09 +01:00
|
|
|
|
|
|
|
|
Main Features
|
|
|
|
|
~~~~~~~~~~~~~
|
|
|
|
|
|
|
|
|
|
* Filesystem Replication
|
2017-11-09 21:17:09 +01:00
|
|
|
|
|
|
|
|
* [x] Local & Remote
|
|
|
|
|
* [x] Pull mode
|
|
|
|
|
* [ ] Push mode
|
|
|
|
|
* [x] Access control checks when pulling datasets
|
2017-11-10 14:31:04 +01:00
|
|
|
* [x] :ref:`Flexible mapping <pattern-mapping>` rules
|
2017-11-09 21:17:09 +01:00
|
|
|
* [x] Bookmarks support
|
|
|
|
|
* [ ] Feature-negotiation for
|
|
|
|
|
|
|
|
|
|
* Resumable `send & receive`
|
|
|
|
|
* Compressed `send & receive`
|
|
|
|
|
* Raw encrypted `send & receive` (as soon as it is available)
|
|
|
|
|
|
2017-11-09 20:33:09 +01:00
|
|
|
* Automatic snapshot creation
|
2017-11-09 21:17:09 +01:00
|
|
|
|
|
|
|
|
* [x] Ensure fixed time interval between snapshots
|
|
|
|
|
|
2017-11-10 14:31:04 +01:00
|
|
|
* Automatic snapshot :ref:`pruning <prune>`
|
2017-11-09 21:17:09 +01:00
|
|
|
|
|
|
|
|
* [x] Age-based fading (grandfathering scheme)
|
|
|
|
|
|
2017-11-10 14:31:04 +01:00
|
|
|
* Flexible, detailed & structured :ref:`logging <logging>`
|
2017-11-09 21:17:09 +01:00
|
|
|
|
2017-11-10 14:31:04 +01:00
|
|
|
* [x] ``human``, ``logfmt`` and ``json`` formatting
|
2017-11-09 21:17:09 +01:00
|
|
|
* [x] stdout, syslog and TCP (+TLS client auth) outlets
|
|
|
|
|
|
2017-11-09 20:33:09 +01:00
|
|
|
* Maintainable implementation in Go
|
2017-11-09 21:17:09 +01:00
|
|
|
|
|
|
|
|
* [x] Cross platform
|
|
|
|
|
* [x] Type safe & testable code
|
2017-11-08 22:33:13 +01:00
|
|
|
|
2017-11-09 20:33:09 +01:00
|
|
|
Contributing
|
|
|
|
|
~~~~~~~~~~~~
|
2017-11-08 22:33:13 +01:00
|
|
|
|
2017-11-09 20:33:09 +01:00
|
|
|
We are happy about any help we can get!
|
2017-11-08 22:33:13 +01:00
|
|
|
|
2017-11-09 20:33:09 +01:00
|
|
|
* Explore the codebase
|
2017-11-10 14:31:04 +01:00
|
|
|
|
|
|
|
|
* These docs live in the ``docs/`` subdirectory
|
|
|
|
|
|
2017-11-09 20:33:09 +01:00
|
|
|
* Document any non-obvious / confusing / plain broken behavior you encounter when setting up zrepl for the first time
|
|
|
|
|
* Check the *Issues* and *Projects* sections for things to do
|
|
|
|
|
|
2017-11-10 14:31:04 +01:00
|
|
|
.. admonition:: Development Workflow
|
|
|
|
|
:class: note
|
|
|
|
|
|
|
|
|
|
The `GitHub repository <https://github.com/zrepl/zrepl>`_ is where all development happens.
|
|
|
|
|
Make sure to read the `Developer Documentation section <https://github.com/zrepl/zrepl>`_ and open new issues or pull requests there.
|
|
|
|
|
|
2017-11-09 20:33:09 +01:00
|
|
|
|
|
|
|
|
Table of Contents
|
|
|
|
|
~~~~~~~~~~~~~~~~~
|
|
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 2
|
|
|
|
|
:caption: Contents:
|
2017-11-08 22:33:13 +01:00
|
|
|
|
2017-11-09 20:33:09 +01:00
|
|
|
tutorial
|
|
|
|
|
installation
|
|
|
|
|
configuration
|
2017-12-27 17:07:11 +01:00
|
|
|
usage
|
2017-11-09 20:33:09 +01:00
|
|
|
implementation
|
2017-11-12 14:12:57 +01:00
|
|
|
changelog
|
2017-11-12 16:45:11 +01:00
|
|
|
GitHub Repository & Issue Tracker <https://github.com/zrepl/zrepl>
|
2017-11-09 20:33:09 +01:00
|
|
|
pr
|
