Updated git submodules
[docs.git] / manuals / user-guide / src / main / asciidoc / lfm / lispflowmapping-clustering-user.adoc
1 === Clustering in LISP Flow Mapping
2 Documentation regarding setting up a 3-node OpenDaylight cluster is described at following  https://wiki.opendaylight.org/view/Running_and_testing_an_OpenDaylight_Cluster#Three-node_cluster[odl wiki page].
3
4 To turn on clustering in LISP Flow Mapping it is necessary:
5
6 * run script *deploy.py* script. This script is in https://git.opendaylight.org/gerrit/integration/test[integration-test] project placed at _tools/clustering/cluster-deployer/deploy.py_. A whole deploy.py command can looks like:
7 =======
8 {path_to_integration_test_project}/tools/clustering/cluster-deployer/*deploy.py* +
9 --*distribution* {path_to_distribution_in_zip_format} +
10 --*rootdir* {dir_at_remote_host_where_copy_odl_distribution}  +
11 --*hosts* {IP1},{IP2},{IP3} +
12 --*clean* +
13 --*template* lispflowmapping +
14 --*rf* 3 +
15 --*user* {user_name_of_remote_hosts} +
16 --*password* {password_to_remote_hosts}
17 =======
18 Running this script will cause that specified *distribution* to be deployed to remote *hosts* specified through their IP adresses with using credentials (*user* and *password*). The distribution will be copied to specified *rootdir*. As part of the deployment, a *template* which contains a set of controller files which are different from standard ones. In this case it is specified in +
19 _{path_to_integration_test_project}/tools/clustering/cluster-deployer/lispflowmapping_ directory. +
20 Lispflowmapping templates are part of integration-test project. There are 5 template files: +
21
22 * akka.conf.template
23 * jolokia.xml.template
24 * module-shards.conf.template
25 * modules.conf.template
26 * org.apache.karaf.features.cfg.template
27
28 After copying the distribution, it is unzipped and started on all of specified *hosts* in cluster aware manner.
29
30 ==== Remarks
31 It is necessary to have:
32
33 * *unzip* program installed on all of the host
34 * set all remote hosts /etc/sudoers files to not *requiretty* (should only matter on debian hosts)