Add puppet-lint-param-docs plugins to puppet-lint

- This puppet-lint plugin checks if all parameters are documented - Fix some unaligned arrows - https://github.com/domcleal/puppet-lint-param-docs Change-Id: I5e73747b726191bc4fc55e6e227892507e185871 Signed-off-by: Gael Chamoulaud <[email protected]>
xbezdick · Nov 13, 2014 · 45a35dc · 45a35dc
1 parent fd34b59
commit 45a35dc
Show file tree

Hide file tree

Showing 15 changed files with 565 additions and 278 deletions.
diff --git a/Gemfile b/Gemfile
@@ -2,7 +2,8 @@ source 'https://rubygems.org'
 
 group :development, :test do
   gem 'puppetlabs_spec_helper', :require => false
-  gem 'puppet-lint', '~> 0.3.2'
+  gem 'puppet-lint', '~> 1.1'
+  gem 'puppet-lint-param-docs', '1.1.0'
   gem 'rake', '10.1.1'
 end
 

diff --git a/manifests/api-cfn.pp b/manifests/api-cfn.pp
@@ -1,5 +1,38 @@
+# == Class: heat::api-cfn
+#
+# WARNING: Deprecated class. Use heat::api_cfn instead !
 # Installs & configure the heat CloudFormation API service
 #
+# === Parameters
+# [*enabled*]
+#   (Optional) Should the service be enabled.
+#   Defaults to 'true'.
+#
+# [*keystone_host*]
+#
+# [*keystone_port*]
+#
+# [*keystone_protocol*]
+#
+# [*keystone_user*]
+#
+# [*keystone_tenant*]
+#
+# [*keystone_password*]
+#
+# [*keystone_ec2_uri*]
+#
+# [*auth_uri*]
+#
+# [*bind_host*]
+#
+# [*bind_port*]
+#
+# [*verbose*]
+#
+# [*debug*]
+#
+#
 class heat::api-cfn (
   $enabled           = true,
   $keystone_host     = '127.0.0.1',

diff --git a/manifests/api-cloudwatch.pp b/manifests/api-cloudwatch.pp
@@ -1,5 +1,38 @@
+# == Class: heat::api-cloudwatch
+#
+# WARNING: Deprecated class. Use heat::api_cloudwatch instead !
 # Installs & configure the heat CloudWatch API service
 #
+# === Parameters
+# [*enabled*]
+#   (Optional) Should the service be enabled.
+#   Defaults to 'true'.
+#
+# [*keystone_host*]
+#
+# [*keystone_port*]
+#
+# [*keystone_protocol*]
+#
+# [*keystone_user*]
+#
+# [*keystone_tenant*]
+#
+# [*keystone_password*]
+#
+# [*keystone_ec2_uri*]
+#
+# [*auth_uri*]
+#
+# [*bind_host*]
+#
+# [*bind_port*]
+#
+# [*verbose*]
+#
+# [*debug*]
+#
+#
 class heat::api-cloudwatch (
   $enabled           = true,
   $keystone_host     = '127.0.0.1',

diff --git a/manifests/api.pp b/manifests/api.pp
@@ -1,13 +1,46 @@
+# == Class: heat::api
+#
 # Installs & configure the heat API service
 #
-# == Parameters
-#  [*enabled*]
-#    (optional) Should the service be enabled.
-#    Defaults to true
+# === Parameters
+# [*enabled*]
+#   (optional) Should the service be enabled.
+#   Defaults to 'true'.
+#
+# [*manage_service*]
+#   (optional) Whether the service should be managed by Puppet.
+#   Defaults to 'true'.
+#
+# [*bind_host*]
+#   (Optional) Address to bind the server. Useful when
+#   selecting a particular network interface.
+#   Defaults to '0.0.0.0'.
+#
+# [*bind_port*]
+#   (Optional) The port on which the server will listen.
+#   Defaults to '8004'.
+#
+# [*workers*]
+#   (Optional) The port on which the server will listen.
+#   Defaults to '0'.
+#
+# [*use_ssl*]
+#   (Optional) Whether to use ssl or not.
+#   Defaults to 'false'.
+#
+# [*cert_file*]
+#   (Optional) Location of the SSL certificate file to use for SSL mode.
+#   Required when $use_ssl is set to 'true'.
+#   Defaults to 'false'.
+#
+# [*key_file*]
+#   (Optional) Location of the SSL key file to use for enabling SSL mode.
+#   Required when $use_ssl is set to 'true'.
+#   Defaults to 'false'.
+#
+# === Deprecated Parameters
 #
-#  [*manage_service*]
-#    (optional) Whether the service should be managed by Puppet.
-#    Defaults to true.
+# No Deprecated Parameters.
 #
 class heat::api (
   $manage_service    = true,

diff --git a/manifests/api_cfn.pp b/manifests/api_cfn.pp
@@ -1,13 +1,49 @@
+# == Class: heat::api_cfn
+#
+# This class deprecates heat::api-cfn.
+#
 # Installs & configure the heat CloudFormation API service
 #
-# == Parameters
-#  [*enabled*]
-#    (optional) Should the service be enabled.
-#    Defaults to true
+# === Parameters
+#
+# [*enabled*]
+#   (optional) Should the service be enabled.
+#   Defaults to 'true'.
+#
+# [*manage_service*]
+#   (optional) Whether the service should be managed by Puppet.
+#   Defaults to 'true'.
+#
+# [*bind_host*]
+#   (Optional) Address to bind the server. Useful when
+#   selecting a particular network interface.
+#   Defaults to '0.0.0.0'.
+#
+# [*bind_port*]
+#   (Optional) The port on which the server will listen.
+#   Defaults to '8000'.
+#
+# [*workers*]
+#   (Optional) The port on which the server will listen.
+#   Defaults to '0'.
+#
+# [*use_ssl*]
+#   (Optional) Whether to use ssl or not.
+#   Defaults to 'false'.
+#
+# [*cert_file*]
+#   (Optional) Location of the SSL certificate file to use for SSL mode.
+#   Required when $use_ssl is set to 'true'.
+#   Defaults to 'false'.
+#
+# [*key_file*]
+#   (Optional) Location of the SSL key file to use for enabling SSL mode.
+#   Required when $use_ssl is set to 'true'.
+#   Defaults to 'false'.
+#
+# == Deprecated Parameters
 #
-#  [*manage_service*]
-#    (optional) Whether the service should be managed by Puppet.
-#    Defaults to true.
+# No Deprecated Parameters.
 #
 class heat::api_cfn (
   $manage_service    = true,

diff --git a/manifests/api_cloudwatch.pp b/manifests/api_cloudwatch.pp
@@ -1,13 +1,48 @@
+# == Class: heat::api_cloudwatch
+#
+# This class deprecates heat::api-cloudwatch
+#
 # Installs & configure the heat CloudWatch API service
 #
-# == Parameters
-#  [*enabled*]
-#    (optional) Should the service be enabled.
-#    Defaults to true
+# === Parameters
+# [*enabled*]
+#   (optional) Should the service be enabled.
+#   Defaults to true.
+#
+# [*manage_service*]
+#   (optional) Whether the service should be managed by Puppet.
+#   Defaults to true.
+#
+# [*bind_host*]
+#   (Optional) Address to bind the server. Useful when
+#   selecting a particular network interface.
+#   Defaults to '0.0.0.0'.
+#
+# [*bind_port*]
+#   (Optional) The port on which the server will listen.
+#   Defaults to '8003'.
+#
+# [*workers*]
+#   (Optional) The port on which the server will listen.
+#   Defaults to '0'.
+#
+# [*use_ssl*]
+#   (Optional) Whether to use ssl or not.
+#   Defaults to 'false'.
+#
+# [*cert_file*]
+#   (Optional) Location of the SSL certificate file to use for SSL mode.
+#   Required when $use_ssl is set to 'true'.
+#   Defaults to 'false'.
+#
+# [*key_file*]
+#   (Optional) Location of the SSL key file to use for enabling SSL mode.
+#   Required when $use_ssl is set to 'true'.
+#   Defaults to 'false'.
+#
+# == Deprecated Parameters
 #
-#  [*manage_service*]
-#    (optional) Whether the service should be managed by Puppet.
-#    Defaults to true.
+# No Deprecated Parameters.
 #
 class heat::api_cloudwatch (
   $manage_service    = true,

diff --git a/manifests/client.pp b/manifests/client.pp
@@ -1,9 +1,11 @@
+# == Class: heat::client
 #
 # Installs the heat python library.
 #
-# == parameters
-#  [*ensure*]
-#    ensure state for pachage.
+# === Parameters
+#
+# [*ensure*]
+#   (Optional) Ensure state for package.
 #
 class heat::client (
   $ensure = 'present'

diff --git a/manifests/db/mysql.pp b/manifests/db/mysql.pp
@@ -1,35 +1,43 @@
+# == Class: heat::db::mysql
+#
 # The heat::db::mysql class creates a MySQL database for heat.
 # It must be used on the MySQL server
 #
-# == Parameters
+# === Parameters
+#
+# [*password*]
+#   (Mandatory) Password to connect to the database.
+#   Defaults to 'false'.
 #
-#  [*password*]
-#    password to connect to the database. Mandatory.
+# [*dbname*]
+#   (Optional) Name of the database.
+#   Defaults to 'heat'.
 #
-#  [*dbname*]
-#    name of the database. Optional. Defaults to heat.
+# [*user*]
+#   (Optional) User to connect to the database.
+#   Defaults to 'heat'.
 #
-#  [*user*]
-#    user to connect to the database. Optional. Defaults to heat.
+# [*host*]
+#   (Optional) The default source host user is allowed to connect from.
+#   Defaults to '127.0.0.1'
 #
-#  [*host*]
-#    the default source host user is allowed to connect from.
-#    Optional. Defaults to 'localhost'
+# [*allowed_hosts*]
+#   (Optional) Other hosts the user is allowed to connect from.
+#   Defaults to 'undef'.
 #
-#  [*allowed_hosts*]
-#    other hosts the user is allowd to connect from.
-#    Optional. Defaults to undef.
+# [*charset*]
+#   (Optional) The database charset.
+#   Defaults to 'utf8'
 #
-#  [*charset*]
-#    the database charset. Optional. Defaults to 'utf8'
+# [*collate*]
+#   (Optional) The database collate.
+#   Only used with mysql modules >= 2.2.
+#   Defaults to 'utf8_unicode_ci'
 #
-#  [*collate*]
-#    the database collate. Optional. Only used with mysql modules
-#    >=  2.2
-#    Defaults to 'utf8_unicode_ci'
+# === Deprecated Parameters
 #
-#  [*mysql_module*]
-#   (optional) Deprecated. Does nothing.
+# [*mysql_module*]
+#   (Optional) Does nothing.
 #
 class heat::db::mysql(
   $password      = false,