From 74d2e14f813e2586d476c518c5ada1332de9fdc5 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: I641d3fbd3d3c95a92220274702111e21d108acc2 --- manifests/db/sync.pp | 2 +- manifests/keystone/auth.pp | 13 ++++++++----- manifests/logging.pp | 26 +++++++++++++------------- manifests/policy.pp | 4 ++-- 4 files changed, 24 insertions(+), 21 deletions(-) diff --git a/manifests/db/sync.pp b/manifests/db/sync.pp index 16fceeab..6daaf7e7 100644 --- 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 sahara-db-manage command. # Defaults to '--config-file /etc/sahara/sahara.conf' # diff --git a/manifests/keystone/auth.pp b/manifests/keystone/auth.pp index e2b12a4e..687916c9 100644 --- a/manifests/keystone/auth.pp +++ b/manifests/keystone/auth.pp @@ -5,7 +5,7 @@ # === Parameters # # [*password*] -# (required) Password for Sahara user. +# (Required) Password for Sahara user. # # [*service_name*] # (Optional) Name of the service. @@ -25,7 +25,7 @@ # # [*configure_endpoint*] # (Optional) Should Sahara endpoint be configured? -# Defaults to 'true'. +# Defaults to true. # # [*service_type*] # (Optional) Type of service. @@ -40,16 +40,19 @@ # Defaults to 'RegionOne'. # # [*public_url*] -# (optional) The endpoint's public url. (Defaults to 'http://127.0.0.1:8386/v1.1/%(tenant_id)s') +# (Optional) The endpoint's public url. # This url should *not* contain any trailing '/'. +# Defaults to 'http://127.0.0.1:8386/v1.1/%(tenant_id)s' # # [*admin_url*] -# (optional) The endpoint's admin url. (Defaults to 'http://127.0.0.1:8386/v1.1/%(tenant_id)s') +# (Optional) The endpoint's admin url. # This url should *not* contain any trailing '/'. +# Defaults to 'http://127.0.0.1:8386/v1.1/%(tenant_id)s' # # [*internal_url*] -# (optional) The endpoint's internal url. (Defaults to 'http://127.0.0.1:8386/v1.1/%(tenant_id)s') +# (Optional) The endpoint's internal url. # This url should *not* contain any trailing '/'. +# Defaults to 'http://127.0.0.1:8386/v1.1/%(tenant_id)s' # # === Deprecation notes # diff --git a/manifests/logging.pp b/manifests/logging.pp index bfda9151..db6f22b0 100644 --- a/manifests/logging.pp +++ b/manifests/logging.pp @@ -21,7 +21,7 @@ # (Optional) 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,39 +29,39 @@ # (Optional) 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/sahara' # # [*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', @@ -69,27 +69,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 (false if unconfigured). # # [*fatal_deprecations*] -# (optional) Make deprecations fatal (boolean value) +# (Optional) Make deprecations fatal (boolean value) # Defaults to $::os_service_default (false if unconfigured). # # [*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' # diff --git a/manifests/policy.pp b/manifests/policy.pp index d9dbcd7e..fa5c4b0b 100644 --- a/manifests/policy.pp +++ b/manifests/policy.pp @@ -5,7 +5,7 @@ # === Parameters # # [*policies*] -# (optional) Set of policies to configure for sahara +# (Optional) Set of policies to configure for sahara # Example : # { # 'sahara-context_is_admin' => { @@ -20,7 +20,7 @@ # Defaults to empty hash. # # [*policy_path*] -# (optional) Path to the sahara policy.json file +# (Optional) Path to the sahara policy.json file # Defaults to /etc/sahara/policy.json # class sahara::policy (