From ac3107e7c9d3c65f5400bce2a4dd7bb1a8b6fa78 Mon Sep 17 00:00:00 2001 From: ZhongShengping Date: Thu, 13 Dec 2018 17:10:01 +0800 Subject: [PATCH] Cleanup documentation Make sure documentation is the same and follow the standard which we are trying to enforce on all modules. Change-Id: I4e8e9d55254de75dc3442afdd20ce7602b0ca10b --- manifests/db/sync.pp | 4 +- manifests/keystone/auth.pp | 33 +++++---- manifests/logging.pp | 136 ++++++++++++++++++------------------- manifests/policy.pp | 4 +- 4 files changed, 93 insertions(+), 84 deletions(-) diff --git a/manifests/db/sync.pp b/manifests/db/sync.pp index 12ff218f..14b96695 100644 --- a/manifests/db/sync.pp +++ b/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 ironic-dbsync command. # Defaults to undef # class ironic::db::sync( - $extra_params = undef, + $extra_params = undef, ) { include ::ironic::deps diff --git a/manifests/keystone/auth.pp b/manifests/keystone/auth.pp index 042b25a2..7201aaca 100644 --- a/manifests/keystone/auth.pp +++ b/manifests/keystone/auth.pp @@ -22,53 +22,62 @@ # === Parameters # # [*password*] -# (required) Password for Ironic user. +# (Required) Password for Ironic user. # # [*auth_name*] -# Username for Ironic service. Defaults to 'ironic'. +# (Optional) Username for Ironic service. +# Defaults to 'ironic'. # # [*email*] -# Email for Ironic user. Defaults to 'ironic@localhost'. +# (Optional) Email for Ironic user. +# Defaults to 'ironic@localhost'. # # [*tenant*] -# Tenant for Ironic user. Defaults to 'services'. +# (Optional) Tenant for Ironic user. +# Defaults to 'services'. # # [*configure_endpoint*] -# Should Ironic endpoint be configured? Defaults to 'true'. +# (Optional) Should Ironic 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_name*] # (Optional) Name of the service. # Defaults to the value of 'ironic'. # # [*service_type*] -# Type of service. Defaults to 'baremetal'. +# (Optional) Type of service. +# Defaults to 'baremetal'. # # [*service_description*] # (Optional) Description for keystone service. # Defaults to 'Ironic Bare Metal Provisioning Service'. # # [*region*] -# Region for endpoint. Defaults to 'RegionOne'. +# (Optional) Region for endpoint. +# Defaults to 'RegionOne'. # # [*public_url*] -# (optional) The endpoint's public url. (Defaults to 'http://127.0.0.1:6385') +# (0ptional) The endpoint's public url. # This url should *not* contain any trailing '/'. +# Defaults to 'http://127.0.0.1:6385' # # [*admin_url*] -# (optional) The endpoint's admin url. (Defaults to 'http://127.0.0.1:6385') +# (Optional) The endpoint's admin url. # This url should *not* contain any trailing '/'. +# Defaults to 'http://127.0.0.1:6385' # # [*internal_url*] -# (optional) The endpoint's internal url. (Defaults to 'http://127.0.0.1:6385') +# (Optional) The endpoint's internal url. # This url should *not* contain any trailing '/'. +# Defaults to 'http://127.0.0.1:6385' # # === Examples # diff --git a/manifests/logging.pp b/manifests/logging.pp index 6c80c931..0b648851 100644 --- a/manifests/logging.pp +++ b/manifests/logging.pp @@ -4,94 +4,94 @@ # # == 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_json*] -# (Optional) Use json for logging. -# Defaults to $::os_service_default +# [*use_json*] +# (Optional) Use json 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_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/ironic' +# [*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/ironic' # -# [*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' # -# [*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', 'iso8601' => 'WARN', -# 'requests.packages.urllib3.connectionpool' => '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', 'iso8601' => 'WARN', +# 'requests.packages.urllib3.connectionpool' => '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 +# [*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' # class ironic::logging( $use_syslog = $::os_service_default, diff --git a/manifests/policy.pp b/manifests/policy.pp index bd0904e2..85339619 100644 --- a/manifests/policy.pp +++ b/manifests/policy.pp @@ -5,7 +5,7 @@ # === Parameters # # [*policies*] -# (optional) Set of policies to configure for ironic +# (Optional) Set of policies to configure for ironic # Example : # { # 'ironic-context_is_admin' => { @@ -20,7 +20,7 @@ # Defaults to empty hash. # # [*policy_path*] -# (optional) Path to the ironic policy.json file +# (Optional) Path to the ironic policy.json file # Defaults to /etc/ironic/policy.json # class ironic::policy (