From 2cb8554a0fe0ad47beebd5a34125f5bf9fe81b6a Mon Sep 17 00:00:00 2001 From: ZhongShengping Date: Thu, 13 Dec 2018 17:10:02 +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: I7ab5214261c7a85051bc6ec58d55bb512d3db9b3 --- manifests/db/mysql.pp | 1 - manifests/db/sync.pp | 4 +- manifests/db/sync_api.pp | 6 +- manifests/keystone/auth.pp | 26 ++--- manifests/keystone/auth_placement.pp | 26 ++--- manifests/logging.pp | 142 +++++++++++++-------------- manifests/policy.pp | 4 +- 7 files changed, 104 insertions(+), 105 deletions(-) diff --git a/manifests/db/mysql.pp b/manifests/db/mysql.pp index 038b40b04..509465d0f 100644 --- a/manifests/db/mysql.pp +++ b/manifests/db/mysql.pp @@ -36,7 +36,6 @@ # be set to true by default in Ocata when the cell v2 setup is mandatory. # Defaults to true # - class nova::db::mysql( $password, $dbname = 'nova', diff --git a/manifests/db/sync.pp b/manifests/db/sync.pp index d3e45b740..d26011134 100644 --- a/manifests/db/sync.pp +++ b/manifests/db/sync.pp @@ -4,13 +4,13 @@ # ==Parameters # # [*extra_params*] -# (optional) String of extra command line parameters to append +# (Optional) String of extra command line parameters to append # to the nova-manage db sync command. These will be inserted in # the command line between 'nova-manage' and 'db sync'. # Defaults to undef # # [*db_sync_timeout*] -# (optional) Timeout for the execution of the db_sync +# (Optional) Timeout for the execution of the db_sync # Defaults to 300 # class nova::db::sync( diff --git a/manifests/db/sync_api.pp b/manifests/db/sync_api.pp index 9667ee558..02868a43e 100644 --- a/manifests/db/sync_api.pp +++ b/manifests/db/sync_api.pp @@ -4,13 +4,13 @@ # ==Parameters # # [*extra_params*] -# (optional) String of extra command line parameters to append +# (Optional) String of extra command line parameters to append # to the nova-manage db sync command. These will be inserted in # the command line between 'nova-manage' and 'db sync'. # Defaults to undef # # [*cellv2_setup*] -# (optional) This flag toggles if we preform a minimal cell_v2 setup of a +# (Optional) This flag toggles if we preform a minimal cell_v2 setup of a # a single cell. # NOTE: 'nova-manage cell_v2 discover_hosts' must be # run after any nova-compute hosts have been deployed. @@ -18,7 +18,7 @@ # Defaults to false. # # [*db_sync_timeout*] -# (optional) Timeout for the execution of the db_sync +# (Optional) Timeout for the execution of the db_sync # Defaults to 300. # class nova::db::sync_api( diff --git a/manifests/keystone/auth.pp b/manifests/keystone/auth.pp index ea6777d65..77f41c0f7 100644 --- a/manifests/keystone/auth.pp +++ b/manifests/keystone/auth.pp @@ -5,54 +5,54 @@ # === Parameters: # # [*password*] -# Password to create for the service user +# (Required) Password to create for the service user # # [*auth_name*] -# (optional) The name of the nova service user +# (Optional) The name of the nova service user # Defaults to 'nova' # # [*service_name*] -# (optional) Name of the service. +# (Optional) Name of the service. # Defaults to 'nova'. # # [*service_description*] -# (optional) Description for keystone service. +# (Optional) Description for keystone service. # Defaults to 'Openstack Compute Service'. # # [*public_url*] -# (optional) The endpoint's public url. +# (Optional) The endpoint's public url. # Defaults to 'http://127.0.0.1:8774/v2.1' # # [*internal_url*] -# (optional) The endpoint's internal url. +# (Optional) The endpoint's internal url. # Defaults to 'http://127.0.0.1:8774/v2.1' # # [*admin_url*] -# (optional) The endpoint's admin url. +# (Optional) The endpoint's admin url. # Defaults to 'http://127.0.0.1:8774/v2.1' # # [*region*] -# (optional) The region in which to place the endpoints +# (Optional) The region in which to place the endpoints # Defaults to 'RegionOne' # # [*tenant*] -# (optional) The tenant to use for the nova service user +# (Optional) The tenant to use for the nova service user # Defaults to 'services' # # [*email*] -# (optional) The email address for the nova service user +# (Optional) The email address for the nova service user # Defaults to 'nova@localhost' # # [*configure_endpoint*] -# (optional) Whether to create the endpoint. +# (Optional) Whether to create the endpoint. # Defaults to true # # [*configure_user*] -# (optional) Whether to create the service user. +# (Optional) Whether to create the service user. # Defaults to true # # [*configure_user_role*] -# (optional) Whether to configure the admin role for the service user. +# (Optional) Whether to configure the admin role for the service user. # Defaults to true # class nova::keystone::auth( diff --git a/manifests/keystone/auth_placement.pp b/manifests/keystone/auth_placement.pp index 9e5aebb11..28d399f22 100644 --- a/manifests/keystone/auth_placement.pp +++ b/manifests/keystone/auth_placement.pp @@ -5,54 +5,54 @@ # === Parameters: # # [*password*] -# Password to create for the service user +# (Required) Password to create for the service user # # [*auth_name*] -# (optional) The name of the placement service user +# (Optional) The name of the placement service user # Defaults to 'placement' # # [*service_name*] -# (optional) Name of the service. +# (Optional) Name of the service. # Defaults to 'placement'. # # [*service_description*] -# (optional) Description for keystone service. +# (Optional) Description for keystone service. # Defaults to 'Openstack Placement Service'. # # [*public_url*] -# (optional) The endpoint's public url. +# (Optional) The endpoint's public url. # Defaults to 'http://127.0.0.1/placement' # # [*internal_url*] -# (optional) The endpoint's internal url. +# (Optional) The endpoint's internal url. # Defaults to 'http://127.0.0.1/placement' # # [*admin_url*] -# (optional) The endpoint's admin url. +# (Optional) The endpoint's admin url. # Defaults to 'http://127.0.0.1/placement' # # [*region*] -# (optional) The region in which to place the endpoints +# (Optional) The region in which to place the endpoints # Defaults to 'RegionOne' # # [*tenant*] -# (optional) The tenant to use for the nova service user +# (Optional) The tenant to use for the nova service user # Defaults to 'services' # # [*email*] -# (optional) The email address for the nova service user +# (Optional) The email address for the nova service user # Defaults to 'placement@localhost' # # [*configure_endpoint*] -# (optional) Whether to create the endpoint. +# (Optional) Whether to create the endpoint. # Defaults to true # # [*configure_user*] -# (optional) Whether to create the service user. +# (Optional) Whether to create the service user. # Defaults to true # # [*configure_user_role*] -# (optional) Whether to configure the admin role for the service user. +# (Optional) Whether to configure the admin role for the service user. # Defaults to true # class nova::keystone::auth_placement( diff --git a/manifests/logging.pp b/manifests/logging.pp index 6517a9042..e2cdc88f6 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/nova' +# [*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/nova' # -# [*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 -# 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' # class nova::logging( $use_syslog = $::os_service_default, diff --git a/manifests/policy.pp b/manifests/policy.pp index 30f61674d..34219bde8 100644 --- a/manifests/policy.pp +++ b/manifests/policy.pp @@ -5,7 +5,7 @@ # === Parameters # # [*policies*] -# (optional) Set of policies to configure for nova +# (Optional) Set of policies to configure for nova # Example : # { # 'nova-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/nova/policy.json # class nova::policy (