Make parameter doc RDoc compatible

The patch fixes the parameter documentation in
api, cert, compute and client to conform with
the style guide and support autogenerating
paramter documentation.

Change-Id: I94c6807a18be5eb27697eaa060a0e885a7d44cbe

manifests/api.pp

@@ -1,27 +1,94 @@
+# == Class: nova::api
 #
-# installs and configures nova api service
+# Setup and configure the Nova API endpoint
 #
-# * admin_password
-# * enabled
-# * ensure_package
-# * auth_strategy
-# * auth_host
-# * auth_port
-# * auth_protocol
-# * auth_admin_prefix: path part of the auth url. Optional.
-#     This allow admin auth URIs like http://auth_host:35357/keystone/admin.
-#     (where '/keystone' is the admin prefix)
-#     Defaults to false for empty. If defined, should be a string with a leading '/' and no trailing '/'.
-# * admin_tenant_name
-# * admin_user
-# * enabled_apis
-# * use_forwarded_for:
-#     Treat X-Forwarded-For as the canonical remote address. Only
-#     enable this if you have a sanitizing proxy. (boolean value)
-#     (Optional). Defaults to false.
-# * neutron_metadata_proxy_shared_secret
-# * ratelimit
-# * ratelimit_factory
+# === Parameters
+#
+# [*admin_password*]
+#   (required) The password to set for the nova admin user in keystone
+#
+# [*enabled*]
+#   (optional) Whether the nova api service will be run
+#   Defaults to false
+#
+# [*ensure_package*]
+#   (optional) Whether the nova api package will be installed
+#   Defaults to 'present'
+#
+# [*auth_strategy*]
+#   (DEPRECATED) Does nothing and will be removed in Icehouse
+#   Defaults to false
+#
+# [*auth_host*]
+#   (optional) The IP of the server running keystone
+#   Defaults to '127.0.0.1'
+#
+# [*auth_port*]
+#   (optional) The port to use when authenticating against Keystone
+#   Defaults to 35357
+#
+# [*auth_protocol*]
+#   (optional) The protocol to use when authenticating against Keystone
+#   Defaults to 'http'
+#
+# [*auth_uri*]
+#   (optional) The uri of a Keystone service to authenticate against
+#   Defaults to false
+#
+# [*auth_admin_prefix*]
+#   (optional) Prefix to prepend at the beginning of the keystone path
+#   Defaults to false
+#
+# [*admin_tenant_name*]
+#   (optional) The name of the tenant to create in keystone for use by the nova services
+#   Defaults to 'services'
+#
+# [*admin_user*]
+#   (optional) The name of the user to create in keystone for use by the nova services
+#   Defaults to 'nova'
+#
+# [*api_bind_address*]
+#   (optional) IP address for nova-api server to listen
+#   Defaults to '0.0.0.0'
+#
+# [*metadata_listen*]
+#   (optional) IP address  for metadata server to listen
+#   Defaults to '0.0.0.0'
+#
+# [*enabled_apis*]
+#   (optional) A comma separated list of apis to enable
+#   Defaults to 'ec2,osapi_compute,metadata'
+#
+# [*volume_api_class*]
+#   (optional) The name of the class that nova will use to access volumes. Cinder is the only option.
+#   Defaults to 'nova.volume.cinder.API'
+#
+# [*use_forwarded_for*]
+#   (optional) Treat X-Forwarded-For as the canonical remote address. Only
+#   enable this if you have a sanitizing proxy.
+#   Defaults to false
+#
+# [*workers*]
+#   (optional) Number of workers for OpenStack API service
+#   Defaults to $::processorcount
+#
+# [*sync_db*]
+#   (optional) Run nova-manage db sync on api nodes after installing the package.
+#   Defaults to true
+#
+# [*neutron_metadata_proxy_shared_secret*]
+#   (optional) Shared secret to validate proxies Neutron metadata requests
+#   Defaults to undef
+#
+# [*ratelimits*]
+#   (optional) A string that is a semicolon-separated list of 5-tuples.
+#   See http://docs.openstack.org/trunk/config-reference/content/configuring-compute-API.html
+#   Example: '(POST, "*", .*, 10, MINUTE);(POST, "*/servers", ^/servers, 50, DAY);(PUT, "*", .*, 10, MINUTE)'
+#   Defaults to undef
+#
+# [*ratelimits_factory*]
+#   (optional) The rate limiting factory to use
+#   Defaults to 'nova.api.openstack.compute.limits:RateLimitingMiddleware.factory'
 #
 class nova::api(
   $admin_password,

manifests/cert.pp

@@ -1,5 +1,16 @@
+# == Class: nova::cert
 #
-# installs nova cert package and service
+# Installs nova cert package and service
+#
+# === Parameters:
+#
+# [*enabled*]
+#   (optional) Whether or not to enable the nova cert service
+#   Defaults to false
+#
+# [*ensure_package*]
+#   (optional) The state to set for the nova-cert package
+#   Defaults to 'present'
 #
 class nova::cert(
   $enabled        = false,

manifests/client.pp

@@ -1,6 +1,13 @@
+# == Class nova::client
 #
 # installs nova client
 #
+# === Parameters:
+#
+# [*ensure*]
+#   (optional) The state for the nova client package
+#   Defaults to 'present'
+#
 class nova::client(
   $ensure = 'present'
 ) {

manifests/compute.pp

@@ -1,5 +1,54 @@
-#schedulee this class should probably never be declared except
-# from the virtualization implementation of the compute node
+# == Class: nova::compute
+#
+# Installs the nova-compute service
+#
+# === Parameters:
+#
+# [*enabled*]
+#   (optional) Whether to enable the nova-compute service
+#   Defaults to false
+#
+# [*ensure_package*]
+#   (optional) The state for the nova-compute package
+#   Defaults to 'present'
+#
+# [*vnc_enabled*]
+#   (optional) Whether to use a VNC proxy
+#   Defaults to true
+#
+# [*vncserver_proxyclient_address*]
+#   (optional) The IP address of the server running the VNC proxy client
+#   Defaults to '127.0.0.1'
+#
+# [*vncproxy_host*]
+#   (optional) The host of the VNC proxy server
+#   Defaults to false
+#
+# [*vncproxy_protocol*]
+#   (optional) The protocol to communicate with the VNC proxy server
+#   Defaults to 'http'
+#
+# [*vncproxy_port*]
+#   (optional) The port to communicate with the VNC proxy server
+#   Defaults to '6080'
+#
+# [*vncproxy_path*]
+#   (optional) The path at the end of the uri for communication with the VNC proxy server
+#   Defaults to './vnc_auto.html'
+#
+# [*force_config_drive*]
+#   (optional) Whether to force the config drive to be attached to all VMs
+#   Defaults to false
+#
+# [*virtio_nic*]
+#   (optional) Whether to use virtio for the nic driver of VMs
+#   Defaults to false
+#
+# [*neutron_enabled*]
+#   (optional) Whether to use Neutron for networking of VMs
+#   Defaults to true
+#
+#
 class nova::compute (
   $enabled                       = false,
   $ensure_package                = 'present',