Cleanup documentation

Make sure documentation is the same and follow
the standard which we are trying to enforce on
all modules.

Change-Id: Id4ffd22ab3bc05787b080fc959b0a0c8bd62d884
This commit is contained in:
ZhongShengping 2018-12-13 17:10:01 +08:00 committed by Tobias Urdin
parent ee3d884fed
commit 6703a947ca
4 changed files with 148 additions and 118 deletions

View File

@ -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 cinder-manage db sync command. These will be inserted
# in the command line between 'cinder-manage' and 'db sync'.
# Defaults to undef

View File

@ -5,143 +5,173 @@
# === Parameters
#
# [*password*]
# Password for Cinder user. Required.
# (Required) Password for Cinder user.
#
# [*email*]
# Email for Cinder user. Optional. Defaults to 'cinder@localhost'.
# (Optional) Email for Cinder user.
# Defaults to 'cinder@localhost'.
#
# [*password_user_v2*]
# Password for Cinder v2 user. Optional. Defaults to undef.
# (Optional) Password for Cinder v2 user.
# Defaults to undef.
#
# [*email_user_v2*]
# Email for Cinder v2 user. Optional. Defaults to 'cinderv2@localhost'.
# (Optional) Email for Cinder v2 user.
# Defaults to 'cinderv2@localhost'.
#
# [*password_user_v3*]
# Password for Cinder v3 user. Optional. Defaults to undef.
# (Optional) Password for Cinder v3 user.
# Defaults to undef.
#
# [*email_user_v3*]
# Email for Cinder v3 user. Optional. Defaults to 'cinderv3@localhost'.
# (Optional) Email for Cinder v3 user.
# Defaults to 'cinderv3@localhost'.
#
# [*auth_name*]
# Username for Cinder service. Optional. Defaults to 'cinder'.
# (Optional) Username for Cinder service.
# Defaults to 'cinder'.
#
# [*auth_name_v2*]
# Username for Cinder v2 service. Optional. Defaults to 'cinderv2'.
# (Optional) Username for Cinder v2 service.
# Defaults to 'cinderv2'.
#
# [*auth_name_v3*]
# Username for Cinder v3 service. Optional. Defaults to 'cinderv3'.
# (Optional) Username for Cinder v3 service.
# Defaults to 'cinderv3'.
#
# [*configure_endpoint*]
# Should Cinder endpoint be configured? Optional. Defaults to 'true'.
# (Optional) Should Cinder endpoint be configured?
# API v1 endpoint should be enabled in Icehouse for compatibility with Nova.
# Defaults to true
#
# [*configure_endpoint_v2*]
# Should Cinder v2 endpoint be configured? Optional. Defaults to 'true'.
# (Optional) Should Cinder v2 endpoint be configured?
# Defaults to true
#
# [*configure_endpoint_v3*]
# Should Cinder v3 endpoint be configured? Optional. Defaults to 'true'.
# (Optional) Should Cinder v3 endpoint be configured?
# Defaults to true
#
# [*configure_user*]
# Should the service user be configured? Optional. Defaults to 'true'.
# (Optional) Should the service user be configured?
# Defaults to true
#
# [*configure_user_v2*]
# Should the service user be configured for cinder v2? Optional. Defaults to 'false'.
# (Optional) Should the service user be configured for cinder v2?
# Defaults to false
#
# [*configure_user_v3*]
# Should the service user be configured for cinder v3? Optional. Defaults to 'false'.
# (Optional) Should the service user be configured for cinder v3?
# Defaults to false
#
# [*configure_user_role*]
# Should the admin role be configured for the service user?
# Optional. Defaults to 'true'.
# (Optional) Should the admin role be configured for the service user?
# Defaults to true
#
# [*configure_user_role_v2*]
# Should the admin role be configured for the service user for cinder v2?
# Optional. Defaults to 'false'.
# (Optional) Should the admin role be configured for the service user for cinder v2?
# Defaults to false
#
# [*configure_user_role_v3*]
# Should the admin role be configured for the service user for cinder v3?
# Optional. Defaults to 'false'.
# (Optional) Should the admin role be configured for the service user for cinder v3?
# Defaults to false
#
# [*service_name*]
# (optional) Name of the service.
# (Optional) Name of the service.
# Defaults to 'cinder'.
#
# [*service_name_v2*]
# (optional) Name of the v2 service.
# (Optional) Name of the v2 service.
# Defaults to 'cinderv2'.
#
# [*service_name_v3*]
# (optional) Name of the v3 service.
# (Optional) Name of the v3 service.
# Defaults to 'cinderv3'.
#
# [*service_type*]
# Type of service. Optional. Defaults to 'volume'.
# (Optional) Type of service.
# Defaults to 'volume'.
#
# [*service_type_v2*]
# Type of API v2 service. Optional. Defaults to 'volumev2'.
# (Optional) Type of API v2 service.
# Defaults to 'volumev2'.
#
# [*service_type_v3*]
# Type of API v3 service. Optional. Defaults to 'volumev3'.
# (Optional) Type of API v3 service.
# Defaults to 'volumev3'.
#
# [*service_description*]
# (optional) Description for keystone service.
# Defaults to 'Cinder Service'.
# (Optional) Description for keystone service.
# Defaults to 'Cinder Service'.
#
# [*service_description_v2*]
# (optional) Description for keystone v2 service.
# Defaults to 'Cinder Service v2'.
# (Optional) Description for keystone v2 service.
# Defaults to 'Cinder Service v2'.
#
# [*service_description_v3*]
# (optional) Description for keystone v3 service.
# Defaults to 'Cinder Service v3'.
# (Optional) Description for keystone v3 service.
# Defaults to 'Cinder Service v3'.
#
# [*region*]
# Region for endpoint. Optional. Defaults to 'RegionOne'.
# (Optional) Region for endpoint.
# Defaults to 'RegionOne'.
#
# [*tenant*]
# Tenant for Cinder user. Optional. Defaults to 'services'.
# (Optional) Tenant for Cinder user.
# Defaults to 'services'.
#
# [*tenant_user_v2*]
# Tenant for Cinder v2 user. Optional. Defaults to 'services'.
# (Optional) Tenant for Cinder v2 user.
# Defaults to 'services'.
#
# [*tenant_user_v3*]
# Tenant for Cinder v3 user. Optional. Defaults to 'services'.
# (Optional) Tenant for Cinder v3 user.
# Defaults to 'services'.
#
# [*public_url*]
# (optional) The endpoint's public url. (Defaults to 'http://127.0.0.1:8776/v1/%(tenant_id)s')
# (Optional) The endpoint's public url. (Defaults to 'http://127.0.0.1:8776/v1/%(tenant_id)s')
# This url should *not* contain any trailing '/'.
# Defaults to 'http://127.0.0.1:8776/v1/%(tenant_id)s'
#
# [*internal_url*]
# (optional) The endpoint's internal url. (Defaults to 'http://127.0.0.1:8776/v1/%(tenant_id)s')
# (Optional) The endpoint's internal url.
# This url should *not* contain any trailing '/'.
# Defaults to 'http://127.0.0.1:8776/v1/%(tenant_id)s'
#
# [*admin_url*]
# (optional) The endpoint's admin url. (Defaults to 'http://127.0.0.1:8776/v1/%(tenant_id)s')
# (Optional) The endpoint's admin url.
# This url should *not* contain any trailing '/'.
# Defaults to 'http://127.0.0.1:8776/v1/%(tenant_id)s'
#
# [*public_url_v2*]
# (optional) The v2 endpoint's public url. (Defaults to 'http://127.0.0.1:8776/v2/%(tenant_id)s')
# (Optional) The v2 endpoint's public url.
# This url should *not* contain any trailing '/'.
# Defaults to 'http://127.0.0.1:8776/v2/%(tenant_id)s'
#
# [*internal_url_v2*]
# (optional) The v2 endpoint's internal url. (Defaults to 'http://127.0.0.1:8776/v2/%(tenant_id)s')
# (Optional) The v2 endpoint's internal url.
# This url should *not* contain any trailing '/'.
# Defaults to 'http://127.0.0.1:8776/v2/%(tenant_id)s'
#
# [*admin_url_v2*]
# (optional) The v2 endpoint's admin url. (Defaults to 'http://127.0.0.1:8776/v2/%(tenant_id)s')
# (Optional) The v2 endpoint's admin url.
# This url should *not* contain any trailing '/'.
# Defaults to 'http://127.0.0.1:8776/v2/%(tenant_id)s'
#
# [*public_url_v3*]
# (optional) The v3 endpoint's public url. (Defaults to 'http://127.0.0.1:8776/v3/%(tenant_id)s')
# (0ptional) The v3 endpoint's public url.
# This url should *not* contain any trailing '/'.
# Defaults to 'http://127.0.0.1:8776/v3/%(tenant_id)s'
#
# [*internal_url_v3*]
# (optional) The v3 endpoint's internal url. (Defaults to 'http://127.0.0.1:8776/v3/%(tenant_id)s')
# (Optional) The v3 endpoint's internal url.
# This url should *not* contain any trailing '/'.
# Defaults to 'http://127.0.0.1:8776/v3/%(tenant_id)s'
#
# [*admin_url_v3*]
# (optional) The v3 endpoint's admin url. (Defaults to 'http://127.0.0.1:8776/v3/%(tenant_id)s')
# (Optional) The v3 endpoint's admin url.
# This url should *not* contain any trailing '/'.
# Defaults to 'http://127.0.0.1:8776/v3/%(tenant_id)s'
#
# === Examples
#

View File

@ -3,95 +3,95 @@
# Cinder logging configuration
#
# === 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 boolean false or $::os_service_default, it will not log to any
# directory.
# Defaults to '/var/log/cinder'
# [*log_dir*]
# (Optional) Directory where logs should be stored.
# If set to boolean false or $::os_service_default, it will not log to any
# directory.
# Defaults to '/var/log/cinder'
#
# [*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).
# (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 cinder::logging(
$use_syslog = $::os_service_default,

View File

@ -5,7 +5,7 @@
# === Parameters
#
# [*policies*]
# (optional) Set of policies to configure for cinder
# (Optional) Set of policies to configure for cinder
# Example :
# {
# 'cinder-context_is_admin' => {
@ -20,7 +20,7 @@
# Defaults to empty hash.
#
# [*policy_path*]
# (optional) Path to the cinder policy.json file
# (Optional) Path to the cinder policy.json file
# Defaults to /etc/cinder/policy.json
#
class cinder::policy (