Operating System: All
Platform: All

TomP said that he uses this page, which Moiz originally wrote:
https://wiki.opendaylight.org/view/Running_and_testing_an_OpenDaylight_Cluster

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:
https://wiki.opendaylight.org/view/CrossProject:Integration_Group:Controller-Cluster_Deployment

Ideally, we'd coalesce all this information into the clustering.rst file in this patch:
https://git.opendaylight.org/gerrit/#/c/40645/

Then it will be automatically published here:
https://opendaylight.readthedocs.io/en/latest/

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:
https://wiki.opendaylight.org/view/OpenDaylight_Controller:Clustering:HowTo

Will update the doc in the given gerrit with using the deploy script as discussed. Also will update relevant portions as applicable.

It looks like Luis has a patch related to this here:
https://git.opendaylight.org/gerrit/#/c/40208/

Integration does not use python scripts to deploy cluster, we use distribution bash script. That is the only one we maintain and support.

So this is what I think we should do:

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.

2) Update the cluster deploy instruction: remove python scripts (I do not think anybody maintains them), add distribution bash scripts.

For 2) I have 2 pointers:

• wiki: https://wiki.opendaylight.org/view/Integration/Distribution/Cluster_Scripts
• docs: https://git.opendaylight.org/gerrit/#/c/40208/

I can easily work on 2) if you tell me exactly where the final documentation will be.

BR/Luis

My personal take is that it should be here:
https://github.com/opendaylight/docs/blob/master/docs/getting-started-guide/common-features/clustering.rst

That being said, I've also wound up keeping the AsciiDoc because it was included in the User Guide, which is staying in AsciiDoc:
https://github.com/opendaylight/docs/blob/master/manuals/user-guide/src/main/asciidoc/ch-clustering.adoc

I could change the user guide to just point to the URL.

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?

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.

(In reply to Shuva Jyoti Kar from comment #7)
> So do we change the user guide to just point to the URL after incorporating
> Luis' inputs?

I'd like to see us update this file:
https://github.com/opendaylight/docs/blob/master/docs/getting-started-guide/common-features/clustering.rst

Which then gets published here:
https://opendaylight.readthedocs.io/en/latest/getting-started-guide/common-features/clustering.html

Then, we would point to that from the other places.

(In reply to Shuva Jyoti Kar from comment #7)
> It would be great if we could explain some of the
> terminologies being used, like seed nodes, any thoughts?

(In reply to Muthukumaran Kothandaraman from comment #8)
> 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.

+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.

OK, I added my part here:

master: https://git.opendaylight.org/gerrit/#/c/41174/
stable/beryllium: https://git.opendaylight.org/gerrit/#/c/41176/

I'm going to leave this open until we can hunt down and deprecate/remove/migrate all the other places we have this documentation.

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.