zookeeper-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ph...@apache.org
Subject zookeeper git commit: ZOOKEEPER-2690: Update documentation source for ZOOKEEPER-2574
Date Wed, 15 Nov 2017 20:24:31 GMT
Repository: zookeeper
Updated Branches:
  refs/heads/branch-3.5 cb7bd95b0 -> 854f7e604


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 <mfenes@cloudera.com>

Reviewers: phunt@apache.org

Closes #404 from mfenes/ZOOKEEPER-2690 and squashes the following commits:

87c53567 [Mark Fenes] ZOOKEEPER-2690: Update documentation source for ZOOKEEPER-2574
0cb32196 [Mark Fenes] ZOOKEEPER-2690: Update documentation source for ZOOKEEPER-2574

Change-Id: I5f0d19007fc97ea488d274cb6ba21c0021aef43e


Project: http://git-wip-us.apache.org/repos/asf/zookeeper/repo
Commit: http://git-wip-us.apache.org/repos/asf/zookeeper/commit/854f7e60
Tree: http://git-wip-us.apache.org/repos/asf/zookeeper/tree/854f7e60
Diff: http://git-wip-us.apache.org/repos/asf/zookeeper/diff/854f7e60

Branch: refs/heads/branch-3.5
Commit: 854f7e604fa9e8288baa78b9f009da5e25e21b56
Parents: cb7bd95
Author: Mark Fenes <mfenes@cloudera.com>
Authored: Wed Nov 15 12:22:49 2017 -0800
Committer: Patrick Hunt <phunt@apache.org>
Committed: Wed Nov 15 12:23:58 2017 -0800

----------------------------------------------------------------------
 docs/index.pdf                                  | Bin 12657 -> 12657 bytes
 docs/javaExample.pdf                            | Bin 33818 -> 33818 bytes
 docs/linkmap.pdf                                | Bin 10826 -> 10826 bytes
 docs/recipes.pdf                                | Bin 33856 -> 33856 bytes
 docs/zookeeperAdmin.html                        |  25 +++++++++++++------
 docs/zookeeperAdmin.pdf                         | Bin 96641 -> 97035 bytes
 docs/zookeeperHierarchicalQuorums.pdf           | Bin 6654 -> 6654 bytes
 docs/zookeeperInternals.pdf                     | Bin 48811 -> 48811 bytes
 docs/zookeeperJMX.pdf                           | Bin 16475 -> 16475 bytes
 docs/zookeeperObservers.pdf                     | Bin 12868 -> 12868 bytes
 docs/zookeeperOver.pdf                          | Bin 302467 -> 302467 bytes
 docs/zookeeperProgrammers.pdf                   | Bin 143745 -> 143745 bytes
 docs/zookeeperQuotas.pdf                        | Bin 11184 -> 11184 bytes
 docs/zookeeperReconfig.pdf                      | Bin 62416 -> 62416 bytes
 docs/zookeeperStarted.pdf                       | Bin 28078 -> 28078 bytes
 docs/zookeeperTutorial.pdf                      | Bin 34212 -> 34212 bytes
 .../content/xdocs/zookeeperAdmin.xml            |  25 +++++++++++++------
 17 files changed, 36 insertions(+), 14 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/zookeeper/blob/854f7e60/docs/index.pdf
----------------------------------------------------------------------
diff --git a/docs/index.pdf b/docs/index.pdf
index 270df1a..952f622 100644
Binary files a/docs/index.pdf and b/docs/index.pdf differ

http://git-wip-us.apache.org/repos/asf/zookeeper/blob/854f7e60/docs/javaExample.pdf
----------------------------------------------------------------------
diff --git a/docs/javaExample.pdf b/docs/javaExample.pdf
index e45b210..68fde10 100644
Binary files a/docs/javaExample.pdf and b/docs/javaExample.pdf differ

http://git-wip-us.apache.org/repos/asf/zookeeper/blob/854f7e60/docs/linkmap.pdf
----------------------------------------------------------------------
diff --git a/docs/linkmap.pdf b/docs/linkmap.pdf
index 2e70a13..6a4e006 100644
Binary files a/docs/linkmap.pdf and b/docs/linkmap.pdf differ

http://git-wip-us.apache.org/repos/asf/zookeeper/blob/854f7e60/docs/recipes.pdf
----------------------------------------------------------------------
diff --git a/docs/recipes.pdf b/docs/recipes.pdf
index ec2f44f..43e9ec7 100644
Binary files a/docs/recipes.pdf and b/docs/recipes.pdf differ

http://git-wip-us.apache.org/repos/asf/zookeeper/blob/854f7e60/docs/zookeeperAdmin.html
----------------------------------------------------------------------
diff --git a/docs/zookeeperAdmin.html b/docs/zookeeperAdmin.html
index a457cc7..d3f0080 100644
--- a/docs/zookeeperAdmin.html
+++ b/docs/zookeeperAdmin.html
@@ -940,10 +940,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
@@ -2420,8 +2424,11 @@ server.3=zoo3:2888:3888</pre>
 <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
@@ -2436,8 +2443,12 @@ server.3=zoo3:2888:3888</pre>
 <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/854f7e60/docs/zookeeperAdmin.pdf
----------------------------------------------------------------------
diff --git a/docs/zookeeperAdmin.pdf b/docs/zookeeperAdmin.pdf
index 7f63f98..55e6a4a 100644
Binary files a/docs/zookeeperAdmin.pdf and b/docs/zookeeperAdmin.pdf differ

http://git-wip-us.apache.org/repos/asf/zookeeper/blob/854f7e60/docs/zookeeperHierarchicalQuorums.pdf
----------------------------------------------------------------------
diff --git a/docs/zookeeperHierarchicalQuorums.pdf b/docs/zookeeperHierarchicalQuorums.pdf
index 37e4e51..c95a0d0 100644
Binary files a/docs/zookeeperHierarchicalQuorums.pdf and b/docs/zookeeperHierarchicalQuorums.pdf
differ

http://git-wip-us.apache.org/repos/asf/zookeeper/blob/854f7e60/docs/zookeeperInternals.pdf
----------------------------------------------------------------------
diff --git a/docs/zookeeperInternals.pdf b/docs/zookeeperInternals.pdf
index edd416c..3ba7ade 100644
Binary files a/docs/zookeeperInternals.pdf and b/docs/zookeeperInternals.pdf differ

http://git-wip-us.apache.org/repos/asf/zookeeper/blob/854f7e60/docs/zookeeperJMX.pdf
----------------------------------------------------------------------
diff --git a/docs/zookeeperJMX.pdf b/docs/zookeeperJMX.pdf
index 61384b1..369baa0 100644
Binary files a/docs/zookeeperJMX.pdf and b/docs/zookeeperJMX.pdf differ

http://git-wip-us.apache.org/repos/asf/zookeeper/blob/854f7e60/docs/zookeeperObservers.pdf
----------------------------------------------------------------------
diff --git a/docs/zookeeperObservers.pdf b/docs/zookeeperObservers.pdf
index 2706e1f..6819148 100644
Binary files a/docs/zookeeperObservers.pdf and b/docs/zookeeperObservers.pdf differ

http://git-wip-us.apache.org/repos/asf/zookeeper/blob/854f7e60/docs/zookeeperOver.pdf
----------------------------------------------------------------------
diff --git a/docs/zookeeperOver.pdf b/docs/zookeeperOver.pdf
index 63e7713..6c81e2a 100644
Binary files a/docs/zookeeperOver.pdf and b/docs/zookeeperOver.pdf differ

http://git-wip-us.apache.org/repos/asf/zookeeper/blob/854f7e60/docs/zookeeperProgrammers.pdf
----------------------------------------------------------------------
diff --git a/docs/zookeeperProgrammers.pdf b/docs/zookeeperProgrammers.pdf
index e0f1311..40dfe1c 100644
Binary files a/docs/zookeeperProgrammers.pdf and b/docs/zookeeperProgrammers.pdf differ

http://git-wip-us.apache.org/repos/asf/zookeeper/blob/854f7e60/docs/zookeeperQuotas.pdf
----------------------------------------------------------------------
diff --git a/docs/zookeeperQuotas.pdf b/docs/zookeeperQuotas.pdf
index afd4836..351833f 100644
Binary files a/docs/zookeeperQuotas.pdf and b/docs/zookeeperQuotas.pdf differ

http://git-wip-us.apache.org/repos/asf/zookeeper/blob/854f7e60/docs/zookeeperReconfig.pdf
----------------------------------------------------------------------
diff --git a/docs/zookeeperReconfig.pdf b/docs/zookeeperReconfig.pdf
index c449e54..358183a 100644
Binary files a/docs/zookeeperReconfig.pdf and b/docs/zookeeperReconfig.pdf differ

http://git-wip-us.apache.org/repos/asf/zookeeper/blob/854f7e60/docs/zookeeperStarted.pdf
----------------------------------------------------------------------
diff --git a/docs/zookeeperStarted.pdf b/docs/zookeeperStarted.pdf
index 562e8f9..bd830ce 100644
Binary files a/docs/zookeeperStarted.pdf and b/docs/zookeeperStarted.pdf differ

http://git-wip-us.apache.org/repos/asf/zookeeper/blob/854f7e60/docs/zookeeperTutorial.pdf
----------------------------------------------------------------------
diff --git a/docs/zookeeperTutorial.pdf b/docs/zookeeperTutorial.pdf
index 173d0b6..a0f79a6 100644
Binary files a/docs/zookeeperTutorial.pdf and b/docs/zookeeperTutorial.pdf differ

http://git-wip-us.apache.org/repos/asf/zookeeper/blob/854f7e60/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 bfed8c4..c80e437 100644
--- a/src/docs/src/documentation/content/xdocs/zookeeperAdmin.xml
+++ b/src/docs/src/documentation/content/xdocs/zookeeperAdmin.xml
@@ -512,10 +512,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
@@ -2072,8 +2076,11 @@ server.3=zoo3:2888:3888</programlisting>
         <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">
@@ -2093,8 +2100,12 @@ server.3=zoo3:2888:3888</programlisting>
         <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.


Mime
View raw message