From e7b61fe7ded10399486588e13ac1c42052ba2bc1 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: I73b016ed23354e04a8cc0c1290b6d25a0de92cc0 --- manifests/db/sync.pp | 5 ++--- manifests/keystone/auth.pp | 44 +++++++++++++++++++++++--------------- manifests/logging.pp | 16 +++++++------- manifests/policy.pp | 4 ++-- 4 files changed, 39 insertions(+), 30 deletions(-) diff --git a/manifests/db/sync.pp b/manifests/db/sync.pp index 09dc45ff7..cc663ab98 100644 --- a/manifests/db/sync.pp +++ b/manifests/db/sync.pp @@ -4,17 +4,16 @@ # ==Parameters # # [*extra_params*] -# (optional) String of extra command line parameters to append +# (Optional) String of extra command line parameters to append # to the neutron-db-manage upgrade heads command. These will be # inserted in the command line between 'neutron-db-manage' and # 'upgrade heads'. # Defaults to '' # # [*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 neutron::db::sync( $extra_params = '', $db_sync_timeout = 300, diff --git a/manifests/keystone/auth.pp b/manifests/keystone/auth.pp index d05abe018..0104bf828 100644 --- a/manifests/keystone/auth.pp +++ b/manifests/keystone/auth.pp @@ -5,51 +5,62 @@ # === Parameters # # [*password*] -# (required) Password for Neutron user. +# (Required) Password for Neutron user. # # [*auth_name*] -# Username for Neutron service. Defaults to 'neutron'. +# (Optional) Username for Neutron service. +# Defaults to 'neutron'. # # [*email*] -# Email for Neutron user. Defaults to 'neutron@localhost'. +# (Optional) Email for Neutron user. +# Defaults to 'neutron@localhost'. # # [*tenant*] -# Tenant for Neutron user. Defaults to 'services'. +# (Optional) Tenant for Neutron user. +# Defaults to 'services'. # # [*configure_endpoint*] -# Should Neutron endpoint be configured? Defaults to 'true'. +# (Optional) Should Neutron endpoint be configured? +# Defaults to true. # # [*configure_user*] -# Should the Neutron service user be configured? Defaults to 'true'. +# (Optional) Should the Neutron service user be configured? +# Defaults to true. # # [*configure_user_role*] -# Should the admin role be configured for the service user? -# Defaults to 'true'. +# (Optional) Should the admin role be configured for the service user? +# Defaults to true. # # [*service_name*] -# Name of the service. Defaults 'neutron'. +# (Optional) Name of the service. +# Defaults 'neutron'. # # [*service_type*] -# Type of service. Defaults to 'network'. +# (Optional) Type of service. +# Defaults to 'network'. # # [*service_description*] -# Description for keystone service. -# (optional) Defaults to 'Neutron Networking Service'. +# (Optional) Description for keystone service. +# Defaults to 'Neutron Networking 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:9696') +# (0ptional) The endpoint's public url. # This url should *not* contain any trailing '/'. +# Defaults to 'http://127.0.0.1:9696' # # [*admin_url*] -# (optional) The endpoint's admin url. (Defaults to 'http://127.0.0.1:9696') +# (Optional) The endpoint's admin url. # This url should *not* contain any trailing '/'. +# Defaults to 'http://127.0.0.1:9696' # # [*internal_url*] -# (optional) The endpoint's internal url. (Defaults to 'http://127.0.0.1:9696') +# (Optional) The endpoint's internal url. # This url should *not* contain any trailing '/'. +# Defaults to 'http://127.0.0.1:9696' # # === Examples # @@ -59,7 +70,6 @@ # admin_url => 'https://10.0.0.11:9696', # } # -# class neutron::keystone::auth ( $password, $auth_name = 'neutron', diff --git a/manifests/logging.pp b/manifests/logging.pp index 26d4b3197..8d5a1f5a0 100644 --- a/manifests/logging.pp +++ b/manifests/logging.pp @@ -5,36 +5,36 @@ # === Parameters: # # [*debug*] -# (optional) Print debug messages in the logs +# (Optional) Print debug messages in the logs # Defaults to $::os_service_default # # [*use_syslog*] -# (optional) Use syslog for logging +# (Optional) Use syslog for logging # Defaults to $::os_service_default # # [*use_json*] -# (optional) Use json for logging +# (Optional) Use json for logging # Defaults to $::os_service_default # # [*use_journal*] -# (optional) Use journal for logging +# (Optional) Use journal for logging # Defaults to $::os_service_default # # [*use_stderr*] -# (optional) Use stderr for logging +# (Optional) Use stderr for logging # Defaults to $::os_service_default # # [*log_file*] -# (optional) Where to log +# (Optional) Where to log # 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/neutron # # [*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 # diff --git a/manifests/policy.pp b/manifests/policy.pp index 6e289d927..f4f7b779b 100644 --- a/manifests/policy.pp +++ b/manifests/policy.pp @@ -5,7 +5,7 @@ # === Parameters # # [*policies*] -# (optional) Set of policies to configure for neutron +# (Optional) Set of policies to configure for neutron # Example : # { # 'neutron-context_is_admin' => { @@ -20,7 +20,7 @@ # Defaults to empty hash. # # [*policy_path*] -# (optional) Path to the neutron policy.json file +# (Optional) Path to the neutron policy.json file # Defaults to /etc/neutron/policy.json # class neutron::policy (