Add missing puppetdoc and lint all parameter documentation

Un-pin puppet-lint gem and add puppet-lint-param-docs, this commit also
add missing puppetdoc.

Change-Id: Id9843816fc3106f4d2e2052e1cdf4fd18efc194b
This commit is contained in:
Sebastien Badia
2015-03-15 22:01:55 +01:00
committed by Gael Chamoulaud
parent 70d33d7a68
commit cc70740a31
9 changed files with 49 additions and 12 deletions

View File

@@ -4,7 +4,7 @@ group :development, :test do
gem 'puppetlabs_spec_helper', :require => false gem 'puppetlabs_spec_helper', :require => false
gem 'metadata-json-lint' gem 'metadata-json-lint'
gem 'puppet-lint', '~> 1.1.0' gem 'puppet-lint-param-docs'
gem 'puppet-lint-absolute_classname-check' gem 'puppet-lint-absolute_classname-check'
gem 'puppet-lint-absolute_template_path' gem 'puppet-lint-absolute_template_path'
gem 'puppet-lint-trailing_newline-check' gem 'puppet-lint-trailing_newline-check'

View File

@@ -16,9 +16,12 @@
# License for the specific language governing permissions and limitations # License for the specific language governing permissions and limitations
# under the License. # under the License.
# #
# The nova::cells class installs the Nova Cells # == Class: nova::cells
#
# Installs the Nova Cells
#
# === Parameters:
# #
# == Parameters
# [*enabled*] # [*enabled*]
# Use Nova Cells or not # Use Nova Cells or not
# Defaults to 'False' # Defaults to 'False'
@@ -35,6 +38,10 @@
# Cells communication driver to use # Cells communication driver to use
# Defaults to 'nova.cells.rpc_driver.CellsRPCDriver' # Defaults to 'nova.cells.rpc_driver.CellsRPCDriver'
# #
# [*ensure_package*]
# Desired ensure state of packages.
# Defaults to present
#
# [*instance_updated_at_threshold*] # [*instance_updated_at_threshold*]
# Number of seconds after an instance was updated or deleted to continue to update cells # Number of seconds after an instance was updated or deleted to continue to update cells
# Defaults to '3600' # Defaults to '3600'
@@ -133,7 +140,6 @@
# It might be used by some cell scheduling code in the future # It might be used by some cell scheduling code in the future
# Defaults to '1.0' # Defaults to '1.0'
# #
class nova::cells ( class nova::cells (
$bandwidth_update_interval = '600', $bandwidth_update_interval = '600',
$call_timeout = '60', $call_timeout = '60',

View File

@@ -99,7 +99,7 @@
# (optional) The availability zone to show internal services under. # (optional) The availability zone to show internal services under.
# Defaults to internal # Defaults to internal
# #
# [*pci_passthrough_whitelist*] # [*pci_passthrough*]
# (optional) Pci passthrough hash in format of: # (optional) Pci passthrough hash in format of:
# Defaults to undef # Defaults to undef
# Example # Example

View File

@@ -4,7 +4,7 @@
# #
# === Parameters: # === Parameters:
# #
# [*port_range] # [*port_range*]
# (optional) Range of TCP ports to use for serial ports on compute hosts # (optional) Range of TCP ports to use for serial ports on compute hosts
# Defaults to 10000:20000 # Defaults to 10000:20000
# #
@@ -12,7 +12,7 @@
# (optional) URL that gets passed to the clients # (optional) URL that gets passed to the clients
# Defaults to 'ws://127.0.0.1:6083/' # Defaults to 'ws://127.0.0.1:6083/'
# #
# [*listen] # [*listen*]
# IP address on which instance serial console should listen # IP address on which instance serial console should listen
# Defaults to 127.0.0.1 # Defaults to 127.0.0.1
# #
@@ -20,8 +20,7 @@
# The address to which proxy clients (like nova-serialproxy) # The address to which proxy clients (like nova-serialproxy)
# should connect (string value) # should connect (string value)
# Defaults to 127.0.0.1 # Defaults to 127.0.0.1
#
class nova::compute::serial( class nova::compute::serial(
$port_range = '10000:20000', $port_range = '10000:20000',
$base_url = 'ws://127.0.0.1:6083/', $base_url = 'ws://127.0.0.1:6083/',

View File

@@ -20,6 +20,13 @@
# NOTE: The configuration MUST NOT be already handled by this module # NOTE: The configuration MUST NOT be already handled by this module
# or Puppet catalog compilation will fail with duplicate resources. # or Puppet catalog compilation will fail with duplicate resources.
# #
# [*nova_paste_api_ini*]
# (optional) Allow configuration of arbitrary Nova paste api configurations.
# The value is an hash of nova_paste_api_ini resources. Example:
# { 'DEFAULT/foo' => { value => 'fooValue'},
# 'DEFAULT/bar' => { value => 'barValue'}
# }
#
class nova::config ( class nova::config (
$nova_config = {}, $nova_config = {},
$nova_paste_api_ini = {}, $nova_paste_api_ini = {},

View File

@@ -68,6 +68,10 @@
# (optional) Connect over SSL for RabbitMQ # (optional) Connect over SSL for RabbitMQ
# Defaults to false # Defaults to false
# #
# [*rabbit_ha_queues*]
# (optional) Use HA queues in RabbitMQ.
# Defaults to undef
#
# [*kombu_ssl_ca_certs*] # [*kombu_ssl_ca_certs*]
# (optional) SSL certification authority file (valid only if SSL enabled). # (optional) SSL certification authority file (valid only if SSL enabled).
# Defaults to undef # Defaults to undef
@@ -122,6 +126,10 @@
# (optional) Disable Nagle algorithm # (optional) Disable Nagle algorithm
# Defaults to true # Defaults to true
# #
# [*auth_strategy*]
# (optional) The strategy to use for auth: noauth or keystone.
# Defaults to 'keystone'
#
# [*service_down_time*] # [*service_down_time*]
# (optional) Maximum time since last check-in for up service. # (optional) Maximum time since last check-in for up service.
# Defaults to 60 # Defaults to 60
@@ -144,6 +152,10 @@
# (optional) Set log output to verbose output. # (optional) Set log output to verbose output.
# Defaults to false # Defaults to false
# #
# [*debug*]
# (optional) Set log output to debug output.
# Defaults to false
#
# [*periodic_interval*] # [*periodic_interval*]
# (optional) Seconds between running periodic tasks. # (optional) Seconds between running periodic tasks.
# Defaults to '60' # Defaults to '60'
@@ -152,6 +164,10 @@
# (optional) Interval at which nodes report to data store. # (optional) Interval at which nodes report to data store.
# Defaults to '10' # Defaults to '10'
# #
# [*rootwrap_config*]
# (optional) Path to the rootwrap configuration file to use for running commands as root
# Defaults to '/etc/nova/rootwrap.conf'
#
# [*monitoring_notifications*] # [*monitoring_notifications*]
# (optional) Whether or not to send system usage data notifications out on the message queue. Only valid for stable/essex. # (optional) Whether or not to send system usage data notifications out on the message queue. Only valid for stable/essex.
# Defaults to false # Defaults to false
@@ -164,6 +180,10 @@
# (optional) Syslog facility to receive log lines. # (optional) Syslog facility to receive log lines.
# Defaults to 'LOG_USER' # Defaults to 'LOG_USER'
# #
# [*install_utilities*]
# (optional) Install nova utilities (Extra packages used by nova tools)
# Defaults to true,
#
# [*use_ssl*] # [*use_ssl*]
# (optional) Enable SSL on the API server # (optional) Enable SSL on the API server
# Defaults to false, not set # Defaults to false, not set
@@ -228,6 +248,7 @@
# and you have multiple endpoints, you will get AmbiguousEndpoint # and you have multiple endpoints, you will get AmbiguousEndpoint
# exceptions in the nova API service. # exceptions in the nova API service.
# Defaults to undef # Defaults to undef
#
class nova( class nova(
$ensure_package = 'present', $ensure_package = 'present',
$database_connection = false, $database_connection = false,

View File

@@ -26,6 +26,10 @@
# split into. # split into.
# Defaults to 1 # Defaults to 1
# #
# [*network_size*]
# (optional) Number of addresses in each private subnet.
# Defaults to 255
#
# [*floating_range*] # [*floating_range*]
# (optional) Range of floating ip addresses to create. # (optional) Range of floating ip addresses to create.
# Defaults to false # Defaults to false

View File

@@ -7,7 +7,7 @@
# [*fixed_range*] # [*fixed_range*]
# (required) The IPv4 CIDR for the network # (required) The IPv4 CIDR for the network
# #
# [flat_interface] # [*flat_interface*]
# (optional) Interface that flat network will use for bridging # (optional) Interface that flat network will use for bridging
# Defaults to undef # Defaults to undef
# #
@@ -15,7 +15,7 @@
# (optional) The interface to use for public traffic # (optional) The interface to use for public traffic
# Defaults to undef # Defaults to undef
# #
# [flat_network_bridge] # [*flat_network_bridge*]
# (optional) The name of the bridge to use # (optional) The name of the bridge to use
# Defaults to 'br100' # Defaults to 'br100'
# #

View File

@@ -40,7 +40,7 @@
# (optional) Ignore hosts that have too many instances # (optional) Ignore hosts that have too many instances
# Defaults to '50' # Defaults to '50'
# #
# [*ram_allocation_ratio:*] # [*ram_allocation_ratio*]
# (optional) Virtual ram to physical ram allocation ratio # (optional) Virtual ram to physical ram allocation ratio
# Defaults to '1.5' # Defaults to '1.5'
# #