From fc81f5ffcda3bbae4a630ab743f145abb0bba679 Mon Sep 17 00:00:00 2001
From: Daniel Farrell <dfarrell@redhat.com>
Date: Tue, 2 Feb 2016 12:28:14 -0500
Subject: [PATCH] Add docs for ODL OVSDB enable/disable L3 param

Adds docs for enable_l3 param.

Relevant to #87.

Change-Id: I11570dca605910de5e74846db6e6d80f22d80e98
Signed-off-by: Daniel Farrell <dfarrell@redhat.com>
---
 README.markdown               | 39 +++++++++++++++++++++++++++++++++++
 manifests/init.pp             |  2 ++
 spec/acceptance/class_spec.rb |  1 -
 3 files changed, 41 insertions(+), 1 deletion(-)

diff --git a/README.markdown b/README.markdown
index e4944d8..65289d3 100644
--- a/README.markdown
+++ b/README.markdown
@@ -14,6 +14,8 @@
   * [Karaf Features](#karaf-features)
   * [Install Method](#install-method)
   * [Ports](#ports)
+  * [Log Verbosity](#log-verbosity)
+  * [Enabling ODL OVSDB L3](#enabling-odl-ovsdb-l3)
 1. [Reference ](#reference)
 1. [Limitations](#limitations)
 1. [Development](#development)
@@ -171,6 +173,16 @@ class { 'opendaylight':
 }
 ```
 
+### Enabling ODL OVSDB L3
+
+To enable the ODL OVSDB L3, use the `enable_l3` flag. It's disabled by default.
+
+```puppet
+class { 'opendaylight':
+  enable_l3 => 'yes',
+}
+```
+
 ## Reference
 
 ### Classes
@@ -269,6 +281,33 @@ org.opendaylight.ovsdb.lib | INFO
 
 The main log output file is `/opt/opendaylight/data/log/karaf.log`.
 
+##### `enable_l3`
+
+Enable or disable ODL OVSDB L3 forwarding.
+
+Default: `'no'`
+
+Valid options: The strings 'yes' or 'no'.
+
+Boolean values are not currently supported, but that feature may be added.
+
+The ODL OVSDB L3 config in `/opt/opendaylight/etc/custom.properties` is set to
+the value of the `enable_l3` param.
+
+A manifest like
+
+```puppet
+class { 'opendaylight':
+  enable_l3 => 'yes',
+}
+```
+
+Would would result in
+
+```
+ovsdb.l3.fwd.enabled=yes
+```
+
 ##### `tarball_url`
 
 Specifies the ODL tarball to use when installing via the tarball install
diff --git a/manifests/init.pp b/manifests/init.pp
index c0a134a..b8308d8 100644
--- a/manifests/init.pp
+++ b/manifests/init.pp
@@ -15,6 +15,8 @@
 #   If installing from a tarball, use this one. Defaults to latest ODL.
 # [*unitfile_url*]
 #   OpenDaylight .service file to use for tarball installs. Defaults to one used by ODL RPM.
+# [*enable_l3*]
+#   Enable or disable ODL OVSDB ML2 L3 forwarding. Valid options are 'yes' and 'no'.
 # [*log_levels*]
 #   Custom OpenDaylight logger verbosity configuration (TRACE, DEBUG, INFO, WARN, ERROR).
 #
diff --git a/spec/acceptance/class_spec.rb b/spec/acceptance/class_spec.rb
index f83459a..7570176 100644
--- a/spec/acceptance/class_spec.rb
+++ b/spec/acceptance/class_spec.rb
@@ -123,7 +123,6 @@ describe 'opendaylight class' do
     end
   end
 
-
   describe 'testing ODL OVSDB L3 config' do
     context 'using enable_l3 default' do
       # Call specialized helper fn to install OpenDaylight
-- 
2.36.6