Author: mahadev Date: Wed Mar 3 22:57:14 2010 New Revision: 918752 URL: http://svn.apache.org/viewvc?rev=918752&view=rev Log: ZOOKEEPER-658. update forrest docs - AuthFLE no longer supported (flavio via mahadev)
Modified: hadoop/zookeeper/trunk/CHANGES.txt hadoop/zookeeper/trunk/docs/zookeeperAdmin.html hadoop/zookeeper/trunk/docs/zookeeperAdmin.pdf hadoop/zookeeper/trunk/src/docs/src/documentation/content/xdocs/zookeeperAdmin.xml Modified: hadoop/zookeeper/trunk/CHANGES.txt URL: http://svn.apache.org/viewvc/hadoop/zookeeper/trunk/CHANGES.txt?rev=918752&r1=918751&r2=918752&view=diff ============================================================================== --- hadoop/zookeeper/trunk/CHANGES.txt (original) +++ hadoop/zookeeper/trunk/CHANGES.txt Wed Mar 3 22:57:14 2010 @@ -296,6 +296,9 @@ ZOOKEEPER-485. Need ops documentation that details supervision of ZK server processes. (phunt via mahadev) + ZOOKEEPER-658. update forrest docs - AuthFLE no longer supported (flavio via + mahadev) + NEW FEATURES: ZOOKEEPER-539. generate eclipse project via ant target. (phunt via mahadev) Modified: hadoop/zookeeper/trunk/docs/zookeeperAdmin.html URL: http://svn.apache.org/viewvc/hadoop/zookeeper/trunk/docs/zookeeperAdmin.html?rev=918752&r1=918751&r2=918752&view=diff ============================================================================== --- hadoop/zookeeper/trunk/docs/zookeeperAdmin.html (original) +++ hadoop/zookeeper/trunk/docs/zookeeperAdmin.html Wed Mar 3 22:57:14 2010 @@ -1099,8 +1099,22 @@ non-authenticated UDP-based version of fast leader election, "2" corresponds to the authenticated UDP-based version of fast leader election, and "3" corresponds to TCP-based version of - fast leader election. Currently, only 0 and 3 are supported, 3 - being the default</p> + fast leader election. Currently, algorithm 3 is the default</p> +<div class="note"> +<div class="label">Note</div> +<div class="content"> + +<p> The implementations of leader election + 1 and 2 are currently not supported, and we have the intention + of deprecating them in the near future. Implementations 0 and 3 are + currently supported, and we plan to keep supporting them in the near future. + To avoid having to support multiple versions of leader election unecessarily, + we may eventually consider deprecating algorithm 0 as well, but we will plan + according to the needs of the community. + </p> + +</div> +</div> </dd> @@ -1207,7 +1221,7 @@ </dl> <p></p> -<a name="N103B5"></a><a name="sc_authOptions"></a> +<a name="N103BA"></a><a name="sc_authOptions"></a> <h4>Authentication & Authorization Options</h4> <p>The options in this section allow control over authentication/authorization performed by the service.</p> @@ -1241,7 +1255,7 @@ </dd> </dl> -<a name="N103D8"></a><a name="Unsafe+Options"></a> +<a name="N103DD"></a><a name="Unsafe+Options"></a> <h4>Unsafe Options</h4> <p>The following options can be useful, but be careful when you use them. The risk of each is explained along with the explanation of what @@ -1286,7 +1300,7 @@ </dd> </dl> -<a name="N1040A"></a><a name="sc_zkCommands"></a> +<a name="N1040F"></a><a name="sc_zkCommands"></a> <h3 class="h4">ZooKeeper Commands: The Four Letter Words</h3> <p>ZooKeeper responds to a small set of commands. Each command is composed of four letters. You issue the commands to ZooKeeper via telnet @@ -1407,7 +1421,7 @@ <pre class="code">$ echo ruok | nc 127.0.0.1 5111 imok </pre> -<a name="N10472"></a><a name="sc_dataFileManagement"></a> +<a name="N10477"></a><a name="sc_dataFileManagement"></a> <h3 class="h4">Data File Management</h3> <p>ZooKeeper stores its data in a data directory and its transaction log in a transaction log directory. By default these two directories are @@ -1415,7 +1429,7 @@ transaction log files in a separate directory than the data files. Throughput increases and latency decreases when transaction logs reside on a dedicated log devices.</p> -<a name="N1047B"></a><a name="The+Data+Directory"></a> +<a name="N10480"></a><a name="The+Data+Directory"></a> <h4>The Data Directory</h4> <p>This directory has two files in it:</p> <ul> @@ -1461,14 +1475,14 @@ idempotent nature of its updates. By replaying the transaction log against fuzzy snapshots ZooKeeper gets the state of the system at the end of the log.</p> -<a name="N104B7"></a><a name="The+Log+Directory"></a> +<a name="N104BC"></a><a name="The+Log+Directory"></a> <h4>The Log Directory</h4> <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> -<a name="N104C1"></a><a name="sc_filemanagement"></a> +<a name="N104C6"></a><a name="sc_filemanagement"></a> <h4>File Management</h4> <p>The format of snapshot and log files does not change between standalone ZooKeeper servers and different configurations of @@ -1488,7 +1502,7 @@ this document for more details on setting a retention policy and maintenance of ZooKeeper storage. </p> -<a name="N104D6"></a><a name="sc_commonProblems"></a> +<a name="N104DB"></a><a name="sc_commonProblems"></a> <h3 class="h4">Things to Avoid</h3> <p>Here are some common problems you can avoid by configuring ZooKeeper correctly:</p> @@ -1542,7 +1556,7 @@ </dd> </dl> -<a name="N104FA"></a><a name="sc_bestPractices"></a> +<a name="N104FF"></a><a name="sc_bestPractices"></a> <h3 class="h4">Best Practices</h3> <p>For best results, take note of the following list of good Zookeeper practices:</p> Modified: hadoop/zookeeper/trunk/docs/zookeeperAdmin.pdf URL: http://svn.apache.org/viewvc/hadoop/zookeeper/trunk/docs/zookeeperAdmin.pdf?rev=918752&r1=918751&r2=918752&view=diff ============================================================================== Binary files - no diff available. Modified: hadoop/zookeeper/trunk/src/docs/src/documentation/content/xdocs/zookeeperAdmin.xml URL: http://svn.apache.org/viewvc/hadoop/zookeeper/trunk/src/docs/src/documentation/content/xdocs/zookeeperAdmin.xml?rev=918752&r1=918751&r2=918752&view=diff ============================================================================== --- hadoop/zookeeper/trunk/src/docs/src/documentation/content/xdocs/zookeeperAdmin.xml (original) +++ hadoop/zookeeper/trunk/src/docs/src/documentation/content/xdocs/zookeeperAdmin.xml Wed Mar 3 22:57:14 2010 @@ -739,8 +739,18 @@ non-authenticated UDP-based version of fast leader election, "2" corresponds to the authenticated UDP-based version of fast leader election, and "3" corresponds to TCP-based version of - fast leader election. Currently, only 0 and 3 are supported, 3 - being the default</para> + fast leader election. Currently, algorithm 3 is the default</para> + + <note> + <para> The implementations of leader election + 1 and 2 are currently not supported, and we have the intention + of deprecating them in the near future. Implementations 0 and 3 are + currently supported, and we plan to keep supporting them in the near future. + To avoid having to support multiple versions of leader election unecessarily, + we may eventually consider deprecating algorithm 0 as well, but we will plan + according to the needs of the community. + </para> + </note> </listitem> </varlistentry>