Details

    • Type: Sub-task Sub-task
    • Status: Resolved
    • Priority: Blocker Blocker
    • Resolution: Fixed
    • Affects Version/s: 3.5.0
    • Fix Version/s: 3.5.1, 3.6.0
    • Component/s: documentation
    • Labels:
      None
    • Hadoop Flags:
      Reviewed

      Description

      Update user manual with reconfiguration info.

      1. ZOOKEEPER-1660-v3.patch
        48 kB
        Reed Wanderman-Milne
      2. ZOOKEEPER-1660-v2.patch
        46 kB
        Reed Wanderman-Milne
      3. ZOOKEEPER-1660.patch
        43 kB
        Reed Wanderman-Milne

        Issue Links

          Activity

          Hide
          Alexander Shraer added a comment -

          looks like the html manual is now available:

          http://zookeeper.apache.org/doc/trunk/zookeeperReconfig.html

          Show
          Alexander Shraer added a comment - looks like the html manual is now available: http://zookeeper.apache.org/doc/trunk/zookeeperReconfig.html
          Hide
          Alexander Shraer added a comment -

          Here is a presentation I gave today in ZooKeeper meetup, based on the user manual:

          https://docs.google.com/presentation/d/1gtRUNaOzcnK4WfSY6bT8EyCf4iqrlHWWNxdqwAnPBow

          Show
          Alexander Shraer added a comment - Here is a presentation I gave today in ZooKeeper meetup, based on the user manual: https://docs.google.com/presentation/d/1gtRUNaOzcnK4WfSY6bT8EyCf4iqrlHWWNxdqwAnPBow
          Hide
          Alexander Shraer added a comment -

          I committed the html and pdf to trunk. So I'm guessing they will become available in 3.5.1

          Show
          Alexander Shraer added a comment - I committed the html and pdf to trunk. So I'm guessing they will become available in 3.5.1
          Hide
          Wendy Smoak added a comment -

          Looking around, part of the problem might be that zookeeperReconfig.html (and .pdf) are not checked in to
          http://svn.apache.org/repos/asf/zookeeper/trunk/docs/
          while the rest of the pages seem to be there.

          I haven't found any info yet on how to build and deploy the site – will pursue that separately on dev@.

          Show
          Wendy Smoak added a comment - Looking around, part of the problem might be that zookeeperReconfig.html (and .pdf) are not checked in to http://svn.apache.org/repos/asf/zookeeper/trunk/docs/ while the rest of the pages seem to be there. I haven't found any info yet on how to build and deploy the site – will pursue that separately on dev@.
          Hide
          Alexander Shraer added a comment -

          Thanks for noticing this, Wendy!

          Patrick Hunt, Reed Wanderman-Milne do you know how to publish the page ?

          Show
          Alexander Shraer added a comment - Thanks for noticing this, Wendy! Patrick Hunt , Reed Wanderman-Milne do you know how to publish the page ?
          Hide
          Wendy Smoak added a comment -

          The zookeeperReconfig page does not seem to have been published.

          http://zookeeper.apache.org/doc/trunk/zookeeperAdmin.html
          -> Dynamic Reconfiguration
          http://zookeeper.apache.org/doc/trunk/zookeeperReconfig.html
          -> 404

          Show
          Wendy Smoak added a comment - The zookeeperReconfig page does not seem to have been published. http://zookeeper.apache.org/doc/trunk/zookeeperAdmin.html -> Dynamic Reconfiguration http://zookeeper.apache.org/doc/trunk/zookeeperReconfig.html -> 404
          Hide
          Hudson added a comment -

          SUCCESS: Integrated in ZooKeeper-trunk #2423 (See https://builds.apache.org/job/ZooKeeper-trunk/2423/)
          ZOOKEEPER-1660 Documentation for Dynamic Reconfiguration (Reed Wanderman-Milne via shralex) (shralex: http://svn.apache.org/viewcvs.cgi/?root=Apache-SVN&view=rev&rev=1621313)

          • /zookeeper/trunk/CHANGES.txt
          • /zookeeper/trunk/docs/index.html
          • /zookeeper/trunk/docs/index.pdf
          • /zookeeper/trunk/docs/javaExample.html
          • /zookeeper/trunk/docs/javaExample.pdf
          • /zookeeper/trunk/docs/linkmap.html
          • /zookeeper/trunk/docs/linkmap.pdf
          • /zookeeper/trunk/docs/recipes.html
          • /zookeeper/trunk/docs/recipes.pdf
          • /zookeeper/trunk/docs/releasenotes.html
          • /zookeeper/trunk/docs/releasenotes.pdf
          • /zookeeper/trunk/docs/skin/images/rc-b-l-15-1body-2menu-3menu.png
          • /zookeeper/trunk/docs/skin/images/rc-b-r-15-1body-2menu-3menu.png
          • /zookeeper/trunk/docs/skin/images/rc-b-r-5-1header-2tab-selected-3tab-selected.png
          • /zookeeper/trunk/docs/skin/images/rc-t-l-5-1header-2searchbox-3searchbox.png
          • /zookeeper/trunk/docs/skin/images/rc-t-l-5-1header-2tab-selected-3tab-selected.png
          • /zookeeper/trunk/docs/skin/images/rc-t-l-5-1header-2tab-unselected-3tab-unselected.png
          • /zookeeper/trunk/docs/skin/images/rc-t-r-15-1body-2menu-3menu.png
          • /zookeeper/trunk/docs/skin/images/rc-t-r-5-1header-2searchbox-3searchbox.png
          • /zookeeper/trunk/docs/skin/images/rc-t-r-5-1header-2tab-selected-3tab-selected.png
          • /zookeeper/trunk/docs/skin/images/rc-t-r-5-1header-2tab-unselected-3tab-unselected.png
          • /zookeeper/trunk/docs/zookeeperAdmin.html
          • /zookeeper/trunk/docs/zookeeperAdmin.pdf
          • /zookeeper/trunk/docs/zookeeperHierarchicalQuorums.html
          • /zookeeper/trunk/docs/zookeeperHierarchicalQuorums.pdf
          • /zookeeper/trunk/docs/zookeeperInternals.html
          • /zookeeper/trunk/docs/zookeeperInternals.pdf
          • /zookeeper/trunk/docs/zookeeperJMX.html
          • /zookeeper/trunk/docs/zookeeperJMX.pdf
          • /zookeeper/trunk/docs/zookeeperObservers.html
          • /zookeeper/trunk/docs/zookeeperObservers.pdf
          • /zookeeper/trunk/docs/zookeeperOver.html
          • /zookeeper/trunk/docs/zookeeperOver.pdf
          • /zookeeper/trunk/docs/zookeeperProgrammers.html
          • /zookeeper/trunk/docs/zookeeperProgrammers.pdf
          • /zookeeper/trunk/docs/zookeeperQuotas.html
          • /zookeeper/trunk/docs/zookeeperQuotas.pdf
          • /zookeeper/trunk/docs/zookeeperStarted.html
          • /zookeeper/trunk/docs/zookeeperStarted.pdf
          • /zookeeper/trunk/docs/zookeeperTutorial.html
          • /zookeeper/trunk/docs/zookeeperTutorial.pdf
          • /zookeeper/trunk/src/docs/src/documentation/content/xdocs/index.xml
          • /zookeeper/trunk/src/docs/src/documentation/content/xdocs/site.xml
          • /zookeeper/trunk/src/docs/src/documentation/content/xdocs/zookeeperAdmin.xml
          • /zookeeper/trunk/src/docs/src/documentation/content/xdocs/zookeeperReconfig.xml
          Show
          Hudson added a comment - SUCCESS: Integrated in ZooKeeper-trunk #2423 (See https://builds.apache.org/job/ZooKeeper-trunk/2423/ ) ZOOKEEPER-1660 Documentation for Dynamic Reconfiguration (Reed Wanderman-Milne via shralex) (shralex: http://svn.apache.org/viewcvs.cgi/?root=Apache-SVN&view=rev&rev=1621313 ) /zookeeper/trunk/CHANGES.txt /zookeeper/trunk/docs/index.html /zookeeper/trunk/docs/index.pdf /zookeeper/trunk/docs/javaExample.html /zookeeper/trunk/docs/javaExample.pdf /zookeeper/trunk/docs/linkmap.html /zookeeper/trunk/docs/linkmap.pdf /zookeeper/trunk/docs/recipes.html /zookeeper/trunk/docs/recipes.pdf /zookeeper/trunk/docs/releasenotes.html /zookeeper/trunk/docs/releasenotes.pdf /zookeeper/trunk/docs/skin/images/rc-b-l-15-1body-2menu-3menu.png /zookeeper/trunk/docs/skin/images/rc-b-r-15-1body-2menu-3menu.png /zookeeper/trunk/docs/skin/images/rc-b-r-5-1header-2tab-selected-3tab-selected.png /zookeeper/trunk/docs/skin/images/rc-t-l-5-1header-2searchbox-3searchbox.png /zookeeper/trunk/docs/skin/images/rc-t-l-5-1header-2tab-selected-3tab-selected.png /zookeeper/trunk/docs/skin/images/rc-t-l-5-1header-2tab-unselected-3tab-unselected.png /zookeeper/trunk/docs/skin/images/rc-t-r-15-1body-2menu-3menu.png /zookeeper/trunk/docs/skin/images/rc-t-r-5-1header-2searchbox-3searchbox.png /zookeeper/trunk/docs/skin/images/rc-t-r-5-1header-2tab-selected-3tab-selected.png /zookeeper/trunk/docs/skin/images/rc-t-r-5-1header-2tab-unselected-3tab-unselected.png /zookeeper/trunk/docs/zookeeperAdmin.html /zookeeper/trunk/docs/zookeeperAdmin.pdf /zookeeper/trunk/docs/zookeeperHierarchicalQuorums.html /zookeeper/trunk/docs/zookeeperHierarchicalQuorums.pdf /zookeeper/trunk/docs/zookeeperInternals.html /zookeeper/trunk/docs/zookeeperInternals.pdf /zookeeper/trunk/docs/zookeeperJMX.html /zookeeper/trunk/docs/zookeeperJMX.pdf /zookeeper/trunk/docs/zookeeperObservers.html /zookeeper/trunk/docs/zookeeperObservers.pdf /zookeeper/trunk/docs/zookeeperOver.html /zookeeper/trunk/docs/zookeeperOver.pdf /zookeeper/trunk/docs/zookeeperProgrammers.html /zookeeper/trunk/docs/zookeeperProgrammers.pdf /zookeeper/trunk/docs/zookeeperQuotas.html /zookeeper/trunk/docs/zookeeperQuotas.pdf /zookeeper/trunk/docs/zookeeperStarted.html /zookeeper/trunk/docs/zookeeperStarted.pdf /zookeeper/trunk/docs/zookeeperTutorial.html /zookeeper/trunk/docs/zookeeperTutorial.pdf /zookeeper/trunk/src/docs/src/documentation/content/xdocs/index.xml /zookeeper/trunk/src/docs/src/documentation/content/xdocs/site.xml /zookeeper/trunk/src/docs/src/documentation/content/xdocs/zookeeperAdmin.xml /zookeeper/trunk/src/docs/src/documentation/content/xdocs/zookeeperReconfig.xml
          Hide
          Alexander Shraer added a comment -

          committed to trunk and 3.5.0 branch.
          Patrick Hunt, there appear to be some unrelated issues when building the docs in 3.5.0 branch, so I just changed the most relevant files for this jira.

          Reed, thanks again!

          Show
          Alexander Shraer added a comment - committed to trunk and 3.5.0 branch. Patrick Hunt , there appear to be some unrelated issues when building the docs in 3.5.0 branch, so I just changed the most relevant files for this jira. Reed, thanks again!
          Hide
          Alexander Shraer added a comment -

          Thanks Rakesh. Makes sense, I was just thinking maybe those are updated just before a release. I'll updated them as you suggest.

          Show
          Alexander Shraer added a comment - Thanks Rakesh. Makes sense, I was just thinking maybe those are updated just before a release. I'll updated them as you suggest.
          Hide
          Rakesh R added a comment -

          Typo: should be "Dynamic".

          +      <reconfig label="Dyanmic Reconfiguration" href="zookeeperReconfig.html" />
          
          +         a dyanmic configuration file. If they are placed in the static
          

          does anyone knows how to commit docs ?

          Presently we have generated files also checked in the repository. Actually saying these doc files are not required to be committed. Now if we avoid checkins these reconfig new files, over a period these doc files become stale, isn't it?

          Show
          Rakesh R added a comment - Typo: should be "Dynamic". + <reconfig label= "Dyanmic Reconfiguration" href= "zookeeperReconfig.html" /> + a dyanmic configuration file. If they are placed in the static does anyone knows how to commit docs ? Presently we have generated files also checked in the repository. Actually saying these doc files are not required to be committed. Now if we avoid checkins these reconfig new files, over a period these doc files become stale, isn't it?
          Hide
          Alexander Shraer added a comment -

          This looks awesome, thank you Reed!
          should I commit this ?

          does anyone knows how to commit docs ? do I only commit the changed source files or also all the new generated files like pdfs, etc (there are many) ? Flavio Junqueira Patrick Hunt

          Show
          Alexander Shraer added a comment - This looks awesome, thank you Reed! should I commit this ? does anyone knows how to commit docs ? do I only commit the changed source files or also all the new generated files like pdfs, etc (there are many) ? Flavio Junqueira Patrick Hunt
          Hide
          Hadoop QA added a comment -

          -1 overall. Here are the results of testing the latest attachment
          http://issues.apache.org/jira/secure/attachment/12664205/ZOOKEEPER-1660-v3.patch
          against trunk revision 1620111.

          +1 @author. The patch does not contain any @author tags.

          +0 tests included. The patch appears to be a documentation patch that doesn't require tests.

          +1 javadoc. The javadoc tool did not generate any warning messages.

          +1 javac. The applied patch does not increase the total number of javac compiler warnings.

          +1 findbugs. The patch does not introduce any new Findbugs (version 2.0.3) warnings.

          +1 release audit. The applied patch does not increase the total number of release audit warnings.

          -1 core tests. The patch failed core unit tests.

          +1 contrib tests. The patch passed contrib unit tests.

          Test results: https://builds.apache.org/job/PreCommit-ZOOKEEPER-Build/2299//testReport/
          Findbugs warnings: https://builds.apache.org/job/PreCommit-ZOOKEEPER-Build/2299//artifact/trunk/build/test/findbugs/newPatchFindbugsWarnings.html
          Console output: https://builds.apache.org/job/PreCommit-ZOOKEEPER-Build/2299//console

          This message is automatically generated.

          Show
          Hadoop QA added a comment - -1 overall. Here are the results of testing the latest attachment http://issues.apache.org/jira/secure/attachment/12664205/ZOOKEEPER-1660-v3.patch against trunk revision 1620111. +1 @author. The patch does not contain any @author tags. +0 tests included. The patch appears to be a documentation patch that doesn't require tests. +1 javadoc. The javadoc tool did not generate any warning messages. +1 javac. The applied patch does not increase the total number of javac compiler warnings. +1 findbugs. The patch does not introduce any new Findbugs (version 2.0.3) warnings. +1 release audit. The applied patch does not increase the total number of release audit warnings. -1 core tests. The patch failed core unit tests. +1 contrib tests. The patch passed contrib unit tests. Test results: https://builds.apache.org/job/PreCommit-ZOOKEEPER-Build/2299//testReport/ Findbugs warnings: https://builds.apache.org/job/PreCommit-ZOOKEEPER-Build/2299//artifact/trunk/build/test/findbugs/newPatchFindbugsWarnings.html Console output: https://builds.apache.org/job/PreCommit-ZOOKEEPER-Build/2299//console This message is automatically generated.
          Hide
          Reed Wanderman-Milne added a comment -

          Hi Alex,

          That was a good change, the overview is much clearer now. Note that I had to format the paper citation slightly, since it appears Docbooks doesn't support line breaks. Tell me if there are any more changes to the Google Doc.

          The patch contains a reference to the reconfig page from the Administrator's guide (in the section Configuration Parameters), so a reader should be able to figure out how to upgrade to 3.5.0.

          Show
          Reed Wanderman-Milne added a comment - Hi Alex, That was a good change, the overview is much clearer now. Note that I had to format the paper citation slightly, since it appears Docbooks doesn't support line breaks. Tell me if there are any more changes to the Google Doc. The patch contains a reference to the reconfig page from the Administrator's guide (in the section Configuration Parameters), so a reader should be able to figure out how to upgrade to 3.5.0.
          Hide
          Alexander Shraer added a comment -

          Hi Reed, thanks a lot!!

          I made one more change... sorry - forgot about it earlier... I thought that its not so good that we start right away with the details, instead we should start with some summary. So I changed the first paragraph of the text in the doc and made it into an Overview section.

          > Maybe we should move the "Upgrading to 3.5.0" to the Administrator's guide page

          All of it is intended for administrators (see ZOOKEEPER-2014). So I suggest to leave it in the doc as is and add a link from the Administrator's guide page to the reconfiguration manual.

          Alex

          Show
          Alexander Shraer added a comment - Hi Reed, thanks a lot!! I made one more change... sorry - forgot about it earlier... I thought that its not so good that we start right away with the details, instead we should start with some summary. So I changed the first paragraph of the text in the doc and made it into an Overview section. > Maybe we should move the "Upgrading to 3.5.0" to the Administrator's guide page All of it is intended for administrators (see ZOOKEEPER-2014 ). So I suggest to leave it in the doc as is and add a link from the Administrator's guide page to the reconfiguration manual. Alex
          Hide
          Hadoop QA added a comment -

          -1 overall. Here are the results of testing the latest attachment
          http://issues.apache.org/jira/secure/attachment/12663886/ZOOKEEPER-1660-v2.patch
          against trunk revision 1619166.

          +1 @author. The patch does not contain any @author tags.

          +0 tests included. The patch appears to be a documentation patch that doesn't require tests.

          +1 javadoc. The javadoc tool did not generate any warning messages.

          +1 javac. The applied patch does not increase the total number of javac compiler warnings.

          +1 findbugs. The patch does not introduce any new Findbugs (version 2.0.3) warnings.

          +1 release audit. The applied patch does not increase the total number of release audit warnings.

          -1 core tests. The patch failed core unit tests.

          +1 contrib tests. The patch passed contrib unit tests.

          Test results: https://builds.apache.org/job/PreCommit-ZOOKEEPER-Build/2298//testReport/
          Findbugs warnings: https://builds.apache.org/job/PreCommit-ZOOKEEPER-Build/2298//artifact/trunk/build/test/findbugs/newPatchFindbugsWarnings.html
          Console output: https://builds.apache.org/job/PreCommit-ZOOKEEPER-Build/2298//console

          This message is automatically generated.

          Show
          Hadoop QA added a comment - -1 overall. Here are the results of testing the latest attachment http://issues.apache.org/jira/secure/attachment/12663886/ZOOKEEPER-1660-v2.patch against trunk revision 1619166. +1 @author. The patch does not contain any @author tags. +0 tests included. The patch appears to be a documentation patch that doesn't require tests. +1 javadoc. The javadoc tool did not generate any warning messages. +1 javac. The applied patch does not increase the total number of javac compiler warnings. +1 findbugs. The patch does not introduce any new Findbugs (version 2.0.3) warnings. +1 release audit. The applied patch does not increase the total number of release audit warnings. -1 core tests. The patch failed core unit tests. +1 contrib tests. The patch passed contrib unit tests. Test results: https://builds.apache.org/job/PreCommit-ZOOKEEPER-Build/2298//testReport/ Findbugs warnings: https://builds.apache.org/job/PreCommit-ZOOKEEPER-Build/2298//artifact/trunk/build/test/findbugs/newPatchFindbugsWarnings.html Console output: https://builds.apache.org/job/PreCommit-ZOOKEEPER-Build/2298//console This message is automatically generated.
          Hide
          Reed Wanderman-Milne added a comment -

          Hi Alex,

          Thanks for the updates. I made the changes, except for adding the comment about local sessions (which I can add later if necessary).

          Maybe we should move the "Upgrading to 3.5.0" to the Administrator's guide page, it doesn't seem directly related to dynamic reconfig. What do you think?

          Show
          Reed Wanderman-Milne added a comment - Hi Alex, Thanks for the updates. I made the changes, except for adding the comment about local sessions (which I can add later if necessary). Maybe we should move the "Upgrading to 3.5.0" to the Administrator's guide page, it doesn't seem directly related to dynamic reconfig. What do you think?
          Hide
          Alexander Shraer added a comment -

          Also, if you don't mind, I'd like to make one more significant change - I rewrote the "Adding servers" section in the Google Doc, mainly pointing out the option of starting joiners as observers. Niko Vuokko suggested it in the mailing list, and I think its a great idea since it allows listing multiple joiners without the danger that they form an independent quorum.

          Show
          Alexander Shraer added a comment - Also, if you don't mind, I'd like to make one more significant change - I rewrote the "Adding servers" section in the Google Doc, mainly pointing out the option of starting joiners as observers. Niko Vuokko suggested it in the mailing list, and I think its a great idea since it allows listing multiple joiners without the danger that they form an independent quorum.
          Hide
          Alexander Shraer added a comment -

          Hi Reed,

          it looks awesome, thanks for doing this!

          Here are a few small update requests:

          • first line: "user (administrator)" -> "administrator"
          • The standaloneEnabled flag section: remove sentence "The new standaloneEnabled flag solves this problem." (there was a comment that its ambiguous)
          • At the end of "error conditions" sections, please add a sentence "Most of these are illustrated by test-cases in ReconfigFailureCases.java".
          • In the section about rolling upgrades to 3.5.0 we may need to add a sentence at the end saying "Currently, upgrades from 3.4.6 to 3.5.0 work as long as you don't use local sessions. There's a ticket to address this limitation: ZOOKEEPER-1787". I hope 1787 is fixed and we can skip this.
          Show
          Alexander Shraer added a comment - Hi Reed, it looks awesome, thanks for doing this! Here are a few small update requests: first line: "user (administrator)" -> "administrator" The standaloneEnabled flag section: remove sentence "The new standaloneEnabled flag solves this problem." (there was a comment that its ambiguous) At the end of "error conditions" sections, please add a sentence "Most of these are illustrated by test-cases in ReconfigFailureCases.java". In the section about rolling upgrades to 3.5.0 we may need to add a sentence at the end saying "Currently, upgrades from 3.4.6 to 3.5.0 work as long as you don't use local sessions. There's a ticket to address this limitation: ZOOKEEPER-1787 ". I hope 1787 is fixed and we can skip this.
          Hide
          Hadoop QA added a comment -

          -1 overall. Here are the results of testing the latest attachment
          http://issues.apache.org/jira/secure/attachment/12663705/ZOOKEEPER-1660.patch
          against trunk revision 1619166.

          +1 @author. The patch does not contain any @author tags.

          +0 tests included. The patch appears to be a documentation patch that doesn't require tests.

          +1 javadoc. The javadoc tool did not generate any warning messages.

          +1 javac. The applied patch does not increase the total number of javac compiler warnings.

          +1 findbugs. The patch does not introduce any new Findbugs (version 2.0.3) warnings.

          +1 release audit. The applied patch does not increase the total number of release audit warnings.

          -1 core tests. The patch failed core unit tests.

          +1 contrib tests. The patch passed contrib unit tests.

          Test results: https://builds.apache.org/job/PreCommit-ZOOKEEPER-Build/2294//testReport/
          Findbugs warnings: https://builds.apache.org/job/PreCommit-ZOOKEEPER-Build/2294//artifact/trunk/build/test/findbugs/newPatchFindbugsWarnings.html
          Console output: https://builds.apache.org/job/PreCommit-ZOOKEEPER-Build/2294//console

          This message is automatically generated.

          Show
          Hadoop QA added a comment - -1 overall. Here are the results of testing the latest attachment http://issues.apache.org/jira/secure/attachment/12663705/ZOOKEEPER-1660.patch against trunk revision 1619166. +1 @author. The patch does not contain any @author tags. +0 tests included. The patch appears to be a documentation patch that doesn't require tests. +1 javadoc. The javadoc tool did not generate any warning messages. +1 javac. The applied patch does not increase the total number of javac compiler warnings. +1 findbugs. The patch does not introduce any new Findbugs (version 2.0.3) warnings. +1 release audit. The applied patch does not increase the total number of release audit warnings. -1 core tests. The patch failed core unit tests. +1 contrib tests. The patch passed contrib unit tests. Test results: https://builds.apache.org/job/PreCommit-ZOOKEEPER-Build/2294//testReport/ Findbugs warnings: https://builds.apache.org/job/PreCommit-ZOOKEEPER-Build/2294//artifact/trunk/build/test/findbugs/newPatchFindbugsWarnings.html Console output: https://builds.apache.org/job/PreCommit-ZOOKEEPER-Build/2294//console This message is automatically generated.
          Hide
          Reed Wanderman-Milne added a comment -

          Here's a draft of the new documentation. I had to make some minor formatting changes from the Google Doc, since the Forrest Docbooks plugin doesn't support some formatting options.

          Show
          Reed Wanderman-Milne added a comment - Here's a draft of the new documentation. I had to make some minor formatting changes from the Google Doc, since the Forrest Docbooks plugin doesn't support some formatting options.
          Hide
          Reed Wanderman-Milne added a comment -

          I'll start working on the Forrest, doc then, I'll have it done in a few days.

          Show
          Reed Wanderman-Milne added a comment - I'll start working on the Forrest, doc then, I'll have it done in a few days.
          Hide
          Alexander Shraer added a comment -

          Hi,

          I've updated the doc with latest changes to backward compatibility support, and added a few examples of Java API. More comments are welcome. Otherwise, Reed Wanderman-Milne it seems that this version of the doc is pretty stable, we can track further changes separately.

          Thanks,
          Alex

          Show
          Alexander Shraer added a comment - Hi, I've updated the doc with latest changes to backward compatibility support, and added a few examples of Java API. More comments are welcome. Otherwise, Reed Wanderman-Milne it seems that this version of the doc is pretty stable, we can track further changes separately. Thanks, Alex
          Hide
          Alexander Shraer added a comment -

          its a Follower but it is not in the last committed configuration so its votes are not counted towards a majority.
          For example when adding a server its first connected to the current ensemble as a non-voting follower. Then if/when it is added by a reconfiguration its votes start being counted. Similarly when removing a server it becomes a non-voting follower.

          Show
          Alexander Shraer added a comment - its a Follower but it is not in the last committed configuration so its votes are not counted towards a majority. For example when adding a server its first connected to the current ensemble as a non-voting follower. Then if/when it is added by a reconfiguration its votes start being counted. Similarly when removing a server it becomes a non-voting follower.
          Hide
          Hongchao Deng added a comment -

          hi Alexander Shraer.
          In the doc you mentioned "non-voting follower", which is not "observer":

          3.2.1 General
          Removing servers... Instead, it becomes a “non-voting follower”. This is somewhat similar to an observer in that its votes don’t count towards the Quorum of votes necessary to commit operations. However, unlike a non-voting follower, an observer doesn’t actually see any operation proposals and does not ACK them...

          What is the role of that added or removed server? Can you clarify or point to the code about this?

          Show
          Hongchao Deng added a comment - hi Alexander Shraer . In the doc you mentioned "non-voting follower", which is not "observer": 3.2.1 General Removing servers... Instead, it becomes a “non-voting follower”. This is somewhat similar to an observer in that its votes don’t count towards the Quorum of votes necessary to commit operations. However, unlike a non-voting follower, an observer doesn’t actually see any operation proposals and does not ACK them... What is the role of that added or removed server? Can you clarify or point to the code about this?
          Hide
          Alexander Shraer added a comment -
          Show
          Alexander Shraer added a comment - thanks Reed Wanderman-Milne !
          Hide
          Reed Wanderman-Milne added a comment -

          I spoke to Alexander Shraer, and agreed to create the forrest docs, once the Google Doc is updated to its near-final version.

          Show
          Reed Wanderman-Milne added a comment - I spoke to Alexander Shraer , and agreed to create the forrest docs, once the Google Doc is updated to its near-final version.
          Hide
          Patrick Hunt added a comment -

          Flavio Junqueira I agree. W/o docs no one is going to use the feature. And most folks are going to look at the admin guide for that. For better/worse we are still using forrest for that.

          I believe Reed Wanderman-Milne is interested. I'll let him comment further.

          Show
          Patrick Hunt added a comment - Flavio Junqueira I agree. W/o docs no one is going to use the feature. And most folks are going to look at the admin guide for that. For better/worse we are still using forrest for that. I believe Reed Wanderman-Milne is interested. I'll let him comment further.
          Hide
          Flavio Junqueira added a comment -

          I'm wondering how we are going to be making this doc available. Transforming it into a forrest doc will be a bit of pain. Patrick Hunt, any suggestion here?

          Show
          Flavio Junqueira added a comment - I'm wondering how we are going to be making this doc available. Transforming it into a forrest doc will be a bit of pain. Patrick Hunt , any suggestion here?
          Hide
          Alexander Shraer added a comment -

          I can update the admin guide, and it does contain some important info for upgrade. But it may be better to do it right before the 3.5.0 release, so that for now we have a copy in Docs that everyone can easily read and we can edit.

          Show
          Alexander Shraer added a comment - I can update the admin guide, and it does contain some important info for upgrade. But it may be better to do it right before the 3.5.0 release, so that for now we have a copy in Docs that everyone can easily read and we can edit.
          Hide
          Patrick Hunt added a comment -

          Alexander Shraer what's the plan, you're going to update the admin guide for this? Release notes for upgrade necessary?

          Show
          Patrick Hunt added a comment - Alexander Shraer what's the plan, you're going to update the admin guide for this? Release notes for upgrade necessary?
          Hide
          Alexander Shraer added a comment -

          I created a draft of the user manual for reconfiguration. Any comments are welcome!

          https://docs.google.com/document/d/1AF8pIfQbN5cKxe0c4cQ4_DW6ZjBJqSkyANcTGUwkzjc/edit

          Show
          Alexander Shraer added a comment - I created a draft of the user manual for reconfiguration. Any comments are welcome! https://docs.google.com/document/d/1AF8pIfQbN5cKxe0c4cQ4_DW6ZjBJqSkyANcTGUwkzjc/edit

            People

            • Assignee:
              Reed Wanderman-Milne
              Reporter:
              Alexander Shraer
            • Votes:
              0 Vote for this issue
              Watchers:
              9 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Development