General refactoring of in-class docs.

- Touches most manifests' class-level docs.
- Closes #49

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

diff --git a/manifests/config.pp b/manifests/config.pp
index 289ff060b6ca0ac553a7223db80e7a90647844b4..f940ec3c938d08b5c40bcc9658f2311a8019fb31 100644 (file)
--- a/manifests/config.pp
+++ b/manifests/config.pp
@@ -1,22 +1,30 @@
 # == Class opendaylight::config
 #
-# This class is called from opendaylight for service config.
+# This class handles ODL config changes.
+# It's called from the opendaylight class.
+#
+# === Parameters
+# [*odl_rest_port *]
+#   Port for ODL northbound REST interface to listen on.
 #
 class opendaylight::config (
   $odl_rest_port = $::opendaylight::params::odl_rest_port
 ) inherits ::opendaylight::params {
-  # This is very fragile, but I don't know of a better way to do it.
-  # Updated ODL versions will break it, as will changes to the file upstream.
+  # Ideally, ODL's version wouldn't be in the path, to make this more robust
   file { 'org.apache.karaf.features.cfg':
     ensure  => file,
     path    => '/opt/opendaylight-0.2.2/etc/org.apache.karaf.features.cfg',
     content => template('opendaylight/org.apache.karaf.features.cfg.erb'),
   }
-  
+
+  # TODO: Is this include needed?
   include stdlib
+  # TODO: Better var name (this is from PR #35)
+  # TODO: Consider moving to a template, for consistency
   $myline= "    <Connector port=\"${odl_rest_port}\" protocol=\"HTTP/1.1\""
   file_line { 'tomcatport':
     ensure => present,
+    # Ideally, ODL's version wouldn't be in the path, to make this more robust
     path   => '/opt/opendaylight-0.2.2/configuration/tomcat-server.xml',
     line   => $myline,
     match  => '^\s*<Connector\s*port=\"[0-9]+\"\s*protocol=\"HTTP\/1.1\"$',

diff --git a/manifests/init.pp b/manifests/init.pp
index 5474c7ff021584b7063193830ad23391d782d7b3..c65045c35382b1899efd13d73e39af747b8837b7 100644 (file)
--- a/manifests/init.pp
+++ b/manifests/init.pp
@@ -7,6 +7,8 @@
 #   Features that should normally be installed by default, but can be overridden.
 # [*extra_features*]
 #   List of features to install in addition to the default ones.
+# [*odl_rest_port *]
+#   Port for ODL northbound REST interface to listen on.
 # [*install_method *]
 #   How to install OpenDaylight. Current options are "rpm" and "tarball", default is RPM.
 # [*tarball_url*]

diff --git a/manifests/install.pp b/manifests/install.pp
index 2bd1bc1c5c8144ec3a27c34e9974e87f52217c31..a6e5adda1a06c56eb4028b6c8f1b0ad43eabae04 100644 (file)
--- a/manifests/install.pp
+++ b/manifests/install.pp
@@ -1,6 +1,6 @@
 # == Class opendaylight::install
 #
-# This class is called from opendaylight for install.
+# Manages the installation of OpenDaylight.
 #
 class opendaylight::install {
   if $opendaylight::install_method == 'rpm' {

diff --git a/manifests/params.pp b/manifests/params.pp
index f116350c646529366c1a33cf5818a80941e1b369..327c5854aae04046a7a47ba2f36d9f01e14b83b5 100644 (file)
--- a/manifests/params.pp
+++ b/manifests/params.pp
@@ -1,7 +1,6 @@
 # == Class opendaylight::params
 #
-# This class is meant to be called from opendaylight.
-# It sets variables according to platform.
+# This class manages the default params for the ODL class.
 #
 class opendaylight::params {
   $default_features = ['config', 'standard', 'region', 'package', 'kar', 'ssh', 'management']

diff --git a/manifests/service.pp b/manifests/service.pp
index 0e744a792425e8e0c6b5819d93e5eb6d3ff71133..7f8786e54368479ef8db25a36e4878ce10a2c9b1 100644 (file)
--- a/manifests/service.pp
+++ b/manifests/service.pp
@@ -1,7 +1,6 @@
 # == Class opendaylight::service
 #
-# This class is meant to be called from opendaylight.
-# It ensure the service is running.
+# Starts the OpenDaylight systemd service.
 #
 class opendaylight::service {
   service { 'opendaylight':