OpenDaylight JIRA https://jira.opendaylight.org This file is an XML representation of an issue en-us 8.20.10 820010 22-06-2022 [DOCS-9] Update clustering setup docs with python script https://jira.opendaylight.org/browse/DOCS-9 docs <p>This wiki seems like it has good content:<br/> <a href="https://wiki.opendaylight.org/view/CrossProject:Integration_Group:Controller-Cluster_Deployment" class="external-link" target="_blank" rel="nofollow noopener">https://wiki.opendaylight.org/view/CrossProject:Integration_Group:Controller-Cluster_Deployment</a></p> <p>It should likely be rolled into the Getting Started Guide an User Guide in the ch-clustering.adoc file.</p> <p>Operating System: All<br/> Platform: All</p> DOCS-9 Update clustering setup docs with python script Bug Resolved Done Sanjib Mohapatra Colin Dixon Tue, 30 Jun 2015 19:53:48 +0000 Thu, 19 Oct 2017 22:33:48 +0000 Tue, 27 Jun 2017 19:09:10 +0000 Lithium Getting Started Guide 0 4 <p>TomP said that he uses this page, which Moiz originally wrote:<br/> <a href="https://wiki.opendaylight.org/view/Running_and_testing_an_OpenDaylight_Cluster" class="external-link" target="_blank" rel="nofollow noopener">https://wiki.opendaylight.org/view/Running_and_testing_an_OpenDaylight_Cluster</a></p> <p>I don't know if that needs to be folded in anywhere to the actual user-facing documentation or if it's all included here:<br/> <a href="https://wiki.opendaylight.org/view/CrossProject:Integration_Group:Controller-Cluster_Deployment" class="external-link" target="_blank" rel="nofollow noopener">https://wiki.opendaylight.org/view/CrossProject:Integration_Group:Controller-Cluster_Deployment</a></p> <p>Ideally, we'd coalesce all this information into the clustering.rst file in this patch:<br/> <a href="https://git.opendaylight.org/gerrit/#/c/40645/" class="external-link" target="_blank" rel="nofollow noopener">https://git.opendaylight.org/gerrit/#/c/40645/</a></p> <p>Then it will be automatically published here:<br/> <a href="https://opendaylight.readthedocs.io/en/latest/" class="external-link" target="_blank" rel="nofollow noopener">https://opendaylight.readthedocs.io/en/latest/</a></p> <p>Then we should deprecate the various other pages on the wiki so that people end up in the right place. You can see an example of a deprecated page here:<br/> <a href="https://wiki.opendaylight.org/view/OpenDaylight_Controller:Clustering:HowTo" class="external-link" target="_blank" rel="nofollow noopener">https://wiki.opendaylight.org/view/OpenDaylight_Controller:Clustering:HowTo</a></p> <p>Will update the doc in the given gerrit with using the deploy script as discussed. Also will update relevant portions as applicable.</p> <p>It looks like Luis has a patch related to this here:<br/> <a href="https://git.opendaylight.org/gerrit/#/c/40208/" class="external-link" target="_blank" rel="nofollow noopener">https://git.opendaylight.org/gerrit/#/c/40208/</a></p> <p>Integration does not use python scripts to deploy cluster, we use distribution bash script. That is the only one we maintain and support.</p> <p>So this is what I think we should do:</p> <p>1) Consolidate cluster deploy documentation in wiki and docs: Only one single active doc in each place, other wikis and docs will be deprecated and pointing to these. </p> <p>2) Update the cluster deploy instruction: remove python scripts (I do not think anybody maintains them), add distribution bash scripts.</p> <p>For 2) I have 2 pointers:</p> <ul class="alternate" type="square"> <li>wiki: <a href="https://wiki.opendaylight.org/view/Integration/Distribution/Cluster_Scripts" class="external-link" target="_blank" rel="nofollow noopener">https://wiki.opendaylight.org/view/Integration/Distribution/Cluster_Scripts</a></li> <li>docs: <a href="https://git.opendaylight.org/gerrit/#/c/40208/" class="external-link" target="_blank" rel="nofollow noopener">https://git.opendaylight.org/gerrit/#/c/40208/</a></li> </ul> <p>I can easily work on 2) if you tell me exactly where the final documentation will be.</p> <p>BR/Luis</p> <p>My personal take is that it should be here:<br/> <a href="https://github.com/opendaylight/docs/blob/master/docs/getting-started-guide/common-features/clustering.rst" class="external-link" target="_blank" rel="nofollow noopener">https://github.com/opendaylight/docs/blob/master/docs/getting-started-guide/common-features/clustering.rst</a></p> <p>That being said, I've also wound up keeping the AsciiDoc because it was included in the User Guide, which is staying in AsciiDoc:<br/> <a href="https://github.com/opendaylight/docs/blob/master/manuals/user-guide/src/main/asciidoc/ch-clustering.adoc" class="external-link" target="_blank" rel="nofollow noopener">https://github.com/opendaylight/docs/blob/master/manuals/user-guide/src/main/asciidoc/ch-clustering.adoc</a></p> <p>I could change the user guide to just point to the URL.</p> <p>So do we change the user guide to just point to the URL after incorporating Luis' inputs ? It would be great if we could explain some of the terminologies being used, like seed nodes, any thoughts?</p> <p>Any akka-specific terminologies we can link to akka documentation (akka documentation typically has a tail-pop-up indicating that the users refer to latest version's link - but that should be fine). Any ODL-specific terminologies, we can have a page-local one-liner glossary - eg. Shard. In context of setup of cluster, a brief description of ODL-specific terminologies should serve the purpose.</p> <p>(In reply to Shuva Jyoti Kar from comment #7)<br/> &gt; So do we change the user guide to just point to the URL after incorporating<br/> &gt; Luis' inputs?</p> <p>I'd like to see us update this file:<br/> <a href="https://github.com/opendaylight/docs/blob/master/docs/getting-started-guide/common-features/clustering.rst" class="external-link" target="_blank" rel="nofollow noopener">https://github.com/opendaylight/docs/blob/master/docs/getting-started-guide/common-features/clustering.rst</a></p> <p>Which then gets published here:<br/> <a href="https://opendaylight.readthedocs.io/en/latest/getting-started-guide/common-features/clustering.html" class="external-link" target="_blank" rel="nofollow noopener">https://opendaylight.readthedocs.io/en/latest/getting-started-guide/common-features/clustering.html</a></p> <p>Then, we would point to that from the other places.</p> <p>(In reply to Shuva Jyoti Kar from comment #7)<br/> &gt; It would be great if we could explain some of the<br/> &gt; terminologies being used, like seed nodes, any thoughts?</p> <p>(In reply to Muthukumaran Kothandaraman from comment #8)<br/> &gt; Any akka-specific terminologies we can link to akka documentation (akka<br/> &gt; documentation typically has a tail-pop-up indicating that the users refer to<br/> &gt; latest version's link - but that should be fine). Any ODL-specific<br/> &gt; terminologies, we can have a page-local one-liner glossary - eg. Shard. In<br/> &gt; context of setup of cluster, a brief description of ODL-specific<br/> &gt; terminologies should serve the purpose.</p> <p>+1. It would be useful to explain the terminology. I'd be OK with a brief description of even Akka terms as long as we also provide a link to find out more at their docs.</p> <p>OK, I added my part here:</p> <p>master: <a href="https://git.opendaylight.org/gerrit/#/c/41174/" class="external-link" target="_blank" rel="nofollow noopener">https://git.opendaylight.org/gerrit/#/c/41174/</a><br/> stable/beryllium: <a href="https://git.opendaylight.org/gerrit/#/c/41176/" class="external-link" target="_blank" rel="nofollow noopener">https://git.opendaylight.org/gerrit/#/c/41176/</a></p> <p>I'm going to leave this open until we can hunt down and deprecate/remove/migrate all the other places we have this documentation.</p> <p>There may be instances of the wrong stuff on the wiki, but that's true of the wiki in general. People can delete or flag them as out-of-date as we find them.</p> Development External issue ID 3910 External issue URL Rank 0|i01ovj: