Commit Graph

190 Commits

Author SHA1 Message Date
Christian Schwarz
df181108b4 docs: initial port of hugo to sphinx, including rtd theme 2017-11-11 23:25:12 +01:00
Christian Schwarz
c3af267f48 docs: initial empty sphinx docs directory 2017-11-11 23:25:12 +01:00
Christian Schwarz
a15a73e884 docs: move hugo docs to old directory 2017-11-11 23:25:12 +01:00
Christian Schwarz
ff10a71f3a docs: add warning on replication lag & retention grid. 2017-11-04 13:04:32 +01:00
Christian Schwarz
1f266d02ce docs: tutorial, ssh+stdinserver: mention PermitRootLogin option
fixes #21
2017-10-16 21:58:02 +02:00
Christian Schwarz
4efff312ea docs: bump theme version 2017-10-16 21:55:38 +02:00
Christian Schwarz
0ed5c01473 docs: add talks & presentation page
refs #16
2017-10-05 22:28:43 +02:00
Christian Schwarz
63bc27e6e1 docs: fix new paragraph after zrepl-issue shortcode 2017-10-05 22:16:09 +02:00
Christian Schwarz
e72d274e88 docs: add notice on missing property replication feature
fixes #23
2017-10-05 22:13:05 +02:00
Christian Schwarz
72d288567e mappings: fix aliasing bug with '<' wildcards
In contrast to any 'something<' mapping, a '<' mapping cannot be unique
Thus, '<' mappings are thus just an append to target, which is exactly
what we get when trimming empty prefix ''.

Otherwise, given mapping

{ "<": "storage/backups/app-srv" }

Before (clearly a conflict)
zroot     => storage/backups/app-srv
storage   => storage/backups/app-srv
After:
zroot     => storage/backups/app-srv/zroot
storage   => storage/backups/app-srv/storage

However, mapping directly with subtree wildcard is still possible, just
not with the root wildcard

{
    "<"              "storage/backups/app-srv"
    "zroot/var/db<": "storage/db_replication/app-srv"
}

fixes #22
2017-10-05 20:10:05 +02:00
Christian Schwarz
83d450b1f2 config: support days (d) and weeks (w) in durations
fixes #18
2017-10-05 15:17:37 +02:00
Christian Schwarz
3e647c14c0 config: source job: rename field 'datasets' to 'filesystems'
While filesystems is also not the right term (since it excludes ZVOLs),
we want to stay consistent with comments & terminology used in docs.

BREAK CONFIG

fixes #17
2017-10-05 13:39:05 +02:00
Christian Schwarz
b95260f4b5 config: logging: defaults + definition as list
* Stdout logger as default logger
* Clearer keyword / value separation
* Allows multiple outlet definitions

BREAK CONFIG

fixes #20
fixes #19
2017-10-05 13:31:16 +02:00
Christian Schwarz
2764c95952 docs: update front page with new features & refs 2017-10-03 16:07:21 +02:00
Christian Schwarz
678b4a6f4b docs: update implementation overview 2017-10-03 16:06:58 +02:00
Christian Schwarz
79ab43ebca docs: add docs for logging 2017-10-03 15:41:44 +02:00
Christian Schwarz
a4963cecb7 docs: document job types
The documentation describes intended behavior.

Apparently, there are some bugs regarding *patient* tasks.

refs #8
refs #13
2017-10-03 14:21:10 +02:00
Christian Schwarz
e6d08149ef docs: update 'mappping & filter syntax' + more elaborate sampleconf 2017-10-02 18:29:58 +02:00
Christian Schwarz
ea6f02368b docs: document pruning policies
refs #13
2017-10-02 17:51:28 +02:00
Christian Schwarz
d891b2b119 docs: shortcode for links to the cmd/sampleconf directory
fixes #11
2017-10-02 15:12:35 +02:00
Christian Schwarz
5c6c9485a8 docs: tutorial: clarify identity semantics
* use only one identity file for all connect instructions
* Explain where the argument to stdinserver comes from.

fixes #14
2017-10-02 14:50:28 +02:00
Christian Schwarz
b4d8c93fae docs: transport: document ssh+stdinserver 2017-10-02 14:21:22 +02:00
Christian Schwarz
3f394a8960 docs: tutorial: unambiguous hostnames
s/backups/backup-srv
s/prod1/app-srv

Also fixes wrong hostname in Analysis section.

fixes #15
2017-10-02 13:51:05 +02:00
Christian Schwarz
164f77d80c docs: switch back to patched up relref for links to section pages 2017-10-02 12:42:09 +02:00
Christian Schwarz
40920c4ea5 docs: highlight command for watching replication 2017-09-24 11:03:54 +02:00
Christian Schwarz
4e4bf3dbd8 docs: adjust install page regarding changes to logging. 2017-09-24 11:02:35 +02:00
Christian Schwarz
1c3e4e2f07 docs: install: dep ensure 2017-09-24 10:52:29 +02:00
Christian Schwarz
8dabfe08c7 docs: actually, we support bookmarks 2017-09-24 02:20:13 +02:00
Christian Schwarz
5c7d658143 docs: placeholder for logging + links to sampleconf 2017-09-24 02:14:30 +02:00
Christian Schwarz
bfcba7b281 cmd: logging using logrus 2017-09-22 17:01:54 +02:00
Christian Schwarz
af2ff08940 docs: document UNIX sockets & job debugging 2017-09-18 01:01:51 +02:00
Christian Schwarz
3fd9726719 docs: keep up with changed reality.
ugly hack with relativ URLs because relref is apparently broken when
linking to section pages (_index.md) except for a few cases...
2017-09-17 16:18:39 +02:00
Christian Schwarz
e5b713ce5b docs: pattern syntax: more precise terminology 2017-08-11 18:45:39 +02:00
Christian Schwarz
64baa3915f docs: bump theme 2017-08-11 18:44:53 +02:00
Christian Schwarz
d9064d46f6 docs: improve welcome page 2017-08-09 23:42:50 +02:00
Christian Schwarz
cd9bfbff6c docs: bump theme version 2017-08-09 23:36:39 +02:00
Christian Schwarz
73d586f305 diff: actually fix publish.sh script 2017-08-09 22:05:29 +02:00
Christian Schwarz
9e9f464de7 docs: remove GH pages repo as submodule, adjust publish.sh
Would need to bump zrepl main repo for every publish otherwise...
2017-08-09 21:41:46 +02:00
Christian Schwarz
e2bbd4287e docs: include GH pages repo as submodule 2017-08-09 16:18:13 +02:00
Christian Schwarz
c1e792dc51 docs: initial commit 2017-08-09 16:13:34 +02:00