extern/zrepl
1
0
Fork 0
mirror of https://github.com/zrepl/zrepl.git synced 2024-12-26 08:58:49 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity
One-stop ZFS backup & replication solution
182 Commits 48 Branches 23 Tags 3.7 MiB
Go 96.6%
Makefile 1.5%
Jupyter Notebook 0.7%
Shell 0.7%
Python 0.3%
0cb5ffb48b
Go to file
Christian Schwarz 0cb5ffb48b more elaborate README
2017-09-24 13:42:04 +02:00
cmd sampleconf for supported logging 2017-09-24 02:10:29 +02:00
docs docs: highlight command for watching replication 2017-09-24 11:03:54 +02:00
jobrun jobrun: use notificationChannel instead of logger for communicating events 2017-09-02 11:08:24 +02:00
logger dump logrus and roll our own logger instead 2017-09-24 00:57:52 +02:00
rpc rpc: re-architect connection teardown 2017-09-11 10:54:56 +02:00
scratchpad scratchpad: repeat: run a command in a certain interval or as soon as it finishes 2017-07-08 12:08:34 +02:00
sshbytestream sshbytestream & IOCommand: fix handling of dead child process 2017-08-09 21:01:06 +02:00
util cmd: logging using logrus 2017-09-22 17:01:54 +02:00
zfs pull log output: optimize to be readable by humans 2017-08-06 18:28:05 +02:00
.gitignore ignore vendor directory 2017-09-24 02:18:22 +02:00
.gitmodules docs: remove GH pages repo as submodule, adjust publish.sh 2017-08-09 21:41:46 +02:00
Gopkg.lock implement logfmt formatter 2017-09-24 02:09:50 +02:00
Gopkg.toml implement logfmt formatter 2017-09-24 02:09:50 +02:00
LICENSE license: change attribution 2017-05-03 18:28:04 +02:00
main.go Switch to using https://github.com/spf13/cobra for CLI. 2017-07-06 13:36:55 +02:00
README.md more elaborate README 2017-09-24 13:42:04 +02:00

README.md

zrepl

zrepl is a ZFS filesystem backup & replication solution written in Go.

User Documentation

User Documentation cab be found at zrepl.github.io.

Bug Reports

  1. If the issue is reproducible, enable debug logging, reproduce and capture the log.
  2. Open an issue on GitHub, with logs pasted as GitHub gists / inline.

Feature Requests

  1. Does you feature request require default values / some kind of configuration? If so, think of an expressive configuration example.
  2. Think of at least one use case that generalizes from your concrete application.
  3. Open an issue on GitHub with example conf & use case attached.

The above does not apply if you already implemented everything. Check out the Coding Workflow section below for details.

Developer Documentation

Overall Architecture

The application architecture is documented as part of the user docs in the Implementation section (docs/content/impl). Make sure to develop an understanding how zrepl is typically used by studying the user docs first.

Project Structure

├── cmd
│   ├── sampleconf          # example configuration
├── docs
│   ├── content             # hugo-based documentation -> sources for ./public_git
│   ├── deploy.sh           # shell script for automated rendering & deploy to zrepl.github.io repo
│   ├── public_git          # used by above shell script
│   └── themes
│       └── docdock         # submodule of our docdock theme fork
├── jobrun                  # OBSOLETE
├── logger                  # logger package used by zrepl
├── rpc                     # rpc protocol implementation
├── scratchpad              # small example programs demoing some internal packages. probably OBSOLETE
├── sshbytestream           # io.ReadWriteCloser over SSH
├── util
└── zfs                     # ZFS wrappers, filesystemm diffing

Coding Workflow

  • Open an issue when starting to hack on a new feature
  • Commits should reference the issue they are related to
  • Docs improvements not documenting new features do not require an issue.