Merge "Cleanup documentation"

manifests/db/mysql.pp

@@ -3,7 +3,7 @@
 # This class can be used to create tables, users and grant
 # privileges for a mysql vitrage database.
 #
-# == parameters
+# == Parameters
 #
 # [*password*]
 #   (Required) Password to connect to the database.
@@ -33,15 +33,6 @@
 #   Only used with mysql modules >= 2.2.
 #   Defaults to 'utf8_general_ci'
 #
-# == Dependencies
-#   Class['mysql::server']
-#
-# == Examples
-#
-# == Authors
-#
-# == Copyright
-#
 class vitrage::db::mysql(
   $password,
   $dbname        = 'vitrage',

manifests/db/sync.pp

@@ -4,12 +4,12 @@
 # == Parameters
 #
 # [*extra_params*]
-#   (optional) String of extra command line parameters to append
+#   (Optional) String of extra command line parameters to append
 #   to the vitrage-dbsync command.
 #   Defaults to undef
 #
 class vitrage::db::sync(
-  $extra_params  = undef,
+  $extra_params = undef,
 ) {
 
   include ::vitrage::deps

manifests/keystone/auth.pp

@@ -5,7 +5,7 @@
 # === Parameters
 #
 # [*password*]
-#   (required) Password for vitrage user.
+#   (Required) Password for vitrage user.
 #
 # [*auth_name*]
 #   (Optional) Username for vitrage service.
@@ -40,21 +40,21 @@
 #   Defaults to 'RegionOne'.
 #
 # [*service_name*]
-#   (optional) Name of the service.
+#   (Optional) Name of the service.
 #   Defaults to the value of auth_name.
 #
 # [*public_url*]
-#   (optional) The endpoint's public url.
+#   (Optional) The endpoint's public url.
 #   This url should *not* contain any trailing '/'.
 #   Defaults to 'http://127.0.0.1:8999'
 #
 # [*admin_url*]
-#   (optional) The endpoint's admin url.
+#   (Optional) The endpoint's admin url.
 #   This url should *not* contain any trailing '/'.
 #   Defaults to 'http://127.0.0.1:8999'
 #
 # [*internal_url*]
-#   (optional) The endpoint's internal url.
+#   (Optional) The endpoint's internal url.
 #   This url should *not* contain any trailing '/'.
 #   Defaults to 'http://127.0.0.1:8999'
 #

manifests/logging.pp

@@ -22,7 +22,7 @@
 #   Defaults to $::os_service_default
 #
 # [*use_stderr*]
-#   (optional) Use stderr for logging
+#   (Optional) Use stderr for logging
 #   Defaults to $::os_service_default
 #
 # [*log_facility*]
@@ -30,40 +30,40 @@
 #   Defaults to $::os_service_default
 #
 # [*log_dir*]
-#   (optional) Directory where logs should be stored.
+#   (Optional) Directory where logs should be stored.
 #   If set to boolean false or the $::os_service_default, it will not log to
 #   any directory.
 #   Defaults to '/var/log/vitrage'.
 #
 # [*logging_context_format_string*]
-#   (optional) Format string to use for log messages with context.
+#   (Optional) Format string to use for log messages with context.
 #   Defaults to $::os_service_default
 #   Example: '%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s\
 #             [%(request_id)s %(user_identity)s] %(instance)s%(message)s'
 #
 # [*logging_default_format_string*]
-#   (optional) Format string to use for log messages without context.
+#   (Optional) Format string to use for log messages without context.
 #   Defaults to $::os_service_default
 #   Example: '%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s\
 #             [-] %(instance)s%(message)s'
 #
 # [*logging_debug_format_suffix*]
-#   (optional) Formatted data to append to log format when level is DEBUG.
+#   (Optional) Formatted data to append to log format when level is DEBUG.
 #   Defaults to $::os_service_default
 #   Example: '%(funcName)s %(pathname)s:%(lineno)d'
 #
 # [*logging_exception_prefix*]
-#   (optional) Prefix each line of exception output with this format.
+#   (Optional) Prefix each line of exception output with this format.
 #   Defaults to $::os_service_default
 #   Example: '%(asctime)s.%(msecs)03d %(process)d TRACE %(name)s %(instance)s'
 #
 # [*log_config_append*]
-#   The name of an additional logging configuration file.
+#   (Optional) The name of an additional logging configuration file.
 #   Defaults to $::os_service_default
 #   See https://docs.python.org/2/howto/logging.html
 #
 # [*default_log_levels*]
-#   (optional) Hash of logger (keys) and level (values) pairs.
+#   (0ptional) Hash of logger (keys) and level (values) pairs.
 #   Defaults to $::os_service_default
 #   Example:
 #     { 'amqp' => 'WARN', 'amqplib' => 'WARN', 'boto' => 'WARN',
@@ -71,27 +71,27 @@
 #       'requests.packages.urllib3.connectionpool' => 'WARN' }
 #
 # [*publish_errors*]
-#   (optional) Publish error events (boolean value).
+#   (Optional) Publish error events (boolean value).
 #   Defaults to $::os_service_default
 #
 # [*fatal_deprecations*]
-#   (optional) Make deprecations fatal (boolean value)
+#   (Optional) Make deprecations fatal (boolean value)
 #   Defaults to $::os_service_default
 #
 # [*instance_format*]
-#   (optional) If an instance is passed with the log message, format it
+#   (Optional) If an instance is passed with the log message, format it
 #              like this (string value).
 #   Defaults to $::os_service_default
 #   Example: '[instance: %(uuid)s] '
 #
 # [*instance_uuid_format*]
-#   (optional) If an instance UUID is passed with the log message, format
+#   (Optional) If an instance UUID is passed with the log message, format
 #              it like this (string value).
 #   Defaults to $::os_service_default
 #   Example: instance_uuid_format='[instance: %(uuid)s] '
 #
 # [*log_date_format*]
-#   (optional) Format string for %%(asctime)s in log records.
+#   (Optional) Format string for %%(asctime)s in log records.
 #   Defaults to $::os_service_default
 #   Example: 'Y-%m-%d %H:%M:%S'
 #

manifests/policy.pp

@@ -5,7 +5,7 @@
 # === Parameters
 #
 # [*policies*]
-#   (optional) Set of policies to configure for vitrage
+#   (Optional) Set of policies to configure for vitrage
 #   Example :
 #     {
 #       'vitrage-context_is_admin' => {
@@ -20,7 +20,7 @@
 #   Defaults to empty hash.
 #
 # [*policy_path*]
-#   (optional) Path to the nova policy.json file
+#   (Optional) Path to the nova policy.json file
 #   Defaults to /etc/vitrage/policy.json
 #
 class vitrage::policy (