Add docs for configuring ODL's NB REST API port

Closes #11

Change-Id: Ie0ef900e9b0b33f13cc6a2bb24834fa1193c9007
Signed-off-by: Daniel Farrell <dfarrell@redhat.com>

diff --git a/README.markdown b/README.markdown
index a1e6a321e9f8a19da57ef1fa53a7311879a495ee..8a0af699365ce65acf97e17821b3dca1fdbc1523 100644 (file)
--- a/README.markdown
+++ b/README.markdown
@@ -16,6 +16,10 @@ To set extra Karaf features to be installed at OpenDaylight start time, pass the
 
 OpenDaylight normally installs a default set of Karaf features at boot. They are recommended, so the ODL Puppet mod defaults to installing them. This can be customized by overriding the `default_features` param. You shouldn't normally need to do so.
 
+### REST API Port
+
+To change the port on which OpenDaylight's northbound listens for REST API calls, use the `odl_rest_port` param. This was added because OpenStack's Swift project uses a conflicting port.
+
 ## Dependencies
 
 The OpenDaylight Ansible role doesn't depend on any other Ansible roles.