Fix lint issues (doc, metadata, manifests)

Add puppet parameters lint (with puppet-lint-param-docs gem) and fix
missing documentations, this commit also fix manifest lint issues (due
to puppet-lint upgrade) and metadata.json file (SPDX license, and open
dependencies).

Change-Id: If0cfefec6b2c6865a3078d91a40326082825f8ec
(cherry picked from commit bc443c3248ec755539ab6e1d0a8b069057a0fdd1)

diff --git a/Gemfile b/Gemfile
index cfb5bf25212c109087328e1a07fb1ea2d8aa2428..7cd12c5f1b238d86ca6d9b75b2a5d8e2213b9a8b 100644 (file)
--- a/Gemfile
+++ b/Gemfile
@@ -2,8 +2,8 @@ source 'https://rubygems.org'
 
 group :development, :test do
   gem 'puppetlabs_spec_helper', :require => false
-  gem 'puppet-lint', '~> 0.3.2'
   gem 'rspec-puppet', '~> 2.0.0'
+  gem 'puppet-lint-param-docs'
   gem 'metadata-json-lint'
   gem 'json'
   gem 'webmock'

diff --git a/manifests/api.pp b/manifests/api.pp
index c3789cb04121f5fb0fea52c1391a53ecb3bd96c3..d85104dcddf11848dccc92ba8d5f71c42af5989a 100644 (file)
--- a/manifests/api.pp
+++ b/manifests/api.pp
@@ -1,6 +1,7 @@
 # Installs & configure the ceilometer api service
 #
 # == Parameters
+#
 #  [*enabled*]
 #    (optional) Should the service be enabled.
 #    Defaults to true
@@ -9,6 +10,10 @@
 #    (optional) Whether the service should be managed by Puppet.
 #    Defaults to true.
 #
+# [*keystone_user*]
+#   (optional) The name of the auth user
+#   Defaults to ceilometer
+#
 #  [*keystone_host*]
 #    (optional) Keystone's admin endpoint IP/Host.
 #    Defaults to '127.0.0.1'
@@ -39,6 +44,10 @@
 #    Password to authenticate with.
 #    Mandatory.
 #
+# [*keystone_auth_uri*]
+#   (optional) Public Identity API endpoint.
+#   Defaults to 'false'.
+#
 #  [*host*]
 #    (optional) The ceilometer api bind address.
 #    Defaults to 0.0.0.0
@@ -51,7 +60,6 @@
 #    (optional) ensure state for package.
 #    Defaults to 'present'
 #
-
 class ceilometer::api (
   $manage_service             = true,
   $enabled                    = true,

diff --git a/manifests/init.pp b/manifests/init.pp
index 823fc5b017c58c5c086f90a1b4f0e05112d758f8..b45a5ff8e9b4cbbfb86db6f847075440e1f9bdb9 100644 (file)
--- a/manifests/init.pp
+++ b/manifests/init.pp
@@ -3,8 +3,12 @@
 #  ceilometer base package & configuration
 #
 # == parameters
+#
 #  [*metering_secret*]
 #    secret key for signing messages. Mandatory.
+#  [*notification_topics*]
+#    AMQP topic used for OpenStack notifications (list value)
+#    Defaults to 'notifications'
 #  [*package_ensure*]
 #    ensure state for package. Optional. Defaults to 'present'
 #  [*debug*]
@@ -70,7 +74,6 @@
 # [*qpid_reconnect_interval_max*]
 # (optional) various QPID options
 #
-
 class ceilometer(
   $metering_secret     = false,
   $notification_topics = ['notifications'],
@@ -141,16 +144,16 @@ class ceilometer(
   }
 
   file { '/etc/ceilometer/':
-    ensure  => directory,
-    owner   => 'ceilometer',
-    group   => 'ceilometer',
-    mode    => '0750',
+    ensure => directory,
+    owner  => 'ceilometer',
+    group  => 'ceilometer',
+    mode   => '0750',
   }
 
   file { '/etc/ceilometer/ceilometer.conf':
-    owner   => 'ceilometer',
-    group   => 'ceilometer',
-    mode    => '0640',
+    owner => 'ceilometer',
+    group => 'ceilometer',
+    mode  => '0640',
   }
 
   package { 'ceilometer-common':

diff --git a/manifests/wsgi/apache.pp b/manifests/wsgi/apache.pp
index 8171512d47ece73e9e3a4cd27141103381ab6c8f..d3d62959eb0cd466af3b4aa70852e2b216c7ef69 100644 (file)
--- a/manifests/wsgi/apache.pp
+++ b/manifests/wsgi/apache.pp
@@ -49,6 +49,14 @@
 #     Number of WSGI workers to spawn.
 #     Optional. Defaults to 1
 #
+#   [*priority*]
+#     (optional) The priority for the vhost.
+#     Defaults to '10'
+#
+#   [*threads*]
+#     (optional) The number of threads for the vhost.
+#     Defaults to $::processorcount
+#
 #   [*ssl_cert*]
 #   [*ssl_key*]
 #   [*ssl_chain*]

diff --git a/metadata.json b/metadata.json
index 3d52cb623c7c03ec8058933cae76400bae84e9d1..dc22c445b433b392e87ca1572e7e5c84529e88da 100644 (file)
--- a/metadata.json
+++ b/metadata.json
@@ -3,7 +3,7 @@
   "version": "5.0.0",
   "author": "eNovance and StackForge Contributors",
   "summary": "Puppet module for OpenStack Ceilometer",
-  "license": "Apache License 2.0",
+  "license": "Apache-2.0",
   "source": "git://github.com/stackforge/puppet-ceilometer.git",
   "project_page": "https://launchpad.net/puppet-ceilometer",
   "issues_url": "https://bugs.launchpad.net/puppet-ceilometer",
@@ -35,6 +35,6 @@
     { "name": "puppetlabs/inifile", "version_requirement": ">=1.0.0 <2.0.0" },
     { "name": "stackforge/keystone", "version_requirement": ">=5.0.0 <6.0.0" },
     { "name": "puppetlabs/stdlib", "version_requirement": ">=4.0.0 <5.0.0" },
-    { "name": "stackforge/openstacklib", "version_requirement": ">=5.0.0" }
+    { "name": "stackforge/openstacklib", "version_requirement": ">=5.0.0 <6.0.0" }
   ]
 }