You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@zookeeper.apache.org by ph...@apache.org on 2017/11/15 20:21:05 UTC
zookeeper git commit: ZOOKEEPER-2690: Update documentation source for
ZOOKEEPER-2574
Repository: zookeeper
Updated Branches:
refs/heads/branch-3.4 91e643417 -> b629cff64
ZOOKEEPER-2690: Update documentation source for ZOOKEEPER-2574
ZOOKEEPER-2690: Update documentation source for ZOOKEEPER-2574
Added the documentation changes from PR https://github.com/apache/zookeeper/pull/111/ to the source (zookeeperAdmin.xml) and generated the new version of the html and pdf documents.
Note: I have not updated the 2nd paragraph from ZOOKEEPER-2574 as change "ZOOKEEPER-2349: Update documentation for snapCount" has a more recent version of that part of the text. (ZOOKEEPER-2349 was committed on Sep 11, 2017 while ZOOKEEPER-2574 was committed on Jan 23, 2017.)
Author: Mark Fenes <mf...@cloudera.com>
Reviewers: phunt@apache.org
Closes #405 from mfenes/ZOOKEEPER-2690_3.4 and squashes the following commits:
a7678f56 [Mark Fenes] ZOOKEEPER-2690: Update documentation source for ZOOKEEPER-2574
ada588bf [Mark Fenes] ZOOKEEPER-2690: Update documentation source for ZOOKEEPER-2574
Change-Id: I3f1f582bf9cb720d18f6bd59467f3e5d08214be9
Project: http://git-wip-us.apache.org/repos/asf/zookeeper/repo
Commit: http://git-wip-us.apache.org/repos/asf/zookeeper/commit/b629cff6
Tree: http://git-wip-us.apache.org/repos/asf/zookeeper/tree/b629cff6
Diff: http://git-wip-us.apache.org/repos/asf/zookeeper/diff/b629cff6
Branch: refs/heads/branch-3.4
Commit: b629cff6499547c28143dcd786fbea98f92e7538
Parents: 91e6434
Author: Mark Fenes <mf...@cloudera.com>
Authored: Wed Nov 15 12:17:00 2017 -0800
Committer: Patrick Hunt <ph...@apache.org>
Committed: Wed Nov 15 12:20:01 2017 -0800
----------------------------------------------------------------------
docs/bookkeeperConfig.pdf | Bin 13797 -> 13797 bytes
docs/bookkeeperOverview.pdf | Bin 147558 -> 147558 bytes
docs/bookkeeperProgrammer.pdf | Bin 24949 -> 24949 bytes
docs/bookkeeperStarted.pdf | Bin 17107 -> 17107 bytes
docs/bookkeeperStream.pdf | Bin 13192 -> 13192 bytes
docs/index.pdf | Bin 13515 -> 13515 bytes
docs/javaExample.pdf | Bin 33767 -> 33767 bytes
docs/linkmap.pdf | Bin 12459 -> 12459 bytes
docs/recipes.pdf | Bin 31021 -> 31021 bytes
docs/zookeeperAdmin.html | 25 +++++++++++++------
docs/zookeeperAdmin.pdf | Bin 81092 -> 82377 bytes
docs/zookeeperHierarchicalQuorums.pdf | Bin 6654 -> 6654 bytes
docs/zookeeperInternals.pdf | Bin 48810 -> 48810 bytes
docs/zookeeperJMX.pdf | Bin 16475 -> 16475 bytes
docs/zookeeperObservers.pdf | Bin 12871 -> 12871 bytes
docs/zookeeperOver.pdf | Bin 302472 -> 302472 bytes
docs/zookeeperProgrammers.pdf | Bin 134099 -> 134099 bytes
docs/zookeeperQuotas.pdf | Bin 11184 -> 11184 bytes
docs/zookeeperStarted.pdf | Bin 28073 -> 28073 bytes
docs/zookeeperTutorial.pdf | Bin 34212 -> 34212 bytes
.../content/xdocs/zookeeperAdmin.xml | 25 +++++++++++++------
21 files changed, 36 insertions(+), 14 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/zookeeper/blob/b629cff6/docs/bookkeeperConfig.pdf
----------------------------------------------------------------------
diff --git a/docs/bookkeeperConfig.pdf b/docs/bookkeeperConfig.pdf
index e8eb350..913d571 100644
Binary files a/docs/bookkeeperConfig.pdf and b/docs/bookkeeperConfig.pdf differ
http://git-wip-us.apache.org/repos/asf/zookeeper/blob/b629cff6/docs/bookkeeperOverview.pdf
----------------------------------------------------------------------
diff --git a/docs/bookkeeperOverview.pdf b/docs/bookkeeperOverview.pdf
index 0b80fc8..aada69e 100644
Binary files a/docs/bookkeeperOverview.pdf and b/docs/bookkeeperOverview.pdf differ
http://git-wip-us.apache.org/repos/asf/zookeeper/blob/b629cff6/docs/bookkeeperProgrammer.pdf
----------------------------------------------------------------------
diff --git a/docs/bookkeeperProgrammer.pdf b/docs/bookkeeperProgrammer.pdf
index 516c44a..886f1e0 100644
Binary files a/docs/bookkeeperProgrammer.pdf and b/docs/bookkeeperProgrammer.pdf differ
http://git-wip-us.apache.org/repos/asf/zookeeper/blob/b629cff6/docs/bookkeeperStarted.pdf
----------------------------------------------------------------------
diff --git a/docs/bookkeeperStarted.pdf b/docs/bookkeeperStarted.pdf
index 546e71e..434f14a 100644
Binary files a/docs/bookkeeperStarted.pdf and b/docs/bookkeeperStarted.pdf differ
http://git-wip-us.apache.org/repos/asf/zookeeper/blob/b629cff6/docs/bookkeeperStream.pdf
----------------------------------------------------------------------
diff --git a/docs/bookkeeperStream.pdf b/docs/bookkeeperStream.pdf
index 6939a99..7747a98 100644
Binary files a/docs/bookkeeperStream.pdf and b/docs/bookkeeperStream.pdf differ
http://git-wip-us.apache.org/repos/asf/zookeeper/blob/b629cff6/docs/index.pdf
----------------------------------------------------------------------
diff --git a/docs/index.pdf b/docs/index.pdf
index 78db924..e9eee84 100644
Binary files a/docs/index.pdf and b/docs/index.pdf differ
http://git-wip-us.apache.org/repos/asf/zookeeper/blob/b629cff6/docs/javaExample.pdf
----------------------------------------------------------------------
diff --git a/docs/javaExample.pdf b/docs/javaExample.pdf
index e5d45a4..14a53de 100644
Binary files a/docs/javaExample.pdf and b/docs/javaExample.pdf differ
http://git-wip-us.apache.org/repos/asf/zookeeper/blob/b629cff6/docs/linkmap.pdf
----------------------------------------------------------------------
diff --git a/docs/linkmap.pdf b/docs/linkmap.pdf
index 5c8c5fb..c9805a9 100644
Binary files a/docs/linkmap.pdf and b/docs/linkmap.pdf differ
http://git-wip-us.apache.org/repos/asf/zookeeper/blob/b629cff6/docs/recipes.pdf
----------------------------------------------------------------------
diff --git a/docs/recipes.pdf b/docs/recipes.pdf
index 350e677..f0b07f8 100644
Binary files a/docs/recipes.pdf and b/docs/recipes.pdf differ
http://git-wip-us.apache.org/repos/asf/zookeeper/blob/b629cff6/docs/zookeeperAdmin.html
----------------------------------------------------------------------
diff --git a/docs/zookeeperAdmin.html b/docs/zookeeperAdmin.html
index 8171503..f8166f9 100644
--- a/docs/zookeeperAdmin.html
+++ b/docs/zookeeperAdmin.html
@@ -934,10 +934,14 @@ server.3=zoo3:2888:3888</pre>
of the znodes stored by a particular serving ensemble. These
are the snapshot and transactional log files. As changes are
made to the znodes these changes are appended to a
- transaction log, occasionally, when a log grows large, a
+ transaction log. Occasionally, when a log grows large, a
snapshot of the current state of all znodes will be written
- to the filesystem. This snapshot supercedes all previous
- logs.
+ to the filesystem and a new transaction log file is created
+ for future transactions. During snapshotting, ZooKeeper may
+ continue appending incoming transactions to the old log file.
+ Therefore, some transactions which are newer than a snapshot
+ may be found in the last transaction log preceding the
+ snapshot.
</p>
<p>A ZooKeeper server <strong>will not remove
old snapshots and log files</strong> when using the default
@@ -2018,8 +2022,11 @@ imok
<p>The Log Directory contains the ZooKeeper transaction logs.
Before any update takes place, ZooKeeper ensures that the transaction
that represents the update is written to non-volatile storage. A new
- log file is started each time a snapshot is begun. The log file's
- suffix is the first zxid written to that log.</p>
+ log file is started when the number of transactions written to the
+ current log file reaches a (variable) threshold. The threshold is
+ computed using the same parameter which influences the frequency of
+ snapshotting (see snapCount above). The log file's suffix is the first
+ zxid written to that log.</p>
<a name="sc_filemanagement"></a>
<h4>File Management</h4>
<p>The format of snapshot and log files does not change between
@@ -2034,8 +2041,12 @@ imok
<p>The ZooKeeper server creates snapshot and log files, but
never deletes them. The retention policy of the data and log
files is implemented outside of the ZooKeeper server. The
- server itself only needs the latest complete fuzzy snapshot
- and the log files from the start of that snapshot. See the
+ server itself only needs the latest complete fuzzy snapshot, all log
+ files following it, and the last log file preceding it. The latter
+ requirement is necessary to include updates which happened after this
+ snapshot was started but went into the existing log file at that time.
+ This is possible because snapshotting and rolling over of logs
+ proceed somewhat independently in ZooKeeper. See the
<a href="#sc_maintenance">maintenance</a> section in
this document for more details on setting a retention policy
and maintenance of ZooKeeper storage.
http://git-wip-us.apache.org/repos/asf/zookeeper/blob/b629cff6/docs/zookeeperAdmin.pdf
----------------------------------------------------------------------
diff --git a/docs/zookeeperAdmin.pdf b/docs/zookeeperAdmin.pdf
index 9c314b6..cb90aec 100644
Binary files a/docs/zookeeperAdmin.pdf and b/docs/zookeeperAdmin.pdf differ
http://git-wip-us.apache.org/repos/asf/zookeeper/blob/b629cff6/docs/zookeeperHierarchicalQuorums.pdf
----------------------------------------------------------------------
diff --git a/docs/zookeeperHierarchicalQuorums.pdf b/docs/zookeeperHierarchicalQuorums.pdf
index 4e1214f..5bf71cc 100644
Binary files a/docs/zookeeperHierarchicalQuorums.pdf and b/docs/zookeeperHierarchicalQuorums.pdf differ
http://git-wip-us.apache.org/repos/asf/zookeeper/blob/b629cff6/docs/zookeeperInternals.pdf
----------------------------------------------------------------------
diff --git a/docs/zookeeperInternals.pdf b/docs/zookeeperInternals.pdf
index f33b0b3..08da38d 100644
Binary files a/docs/zookeeperInternals.pdf and b/docs/zookeeperInternals.pdf differ
http://git-wip-us.apache.org/repos/asf/zookeeper/blob/b629cff6/docs/zookeeperJMX.pdf
----------------------------------------------------------------------
diff --git a/docs/zookeeperJMX.pdf b/docs/zookeeperJMX.pdf
index a713485..a382369 100644
Binary files a/docs/zookeeperJMX.pdf and b/docs/zookeeperJMX.pdf differ
http://git-wip-us.apache.org/repos/asf/zookeeper/blob/b629cff6/docs/zookeeperObservers.pdf
----------------------------------------------------------------------
diff --git a/docs/zookeeperObservers.pdf b/docs/zookeeperObservers.pdf
index d85af6a..53bf383 100644
Binary files a/docs/zookeeperObservers.pdf and b/docs/zookeeperObservers.pdf differ
http://git-wip-us.apache.org/repos/asf/zookeeper/blob/b629cff6/docs/zookeeperOver.pdf
----------------------------------------------------------------------
diff --git a/docs/zookeeperOver.pdf b/docs/zookeeperOver.pdf
index 0a9d86a..d44ffd6 100644
Binary files a/docs/zookeeperOver.pdf and b/docs/zookeeperOver.pdf differ
http://git-wip-us.apache.org/repos/asf/zookeeper/blob/b629cff6/docs/zookeeperProgrammers.pdf
----------------------------------------------------------------------
diff --git a/docs/zookeeperProgrammers.pdf b/docs/zookeeperProgrammers.pdf
index 78aac51..ec81595 100644
Binary files a/docs/zookeeperProgrammers.pdf and b/docs/zookeeperProgrammers.pdf differ
http://git-wip-us.apache.org/repos/asf/zookeeper/blob/b629cff6/docs/zookeeperQuotas.pdf
----------------------------------------------------------------------
diff --git a/docs/zookeeperQuotas.pdf b/docs/zookeeperQuotas.pdf
index fcee913..94db24b 100644
Binary files a/docs/zookeeperQuotas.pdf and b/docs/zookeeperQuotas.pdf differ
http://git-wip-us.apache.org/repos/asf/zookeeper/blob/b629cff6/docs/zookeeperStarted.pdf
----------------------------------------------------------------------
diff --git a/docs/zookeeperStarted.pdf b/docs/zookeeperStarted.pdf
index b11d0cc..75203cf 100644
Binary files a/docs/zookeeperStarted.pdf and b/docs/zookeeperStarted.pdf differ
http://git-wip-us.apache.org/repos/asf/zookeeper/blob/b629cff6/docs/zookeeperTutorial.pdf
----------------------------------------------------------------------
diff --git a/docs/zookeeperTutorial.pdf b/docs/zookeeperTutorial.pdf
index 22450cf..a2d10da 100644
Binary files a/docs/zookeeperTutorial.pdf and b/docs/zookeeperTutorial.pdf differ
http://git-wip-us.apache.org/repos/asf/zookeeper/blob/b629cff6/src/docs/src/documentation/content/xdocs/zookeeperAdmin.xml
----------------------------------------------------------------------
diff --git a/src/docs/src/documentation/content/xdocs/zookeeperAdmin.xml b/src/docs/src/documentation/content/xdocs/zookeeperAdmin.xml
index 3f9051a..447b90c 100644
--- a/src/docs/src/documentation/content/xdocs/zookeeperAdmin.xml
+++ b/src/docs/src/documentation/content/xdocs/zookeeperAdmin.xml
@@ -511,10 +511,14 @@ server.3=zoo3:2888:3888</programlisting>
of the znodes stored by a particular serving ensemble. These
are the snapshot and transactional log files. As changes are
made to the znodes these changes are appended to a
- transaction log, occasionally, when a log grows large, a
+ transaction log. Occasionally, when a log grows large, a
snapshot of the current state of all znodes will be written
- to the filesystem. This snapshot supercedes all previous
- logs.
+ to the filesystem and a new transaction log file is created
+ for future transactions. During snapshotting, ZooKeeper may
+ continue appending incoming transactions to the old log file.
+ Therefore, some transactions which are newer than a snapshot
+ may be found in the last transaction log preceding the
+ snapshot.
</para>
<para>A ZooKeeper server <emphasis role="bold">will not remove
@@ -1656,8 +1660,11 @@ imok
<para>The Log Directory contains the ZooKeeper transaction logs.
Before any update takes place, ZooKeeper ensures that the transaction
that represents the update is written to non-volatile storage. A new
- log file is started each time a snapshot is begun. The log file's
- suffix is the first zxid written to that log.</para>
+ log file is started when the number of transactions written to the
+ current log file reaches a (variable) threshold. The threshold is
+ computed using the same parameter which influences the frequency of
+ snapshotting (see snapCount above). The log file's suffix is the first
+ zxid written to that log.</para>
</section>
<section id="sc_filemanagement">
@@ -1677,8 +1684,12 @@ imok
<para>The ZooKeeper server creates snapshot and log files, but
never deletes them. The retention policy of the data and log
files is implemented outside of the ZooKeeper server. The
- server itself only needs the latest complete fuzzy snapshot
- and the log files from the start of that snapshot. See the
+ server itself only needs the latest complete fuzzy snapshot, all log
+ files following it, and the last log file preceding it. The latter
+ requirement is necessary to include updates which happened after this
+ snapshot was started but went into the existing log file at that time.
+ This is possible because snapshotting and rolling over of logs
+ proceed somewhat independently in ZooKeeper. See the
<ulink url="#sc_maintenance">maintenance</ulink> section in
this document for more details on setting a retention policy
and maintenance of ZooKeeper storage.