Fixes clustering to use template instead of exec

[integration/packaging/puppet-opendaylight.git] / README.markdown

diff --git a/README.markdown b/README.markdown
index 9facbb501d25e17d204a8094293da99c839c7746..91de61e244282fbf00efa2fe33a220b986c0a2d0 100644 (file)
--- a/README.markdown
+++ b/README.markdown
@@ -1,6 +1,3 @@
-[![CI Status][4]][1]
-[![Dependency Status][5]][2]
-
 # OpenDaylight
 
 #### Table of Contents
@@ -180,15 +177,22 @@ To enable ODL HA, use the `enable_ha` flag. It's disabled by default.
 
 When `enable_ha` is set to true the `ha_node_ips` should be populated with the
 IP addresses that ODL will listen on for each node in the HA cluster and
-`ha_node_index` should be set with the index of the IP address from
-`ha_node_ips` for the particular node that puppet is configuring as part of the
+`odl_bind_ip` should be set with the IP address from `ha_node_ips` configured
+for the particular node that puppet is configuring as part of the
 HA cluster.
 
+By default a single ODL instance will become the leader for the entire
+datastore.  In order to distribute the datastore over multiple ODL instances,
+`ha_db_modules` parameter may be specified which will include the modules
+desired to separate out from the default shard, along with the Yang namespace
+for that module.
+
 ```puppet
 class { 'opendaylight':
   enable_ha     => true,
   ha_node_ips   => ['10.10.10.1', '10.10.10.1', '10.10.10.3'],
-  ha_node_index => 0,
+  odl_bind_ip   => 0,
+  ha_db_modules => {'default' => false, 'topology' => 'urn:opendaylight:topology'}
 }
 ```
 
@@ -297,7 +301,7 @@ Default: `false`
 
 Valid options: The boolean values `true` and `false`.
 
-Requires: `ha_node_ips`, `ha_node_index`
+Requires: `ha_node_ips`, `odl_bind_ip`
 
 The ODL Clustering XML for HA are configured and enabled.
 
@@ -311,6 +315,16 @@ Valid options: An array of IP addresses `['10.10.10.1', '10.10.10.1', '10.10.10.
 
 Required by: `enable_ha`
 
+##### `ha_db_modules`
+
+Specifies the modules to use for distributing and sharding the ODL datastore.
+
+Default: `{'default'=> false}`
+
+Valid options: A hash of module and Yang namespace for the module (default has no namespace).
+
+Requires: `enable_ha`
+
 ##### `ha_node_index`
 
 Specifies the index of the IP for the node being configured from the array `ha_node_ips`.
@@ -319,7 +333,7 @@ Default: ''
 
 Valid options: Index of a member of the array `ha_node_ips`: `0`.
 
-Required by: `enable_ha`, `ha_node_ips`
+This parameter is now deprecated and is no longer used.
 
 ##### `security_group_mode`
 
@@ -332,7 +346,7 @@ Valid options: `transparent`, `learn`, `stateless`
 ##### `vpp_routing_node`
 
 Specifies the routing node for VPP deployment. A non-empty string will create config file
-org.opendaylight.groupbasedpolicy.neutron.vpp.mapper.cfg with routing-node set.
+org.opendaylight.groupbasedpolicy.neutron.vpp.mapper.startup.cfg with routing-node set.
 
 Default: `''`
 
@@ -346,6 +360,22 @@ Default: `'-Djava.net.preferIPv4Stack=true'`
 
 Valid options: A string of valid Java options.
 
+##### `username`
+
+Specifies the username to set for admin role in ODL.
+
+Default: `'admin'`
+
+Valid options: A username string.
+
+##### `password`
+
+Specifies the password to set for admin role in ODL.
+
+Default: `'admin'`
+
+Valid options: A password string.
+
 ## Limitations
 
 - Tested on CentOS 7 and Ubuntu 16.04.
@@ -363,14 +393,6 @@ OpenDaylight Puppet module.
 See the [CHANGELOG][15] or our [git tags][16] for information about releases.
 See our [git commit history][17] for contributor information.
 
-[1]: https://travis-ci.org/dfarrell07/puppet-opendaylight
-
-[2]: https://gemnasium.com/dfarrell07/puppet-opendaylight
-
-[4]: https://travis-ci.org/dfarrell07/puppet-opendaylight.svg?branch=master
-
-[5]: https://gemnasium.com/dfarrell07/puppet-opendaylight.svg?branch=master
-
 [7]: http://www.opendaylight.org/
 
 [8]: https://github.com/dfarrell07/puppet-opendaylight/blob/master/CONTRIBUTING.markdown#issues
@@ -393,6 +415,6 @@ See our [git commit history][17] for contributor information.
 
 [18]: http://cbs.centos.org/repos/nfv7-opendaylight-40-release/x86_64/os/Packages/ "OpenDaylight Beryllium CentOS CBS repo"
 
-[18]: https://wiki.opendaylight.org/view/Deployment#RPM "OpenDaylight RPMs and their repos"
+[19]: https://wiki.opendaylight.org/view/Deployment#RPM "OpenDaylight RPMs and their repos"
 
 [20]: https://launchpad.net/~odl-team/+archive/ubuntu/boron