Merge "Cleanup documentation"

2018-12-18 07:23:15 +00:00
parent 432b17c658 5f5eb4c369
commit 63142bf6ef
4 changed files with 83 additions and 97 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 keystone database.
 #
-# == parameters
+# == Parameters
 #
 # [*password*]
 #   (Required) Password to connect to the database.
@@ -33,20 +33,6 @@
 #   Only used with mysql modules >= 2.2.
 #   Defaults to 'utf8_general_ci'
 #
-# === Deprecated Parameters
-#
-# == Dependencies
-#   Class['mysql::server']
-#
-# == Examples
-# == Authors
-#
-#   Dan Bode dan@puppetlabs.com
-#
-# == Copyright
-#
-# Copyright 2012 Puppetlabs Inc, unless otherwise noted.
-#
 class keystone::db::mysql(
  $password,
  $dbname        = 'keystone',
--- a/manifests/db/sync.pp
+++ b/manifests/db/sync.pp
@@ -4,14 +4,14 @@
 # == Parameters
 #
 # [*extra_params*]
-#   (optional) String of extra command line parameters to append
+#   (Optional) String of extra command line parameters to append
 #   to the keystone-manage db_sync command.  These will be
 #   inserted in the command line between 'keystone-manage' and
 #   'db_sync' in the command line.
 #   Defaults to ''
 #
 # [*keystone_user*]
-#   (optional) Specify the keystone system user to be used with keystone-manage.
+#   (Optional) Specify the keystone system user to be used with keystone-manage.
 #   Defaults to $::keystone::params::keystone_user
 #
 class keystone::db::sync(
--- a/manifests/logging.pp
+++ b/manifests/logging.pp
@@ -4,107 +4,107 @@
 #
 # == parameters
 #
-#  [*debug*]
-#    (Optional) Should the daemons log debug messages
-#    Defaults to $::os_service_default
+# [*debug*]
+#   (Optional) Should the daemons log debug messages
+#   Defaults to $::os_service_default
 #
-#  [*use_syslog*]
-#    (Optional) Use syslog for logging.
-#    Defaults to $::os_service_default
+# [*use_syslog*]
+#   (Optional) Use syslog for logging.
+#   Defaults to $::os_service_default
 #
-#  [*use_journal*]
-#    (Optional) Use journal for logging.
-#    Defaults to $::os_service_default
+# [*use_journal*]
+#   (Optional) Use journal for logging.
+#   Defaults to $::os_service_default
 #
-#  [*use_json*]
-#    (Optional) Use JSON format for logging.
-#    Defaults to $::os_service_default
+# [*use_json*]
+#   (Optional) Use JSON format for logging.
+#   Defaults to $::os_service_default
 #
-#  [*use_stderr*]
-#    (optional) Use stderr for logging
-#    Defaults to $::os_service_default
+# [*use_stderr*]
+#   (Optional) Use stderr for logging
+#   Defaults to $::os_service_default
 #
-#  [*log_facility*]
-#    (Optional) Syslog facility to receive log lines.
-#    Defaults to $::os_service_default
+# [*log_facility*]
+#   (Optional) Syslog facility to receive log lines.
+#   Defaults to $::os_service_default
 #
-#  [*log_dir*]
-#    (optional) Directory where logs should be stored.
-#    If set to $::os_service_default, it will not log to any directory.
-#    Defaults to '/var/log/keystone'
+# [*log_dir*]
+#   (Optional) Directory where logs should be stored.
+#   If set to $::os_service_default, it will not log to any directory.
+#   Defaults to '/var/log/keystone'
 #
-#  [*log_file*]
-#    (optional) File where logs should be stored.
-#    Defaults to $::os_service_default
+# [*log_file*]
+#   (Optional) File where logs should be stored.
+#   Defaults to $::os_service_default
 #
-#  [*logging_context_format_string*]
-#    (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_context_format_string*]
+#   (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.
-#    Defaults to $::os_service_default
-#    Example: '%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s\
-#              [-] %(instance)s%(message)s'
+# [*logging_default_format_string*]
+#   (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.
-#    Defaults to $::os_service_default
-#    Example: '%(funcName)s %(pathname)s:%(lineno)d'
+# [*logging_debug_format_suffix*]
+#   (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.
-#    Defaults to $::os_service_default
-#    Example: '%(asctime)s.%(msecs)03d %(process)d TRACE %(name)s %(instance)s'
+# [*logging_exception_prefix*]
+#   (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'
 #
 # [*logging_user_identity_format*]
 #   (Optional) Defines the format string for %(user_identity)s that is used in logging_context_format_string.
 #   Defaults to $::os_service_default
 #   Example: '%(user)s %(tenant)s %(domain)s %(user_domain)s %(project_domain)s'
 #
-#  [*log_config_append*]
-#    The name of an additional logging configuration file.
-#    Defaults to $::os_service_default
-#    See https://docs.python.org/2/howto/logging.html
+# [*log_config_append*]
+#   (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.
-#    Defaults to $::os_service_default
-#    Example:
-#      { 'amqp'  => 'WARN', 'amqplib' => 'WARN', 'boto' => 'WARN',
-#           'sqlalchemy' => 'WARN', 'suds' => 'INFO',
-#           'oslo.messaging' => 'INFO', 'iso8601' => 'WARN',
-#           'requests.packages.urllib3.connectionpool' => 'WARN',
-#           'urllib3.connectionpool' => 'WARN',
-#           'websocket' => 'WARN', 'keystonemiddleware' => 'WARN',
-#           'routes.middleware' => 'WARN', stevedore => 'WARN' }
+# [*default_log_levels*]
+#   (0ptional) Hash of logger (keys) and level (values) pairs.
+#   Defaults to $::os_service_default
+#   Example:
+#     { 'amqp'  => 'WARN', 'amqplib' => 'WARN', 'boto' => 'WARN',
+#          'sqlalchemy' => 'WARN', 'suds' => 'INFO',
+#          'oslo.messaging' => 'INFO', 'iso8601' => 'WARN',
+#          'requests.packages.urllib3.connectionpool' => 'WARN',
+#          'urllib3.connectionpool' => 'WARN',
+#          'websocket' => 'WARN', 'keystonemiddleware' => 'WARN',
+#          'routes.middleware' => 'WARN', stevedore => 'WARN' }
 #
-#  [*publish_errors*]
-#    (optional) Publish error events (boolean value).
-#    Defaults to $::os_service_default
+# [*publish_errors*]
+#   (Optional) Publish error events (boolean value).
+#   Defaults to $::os_service_default
 #
-#  [*fatal_deprecations*]
-#    (optional) Make deprecations fatal (boolean value)
-#    Defaults to $::os_service_default
+# [*fatal_deprecations*]
+#   (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
-#               like this (string value).
-#    Defaults to $::os_service_default
-#    Example: '[instance: %(uuid)s] '
+# [*instance_format*]
+#   (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
-#               it like this (string value).
-#    Defaults to $::os_service_default
-#    Example: instance_uuid_format='[instance: %(uuid)s] '
+# [*instance_uuid_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.
-#    Defaults to $::os_service_default
-#    Example: 'Y-%m-%d %H:%M:%S'
+# [*log_date_format*]
+#   (Optional) Format string for %%(asctime)s in log records.
+#   Defaults to $::os_service_default
+#   Example: 'Y-%m-%d %H:%M:%S'
 #
 # [*watch_log_file*]
 #   (Optional) Uses logging handler designed to watch file system (boolean value).
--- a/manifests/policy.pp
+++ b/manifests/policy.pp
@@ -5,7 +5,7 @@
 # === Parameters
 #
 # [*policies*]
-#   (optional) Set of policies to configure for keystone
+#   (Optional) Set of policies to configure for keystone
 #   Example :
 #     {
 #       'keystone-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/keystone/policy.json
 #
 class keystone::policy (