Cleanup documentation

Make sure documentation is the same and follow the standard which we are trying to enforce on all modules. Change-Id: I46a0c41c772297ffe03ebb9e86462ea1abf330de
2018-12-13 17:10:02 +08:00 · 2018-12-13 17:10:02 +08:00 · 8ff9684428
commit 8ff9684428
parent 13ac7c6eb9
6 changed files with 106 additions and 113 deletions
--- a/manifests/db/mysql.pp
+++ b/manifests/db/mysql.pp
@ -3,7 +3,7 @@
 # This class can be used to create tables, users and grant
 # privilege for a mysql octavia 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 octavia::db::mysql(
  $password,
  $dbname        = 'octavia',
--- a/manifests/db/postgresql.pp
+++ b/manifests/db/postgresql.pp
@ -24,14 +24,6 @@
 #    (Optional) Privileges given to the database user.
 #    Default to 'ALL'
 #
-# == Dependencies
-#
-# == Examples
-#
-# == Authors
-#
-# == Copyright
-#
 class octavia::db::postgresql(
  $password,
  $dbname     = 'octavia',
--- a/manifests/db/sync.pp
+++ b/manifests/db/sync.pp
@ -4,7 +4,7 @@
 # == Parameters
 #
 # [*extra_params*]
-#   (optional) String of extra command line parameters to append
+#   (Optional) String of extra command line parameters to append
 #   to the octavia-dbsync command.
 #   Defaults to undef
 #
--- a/manifests/keystone/auth.pp
+++ b/manifests/keystone/auth.pp
@ -5,48 +5,58 @@
 # === Parameters
 #
 # [*password*]
-#   (required) Password for octavia user.
+#   (Required) Password for octavia user.
 #
 # [*auth_name*]
-#   Username for octavia service. Defaults to 'octavia'.
+#   (Optional) Username for octavia service.
+#   Defaults to 'octavia'.
 #
 # [*email*]
-#   Email for octavia user. Defaults to 'octavia@localhost'.
+#   (Optional) Email for octavia user.
+#   Defaults to 'octavia@localhost'.
 #
 # [*tenant*]
-#   Tenant for octavia user. Defaults to 'services'.
+#   (Optional) Tenant for octavia user.
+#   Defaults to 'services'.
 #
 # [*configure_endpoint*]
-#   Should octavia endpoint be configured? Defaults to 'true'.
+#   (Optional) Should octavia endpoint be configured?
+#   Defaults to true.
 #
 # [*configure_user*]
 #   (Optional) Should the service user be configured?
-#   Defaults to 'true'.
+#   Defaults to true.
 #
 # [*configure_user_role*]
 #   (Optional) Should the admin role be configured for the service user?
-#   Defaults to 'true'.
+#   Defaults to true.
 #
 # [*service_type*]
-#   Type of service. Defaults to 'load-balancer'.
+#   (Optional) Type of service.
+#   Defaults to 'load-balancer'.
 #
 # [*region*]
-#   Region for endpoint. Defaults to 'RegionOne'.
+#   (Optional) Region for endpoint.
+#   Defaults to 'RegionOne'.
 #
 # [*service_name*]
-#   (optional) Name of the service.
+#   (Optional) Name of the service.
 #   Defaults to 'octavia'
 #
 # [*public_url*]
-#   (optional) The endpoint's public url. (Defaults to 'http://127.0.0.1:9876')
+#   (0ptional) The endpoint's public url.
 #   This url should *not* contain any trailing '/'.
+#   Defaults to 'http://127.0.0.1:9876'
 #
 # [*admin_url*]
-#   (optional) The endpoint's admin url. (Defaults to 'http://127.0.0.1:9876')
+#   (Optional) The endpoint's admin url.
 #   This url should *not* contain any trailing '/'.
+#   Defaults to 'http://127.0.0.1:9876'
 #
 # [*internal_url*]
-#   (optional) The endpoint's internal url. (Defaults to 'http://127.0.0.1:9876')
+#   (Optional) The endpoint's internal url.
+#   This url should *not* contain any trailing '/'.
+#   Defaults to 'http://127.0.0.1:9876'
 #
 class octavia::keystone::auth (
  $password,
--- a/manifests/logging.pp
+++ b/manifests/logging.pp
@ -21,7 +21,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*]
@ -29,43 +29,43 @@
 #   Defaults to $::os_service_default
 #
 # [*log_dir*]
-#    (optional) Directory where logs should be stored.
+#   (Optional) Directory where logs should be stored.
 #   If set to $::os_service_default, it will not log to any directory.
 #   Defaults to '/var/log/octavia'.
 #
 # [*log_file*]
-#    (optional) File where logs should be stored.
+#   (Optional) File where logs should be stored.
 #   Defaults to '/var/log/octavia/octavia.log'
 #
 # [*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',
@ -77,27 +77,27 @@
 #          'routes.middleware' => 'WARN', stevedore => '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 undef.
 #   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'
 #
--- a/manifests/policy.pp
+++ b/manifests/policy.pp
@ -5,7 +5,7 @@
 # === Parameters
 #
 # [*policies*]
-#   (optional) Set of policies to configure for octavia
+#   (Optional) Set of policies to configure for octavia
 #   Example :
 #     {
 #       'octavia-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/octavia/policy.json
 #
 class octavia::policy (