-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathindex.html
More file actions
325 lines (307 loc) · 19.9 KB
/
index.html
File metadata and controls
325 lines (307 loc) · 19.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>zrepl - ZFS replication — zrepl latest documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/banner.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=c6e86fd7"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Quick Start by Use Case" href="quickstart.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="#" class="icon icon-home">
zrepl
<img src="_static/zrepl.svg" class="logo" alt="Logo"/>
</a>
<div class="version">
latest
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="quickstart.html">Quick Start by Use Case</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="configuration.html">Configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="usage.html">Usage</a></li>
<li class="toctree-l1"><a class="reference internal" href="pr.html">Talks & Presentations</a></li>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a></li>
<li class="toctree-l1"><a class="reference internal" href="future.html">Future</a></li>
<li class="toctree-l1"><a class="reference external" href="https://github.com/zrepl/zrepl">GitHub Repository & Issue Tracker</a></li>
<li class="toctree-l1"><a class="reference external" href="https://matrix.to/#/#zrepl:matrix.org">Chat: Matrix</a></li>
<li class="toctree-l1"><a class="reference internal" href="supporters.html">Supporters</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="#">zrepl</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="#" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">zrepl - ZFS replication</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/zrepl/zrepl/blob/master/docs/index.rst" class="fa fa-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<p><a class="reference external" href="https://github.com/zrepl/zrepl/blob/master/LICENSE"><img alt="GitHub license" src="https://img.shields.io/github/license/zrepl/zrepl.svg" /></a> <a class="reference external" href="https://golang.org/"><img alt="Language: Go" src="https://img.shields.io/badge/lang-Go-6ad7e5.svg" /></a> <a class="reference external" href="https://twitter.com/intent/tweet?text=Wow:&url=https%3A%2F%2Fgithub.com%2Fzrepl%2Fzrepl"><img alt="Twitter" src="https://img.shields.io/twitter/url/https/github.com/zrepl/zrepl.svg?style=social" /></a> <a class="reference external" href="https://www.patreon.com/zrepl"><img alt="Donate via Patreon" src="https://img.shields.io/badge/dynamic/json?color=yellow&label=Patreon&query=data.attributes.patron_count&url=https%3A%2F%2Fwww.patreon.com%2Fapi%2Fcampaigns%2F3095079" /></a> <a class="reference external" href="https://github.com/sponsors/problame"><img alt="Donate via GitHub Sponsors" src="https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub&style=flat&color=yellow" /></a> <a class="reference external" href="https://liberapay.com/zrepl/donate"><img alt="Donate via Liberapay" src="https://img.shields.io/liberapay/patrons/zrepl.svg?logo=liberapay" /></a> <a class="reference external" href="https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=R5QSXJVYHGX96"><img alt="Donate via PayPal" src="https://img.shields.io/badge/donate-paypal-yellow.svg" /></a> <a class="reference external" href="https://matrix.to/#/#zrepl:matrix.org"><img alt="Matrix" src="https://img.shields.io/badge/chat-matrix-blue.svg" /></a></p>
<section id="zrepl-zfs-replication">
<h1>zrepl - ZFS replication<a class="headerlink" href="#zrepl-zfs-replication" title="Link to this heading"></a></h1>
<p><strong>zrepl</strong> is a one-stop, integrated solution for ZFS replication.</p>
<div style="margin-bottom: 1em; background: #2e3436; color: white; font-size: 0.8em; min-height: 6em; max-width: 100%; overflow: auto;">
<pre>
Job: prod_to_backups
Type: push
Replication:
Attempt #1
Status: fan-out-filesystems
Progress: [=========================\----] 246.7 MiB / 264.7 MiB @ 11.5 MiB/s
zroot STEPPING (step 1/2, 624 B/1.2 KiB) next: @a => @b
zroot/ROOT DONE (step 2/2, 1.2 KiB/1.2 KiB)
* zroot/ROOT/default STEPPING (step 1/2, 123.4 MiB/129.3 MiB) next: @a => @b
zroot/tmp STEPPING (step 1/2, 29.9 KiB/44.2 KiB) next: @a => @b
zroot/usr STEPPING (step 1/2, 624 B/1.2 KiB) next: @a => @b
* zroot/usr/home STEPPING (step 1/2, 123.3 MiB/135.3 MiB) next: @a => @b
zroot/var STEPPING (step 1/2, 624 B/1.2 KiB) next: @a => @b
zroot/var/audit DONE (step 2/2, 1.2 KiB/1.2 KiB)
zroot/var/crash DONE (step 2/2, 1.2 KiB/1.2 KiB)
zroot/var/log STEPPING (step 1/2, 22.0 KiB/29.2 KiB) next: @a => @b
zroot/var/mail STEPPING (step 1/2, 624 B/1.2 KiB) next: @a => @b
Pruning Sender:
...
Pruning Receiver:
</pre>
</div><section id="getting-started">
<h2>Getting started<a class="headerlink" href="#getting-started" title="Link to this heading"></a></h2>
<p>The <a class="reference internal" href="quickstart.html#quickstart-toc"><span class="std std-ref">10 minute quick-start guides</span></a> give you a first impression.</p>
</section>
<section id="main-features">
<h2>Main Features<a class="headerlink" href="#main-features" title="Link to this heading"></a></h2>
<ul class="simple">
<li><p><strong>Filesystem replication</strong></p>
<ul>
<li><p>[x] Pull & Push mode</p></li>
<li><p>[x] Multiple <a class="reference internal" href="configuration/transports.html#transport"><span class="std std-ref">transport modes</span></a>: TCP, TCP + TLS client auth, SSH</p></li>
<li><p>Advanced replication features</p>
<ul>
<li><p>[x] Automatic retries for temporary network errors</p></li>
<li><p>[x] Automatic resumable send & receive</p></li>
<li><p>[x] Automatic ZFS holds during send & receive</p></li>
<li><p>[x] Automatic bookmark & hold management for guaranteed incremental send & recv</p></li>
<li><p>[x] Encrypted raw send & receive to untrusted receivers (OpenZFS native encryption)</p></li>
<li><p>[x] Properties send & receive</p></li>
<li><p>[x] Compressed send & receive</p></li>
<li><p>[x] Large blocks send & receive</p></li>
<li><p>[x] Embedded data send & receive</p></li>
<li><p>[x] Resume state send & receive</p></li>
<li><p>[x] Bandwidth limiting</p></li>
</ul>
</li>
</ul>
</li>
<li><p><strong>Automatic snapshot management</strong></p>
<ul>
<li><p>[x] Periodic <a class="reference internal" href="configuration/snapshotting.html#job-snapshotting-spec"><span class="std std-ref">filesystem snapshots</span></a></p></li>
<li><p>[x] Support for <a class="reference internal" href="configuration/snapshotting.html#job-snapshotting-hooks"><span class="std std-ref">pre- and post-snapshot hooks</span></a> with builtins for MySQL & Postgres</p></li>
<li><p>[x] Flexible <a class="reference internal" href="configuration/prune.html#prune"><span class="std std-ref">pruning rule system</span></a></p>
<ul>
<li><p>[x] Age-based fading (grandfathering scheme)</p></li>
<li><p>[x] Bookmarks to avoid divergence between sender and receiver</p></li>
</ul>
</li>
</ul>
</li>
<li><p><strong>Sophisticated Monitoring & Logging</strong></p>
<ul>
<li><p>[x] Live progress reporting via <cite>zrepl status</cite> <a class="reference internal" href="usage.html#usage"><span class="std std-ref">subcommand</span></a></p></li>
<li><p>[x] Comprehensive, structured <a class="reference internal" href="configuration/logging.html#logging"><span class="std std-ref">logging</span></a></p>
<ul>
<li><p><code class="docutils literal notranslate"><span class="pre">human</span></code>, <code class="docutils literal notranslate"><span class="pre">logfmt</span></code> and <code class="docutils literal notranslate"><span class="pre">json</span></code> formatting</p></li>
<li><p>stdout, syslog and TCP (+TLS client auth) outlets</p></li>
</ul>
</li>
<li><p>[x] Prometheus <a class="reference internal" href="configuration/monitoring.html#monitoring"><span class="std std-ref">monitoring</span></a> endpoint</p></li>
</ul>
</li>
<li><p><strong>Maintainable implementation in Go</strong></p>
<ul>
<li><p>[x] Cross platform</p></li>
<li><p>[x] Dynamic feature checking</p></li>
<li><p>[x] Type safe & testable code</p></li>
</ul>
</li>
</ul>
<div class="admonition attention">
<p class="admonition-title">Attention</p>
<p>zrepl as well as this documentation is still under active development.
There is no stability guarantee on the RPC protocol or configuration format,
but we do our best to document breaking changes in the <a class="reference internal" href="changelog.html#changelog"><span class="std std-ref">Changelog</span></a>.</p>
</div>
</section>
<section id="contributing">
<h2>Contributing<a class="headerlink" href="#contributing" title="Link to this heading"></a></h2>
<p>We are happy about any help we can get!</p>
<ul class="simple">
<li><p><a class="reference internal" href="supporters.html#supporters"><span class="std std-ref">Financial Support</span></a></p></li>
<li><p>Explore the codebase</p>
<ul>
<li><p>These docs live in the <code class="docutils literal notranslate"><span class="pre">docs/</span></code> subdirectory</p></li>
</ul>
</li>
<li><p>Document any non-obvious / confusing / plain broken behavior you encounter when setting up zrepl for the first time</p></li>
<li><p>Check the <em>Issues</em> and <em>Projects</em> sections for things to do.
The <a class="reference external" href="https://github.com/zrepl/zrepl/labels/good%20first%20issue">good first issues</a> and <a class="reference external" href="https://github.com/zrepl/zrepl/labels/docs">docs</a> are suitable starting points.</p></li>
</ul>
<div class="note admonition">
<p class="admonition-title">Development Workflow</p>
<p>The <a class="reference external" href="https://github.com/zrepl/zrepl">GitHub repository</a> is where all development happens.
Make sure to read the <a class="reference external" href="https://github.com/zrepl/zrepl">Developer Documentation section</a> and open new issues or pull requests there.</p>
</div>
</section>
<section id="table-of-contents">
<h2>Table of Contents<a class="headerlink" href="#table-of-contents" title="Link to this heading"></a></h2>
<div class="toctree-wrapper compound">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="quickstart.html">Quick Start by Use Case</a><ul>
<li class="toctree-l2"><a class="reference internal" href="quickstart.html#install-zrepl">Install zrepl</a></li>
<li class="toctree-l2"><a class="reference internal" href="quickstart.html#overview-of-how-zrepl-works">Overview Of How zrepl Works</a></li>
<li class="toctree-l2"><a class="reference internal" href="quickstart.html#configuration-examples">Configuration Examples</a></li>
<li class="toctree-l2"><a class="reference internal" href="quickstart.html#apply-configuration-changes">Apply Configuration Changes</a></li>
<li class="toctree-l2"><a class="reference internal" href="quickstart.html#watch-it-work">Watch it Work</a></li>
<li class="toctree-l2"><a class="reference internal" href="quickstart.html#what-next">What Next?</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="installation/packages.html">Packages</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation/apt-repos.html">Debian / Ubuntu APT repositories</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation/rpm-repos.html">RPM repositories</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation/user-privileges.html">User Privileges</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation/freebsd-jail-with-iocage.html">FreeBSD Jail With iocage</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation/what-next.html">What next?</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="configuration.html">Configuration</a><ul>
<li class="toctree-l2"><a class="reference internal" href="configuration/overview.html">Overview & Terminology</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration/jobs.html">Job Types in Detail</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration/transports.html">Transports</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration/filter_syntax.html">Filter Syntax</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration/sendrecvoptions.html">Send & Recv Options</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration/replication.html">Replication Options</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration/conflict_resolution.html">Conflict Resolution Options</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration/snapshotting.html">Taking Snaphots</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration/prune.html">Pruning Policies</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration/logging.html">Logging</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration/monitoring.html">Monitoring</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration/misc.html">Miscellaneous</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="usage.html">Usage</a><ul>
<li class="toctree-l2"><a class="reference internal" href="usage.html#cli-overview">CLI Overview</a></li>
<li class="toctree-l2"><a class="reference internal" href="usage.html#zrepl-daemon">zrepl daemon</a></li>
<li class="toctree-l2"><a class="reference internal" href="usage.html#ops-runbooks">Ops Runbooks</a></li>
<li class="toctree-l2"><a class="reference internal" href="usage.html#platform-tests">Platform Tests</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="pr.html">Talks & Presentations</a></li>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a><ul>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id2">0.7.0</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id4">0.6.1</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id5">0.6</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id6">0.5</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id7">0.4.0</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id8">0.3.1</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#release-0-3">0.3</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id10">0.2.1</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id11">0.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id12">0.1.1</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id13">0.1</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#previous-releases">Previous Releases</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="future.html">Future</a></li>
<li class="toctree-l1"><a class="reference external" href="https://github.com/zrepl/zrepl">GitHub Repository & Issue Tracker</a></li>
<li class="toctree-l1"><a class="reference external" href="https://matrix.to/#/#zrepl:matrix.org">Chat: Matrix</a></li>
<li class="toctree-l1"><a class="reference internal" href="supporters.html">Supporters</a></li>
</ul>
</div>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="quickstart.html" class="btn btn-neutral float-right" title="Quick Start by Use Case" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright 2017-2026, Christian Schwarz.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span class="fa fa-book"> Other Versions</span>
v: latest
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
<dl>
<dt>Releases</dt>
<dd><a href="https://github.com/zrepl/zrepl/releases/tag/v0.7.0">v0.7.0</a></dd>
<dd><a href="https://github.com/zrepl/zrepl/releases/tag/v0.6.1">v0.6.1</a></dd>
<dd><a href="https://github.com/zrepl/zrepl/releases/tag/v0.5.0">v0.5.0</a></dd>
<dd><a href="https://github.com/zrepl/zrepl/releases/tag/v0.4.0">v0.4.0</a></dd>
<dd><a href="https://github.com/zrepl/zrepl/releases">All releases...</a></dd>
</dl>
<dl>
<dt>Note</dt>
<dd style="white-space: normal;">
Release-specific docs are in the
<span style="font-family: monospace;">zrepl-noarch.tar</span>
asset on each GitHub release.
</dd>
</dl>
</div>
</div><script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>