Commit 935141fd authored by Libor Peltan's avatar Libor Peltan Committed by Daniel Salzman

doc: add journal-content and zonefile-load options

parent f9aae574
......@@ -927,8 +927,8 @@ zone:
semantic\-checks: BOOL
disable\-any: BOOL
zonefile\-sync: TIME
zone\-in\-journal: BOOL
ixfr\-from\-differences: BOOL
zonefile\-load: none | difference | whole
journal\-content: none | changes | all
max\-journal\-usage: SIZE
max\-journal\-depth: INT
max\-zone\-size : SIZE
......@@ -1094,43 +1094,40 @@ Otherwise the journal can\(aqt be applied.
.UNINDENT
.sp
\fIDefault:\fP 0 (immediate)
.SS zone\-in\-journal
.SS zonefile\-load
.sp
If enabled, the server stores the zone file contents in journal. When starting server,
the zone is loaded preferably from journal, the changes from zone file are applied
afterwards.
Selects how the zonefile contents are applied during zone load.
.sp
\fBNOTE:\fP
Possible values:
.INDENT 0.0
.INDENT 3.5
Implies \fI\%ixfr\-from\-differences\fP\&.
.UNINDENT
.IP \(bu 2
\fBnone\fP – The zonefile is not used at all.
.IP \(bu 2
\fBdifference\fP – If the zone contents are available during server start or reload,
the difference is computed between them and the zonefile, checked and applied afterwards.
.IP \(bu 2
\fBwhole\fP – Zone contents are loaded from zonefile.
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 0.0
.INDENT 3.5
If you modify the zone file, expecting the changes to be applied to the zone,
you shall set the SOA serial significatnly higher than current zone serial.
.UNINDENT
.UNINDENT
When \fBdifference\fP is configured and there are no zone contents yet (cold start of Knot
and no zone contents in journal), it behaves the same way like \fBwhole\fP\&.
.sp
\fIDefault:\fP off
.SS ixfr\-from\-differences
\fIDefault:\fP whole
.SS journal\-content
.sp
If enabled, the server creates zone differences from changes you made to the
zone file upon server reload. This option is relevant only if the server
is a master server for the zone.
Selects how the journal shall be used to store zone and its changes.
.sp
\fBNOTE:\fP
Possible values:
.INDENT 0.0
.INDENT 3.5
This option has no effect with enabled
\fI\%dnssec\-signing\fP\&.
.UNINDENT
.IP \(bu 2
\fBnone\fP – The journal is not used at all.
.IP \(bu 2
\fBchanges\fP – Zone changes history is stored in journal.
.IP \(bu 2
\fBall\fP – Zone contents and history is stored in journal.
.UNINDENT
.sp
\fIDefault:\fP off
\fIDefault:\fP changes
.SS max\-journal\-usage
.sp
Policy how much space in journal DB will the zone\(aqs journal occupy.
......
......@@ -277,6 +277,10 @@ each other, e.g. periodically changing few zone records, re-signing whole zone..
The diff between zone file and zone is thus preserved, even if journal deletes some
older changesets.
If the journal is used to store both zone history and contents, a special changeset
is present with zone contents. When journal gets full, the changes are merged into this
special changeset.
There is also a :ref:`safety hard limit <template_max-journal-db-size>` for overall
journal database size, but it's strongly recommended to set the per-zone limits in
a way to prevent hitting this one. For LMDB, it's hard to recover from the
......@@ -343,11 +347,6 @@ restarting the server. This can be done with::
$ knotc reload
If you want to enable ixfr differences creation from changes you make to a
zone file, enable :ref:`zone_ixfr-from-differences` in the zone configuration
and reload your server as seen above. If *SOA*'s *serial* is not changed,
no differences will be created.
If you want to refresh the slave zones, you can do this with::
$ knotc zone-refresh
......
......@@ -1062,8 +1062,8 @@ Definition of zones served by the server.
semantic-checks: BOOL
disable-any: BOOL
zonefile-sync: TIME
zone-in-journal: BOOL
ixfr-from-differences: BOOL
zonefile-load: none | difference | whole
journal-content: none | changes | all
max-journal-usage: SIZE
max-journal-depth: INT
max-zone-size : SIZE
......@@ -1236,38 +1236,39 @@ using the ``-f`` option.
*Default:* 0 (immediate)
.. _zone_zone-in-journal:
.. _zone_zonefile-load:
zone-in-journal
---------------
zonefile-load
-------------
If enabled, the server stores the zone file contents in journal. When starting server,
the zone is loaded preferably from journal, the changes from zone file are applied
afterwards.
Selects how the zonefile contents are applied during zone load.
.. NOTE::
Implies :ref:`ixfr-from-differences<zone_ixfr-from-differences>`.
Possible values:
.. WARNING::
If you modify the zone file, expecting the changes to be applied to the zone,
you shall set the SOA serial significatnly higher than current zone serial.
- ``none`` – The zonefile is not used at all.
- ``difference`` – If the zone contents are available during server start or reload,
the difference is computed between them and the zonefile, checked and applied afterwards.
- ``whole`` – Zone contents are loaded from zonefile.
*Default:* off
When ``difference`` is configured and there are no zone contents yet (cold start of Knot
and no zone contents in journal), it behaves the same way like ``whole``.
.. _zone_ixfr-from-differences:
*Default:* whole
ixfr-from-differences
---------------------
.. _zone_journal-content:
If enabled, the server creates zone differences from changes you made to the
zone file upon server reload. This option is relevant only if the server
is a master server for the zone.
journal-content
---------------
.. NOTE::
This option has no effect with enabled
:ref:`dnssec-signing<zone_dnssec-signing>`.
Selects how the journal shall be used to store zone and its changes.
*Default:* off
Possible values:
- ``none`` – The journal is not used at all.
- ``changes`` – Zone changes history is stored in journal.
- ``all`` – Zone contents and history is stored in journal.
*Default:* changes
.. _zone_max-journal-usage:
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment