openstack/puppet-manila
Code Issues Proposed changes

Cleanup documentation

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

Change-Id: I9123147b59589e8cd38f87e4ba534c120f361687
This commit is contained in:
ZhongShengping 2018-12-13 17:10:02 +08:00
parent c7af61f295
commit add60ec439
3 changed files with 114 additions and 96 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

64
manifests/keystone/auth.pp
View File

@ -5,80 +5,98 @@
# === Parameters # === Parameters
# #
# [*password*] # [*password*]
# Password for Manila user. Required. # (Required) Password for Manila user.
# #
# [*email*] # [*email*]
# Email for Manila user. Optional. Defaults to 'manila@localhost'. # (Optional) Email for Manila user.
# Defaults to 'manila@localhost'.
# #
# [*auth_name*] # [*auth_name*]
# Username for Manila service. Optional. Defaults to 'manila'. # (Optional) Username for Manila service.
# Defaults to 'manila'.
# #
# [*service_name*] # [*service_name*]
# (optional) Name of the service. # (Optional) Name of the service.
# Defaults to 'manila'. # Defaults to 'manila'.
# #
# [*service_name_v2*] # [*service_name_v2*]
# (optional) Name of the service. # (Optional) Name of the service.
# Defaults to 'manilav2'. # Defaults to 'manilav2'.
# #
# [*configure_endpoint*] # [*configure_endpoint*]
# [*configure_endpoint*] # Should Manila endpoint be configured? Optional.
# Should Manila endpoint be configured? Optional. Defaults to 'true'.
# API v1 endpoint should be enabled in Icehouse for compatibility with Nova. # API v1 endpoint should be enabled in Icehouse for compatibility with Nova.
# Defaults to true
# #
# [*service_type*] # [*service_type*]
# Type of service. Optional. Defaults to 'share'. # (Optional) Type of service.
# Defaults to 'share'.
# #
# [*service_description*] # [*service_description*]
# Description for keystone service. Optional. Defaults to 'Manila Service'. # (Optional) Description for keystone service.
# Defaults to 'Manila Service'.
# #
# [*region*] # [*region*]
# Region for endpoint. Optional. Defaults to 'RegionOne'. # (Optional) Region for endpoint.
# Defaults to 'RegionOne'.
# #
# [*tenant*] # [*tenant*]
# Tenant for Manila user. Optional. Defaults to 'services'. # (Optional) Tenant for Manila user.
# Defaults to 'services'.
# #
# [*public_url*] # [*public_url*]
# (optional) The endpoint's public url. (Defaults to 'http://127.0.0.1:8786/v1/%(tenant_id)s') # (0ptional) The endpoint's public url.
# This url should *not* contain any trailing '/'. # This url should *not* contain any trailing '/'.
# Defaults to 'http://127.0.0.1:8786/v1/%(tenant_id)s'
# #
# [*admin_url*] # [*admin_url*]
# (optional) The endpoint's admin url. (Defaults to 'http://127.0.0.1:8786/v1/%(tenant_id)s') # (Optional) The endpoint's admin url.
# This url should *not* contain any trailing '/'. # This url should *not* contain any trailing '/'.
# Defaults to 'http://127.0.0.1:8786/v1/%(tenant_id)s'
# #
# [*internal_url*] # [*internal_url*]
# (optional) The endpoint's internal url. (Defaults to 'http://127.0.0.1:8786/v1/%(tenant_id)s') # (Optional) The endpoint's internal url.
# This url should *not* contain any trailing '/'. # This url should *not* contain any trailing '/'.
# Defaults to 'http://127.0.0.1:8786/v1/%(tenant_id)s'
# #
# [*password_v2*] # [*password_v2*]
# Password for Manila v2 user. Optional. Defaults to undef. # (Optional) Password for Manila v2 user.
# Defaults to undef.
# #
# [*email_v2*] # [*email_v2*]
# Email for Manila v2 user. Optional. Defaults to 'manilav2@localhost'. # (Optional) Email for Manila v2 user.
# Defaults to 'manilav2@localhost'.
# #
# [*auth_name_v2*] # [*auth_name_v2*]
# Username for Manila v2 service. Optional. Defaults to 'manilav2'. # (Optional) Username for Manila v2 service.
# Defaults to 'manilav2'.
# #
# [*configure_endpoint_v2*] # [*configure_endpoint_v2*]
# Should Manila v2 endpoint be configured? Optional. Defaults to 'true'. # (Optional) Should Manila v2 endpoint be configured?
# Defaults to true.
# #
# [*service_type_v2*] # [*service_type_v2*]
# Type of service v2. Optional. Defaults to 'sharev2'. # (Optional) Type of service v2. Optional.
# Defaults to 'sharev2'.
# #
# [*service_description_v2*] # [*service_description_v2*]
# Description for keystone service v2. Optional. Defaults to 'Manila Service v2'. # (Optional) Description for keystone service v2.
# Defaults to 'Manila Service v2'.
# #
# [*public_url_v2*] # [*public_url_v2*]
# (optional) The v2 endpoint's public url. (Defaults to 'http://127.0.0.1:8786/v2/%(tenant_id)s') # (Optional) The v2 endpoint's public url.
# This url should *not* contain any trailing '/'. # This url should *not* contain any trailing '/'.
# Defaults to 'http://127.0.0.1:8786/v2/%(tenant_id)s'
# #
# [*admin_url_v2*] # [*admin_url_v2*]
# (optional) The endpoint's admin url. (Defaults to 'http://127.0.0.1:8786/v2/%(tenant_id)s') # (Optional) The endpoint's admin url.
# This url should *not* contain any trailing '/'. # This url should *not* contain any trailing '/'.
# Defaults to 'http://127.0.0.1:8786/v2/%(tenant_id)s'
# #
# [*internal_url_v2*] # [*internal_url_v2*]
# (optional) The endpoint's internal url. (Defaults to 'http://127.0.0.1:8786/v2/%(tenant_id)s') # (Optional) The endpoint's internal url.
# This url should *not* contain any trailing '/'. # This url should *not* contain any trailing '/'.
# Defaults to 'http://127.0.0.1:8786/v2/%(tenant_id)s'
# #
# === Examples # === Examples
# #

142
manifests/logging.pp
View File

@ -4,94 +4,94 @@
# #
# == parameters # == parameters
# #
# [*debug*] # [*debug*]
# (Optional) Should the daemons log debug messages # (Optional) Should the daemons log debug messages
# Defaults to $::os_service_default # Defaults to $::os_service_default
# #
# [*use_syslog*] # [*use_syslog*]
# (Optional) Use syslog for logging. # (Optional) Use syslog for logging.
# Defaults to $::os_service_default # Defaults to $::os_service_default
# #
# [*use_json*] # [*use_json*]
# (Optional) Use json for logging. # (Optional) Use json for logging.
# Defaults to $::os_service_default # Defaults to $::os_service_default
# #
# [*use_journal*] # [*use_journal*]
# (Optional) Use journal for logging. # (Optional) Use journal for logging.
# Defaults to $::os_service_default # Defaults to $::os_service_default
# #
# [*use_stderr*] # [*use_stderr*]
# (optional) Use stderr for logging # (Optional) Use stderr for logging
# Defaults to $::os_service_default # Defaults to $::os_service_default
# #
# [*log_facility*] # [*log_facility*]
# (Optional) Syslog facility to receive log lines. # (Optional) Syslog facility to receive log lines.
# Defaults to $::os_service_default # Defaults to $::os_service_default
# #
# [*log_dir*] # [*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. # If set to $::os_service_default, it will not log to any directory.
# Defaults to '/var/log/manila' # Defaults to '/var/log/manila'
# #
# [*logging_context_format_string*] # [*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 # Defaults to $::os_service_default
# Example: '%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s\ # Example: '%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s\
# [%(request_id)s %(user_identity)s] %(instance)s%(message)s' # [%(request_id)s %(user_identity)s] %(instance)s%(message)s'
# #
# [*logging_default_format_string*] # [*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 # Defaults to $::os_service_default
# Example: '%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s\ # Example: '%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s\
# [-] %(instance)s%(message)s' # [-] %(instance)s%(message)s'
# #
# [*logging_debug_format_suffix*] # [*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 # Defaults to $::os_service_default
# Example: '%(funcName)s %(pathname)s:%(lineno)d' # Example: '%(funcName)s %(pathname)s:%(lineno)d'
# #
# [*logging_exception_prefix*] # [*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 # Defaults to $::os_service_default
# Example: '%(asctime)s.%(msecs)03d %(process)d TRACE %(name)s %(instance)s' # Example: '%(asctime)s.%(msecs)03d %(process)d TRACE %(name)s %(instance)s'
# #
# [*log_config_append*] # [*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 # Defaults to $::os_service_default
# See https://docs.python.org/2/howto/logging.html # See https://docs.python.org/2/howto/logging.html
# #
# [*default_log_levels*] # [*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 # Defaults to $::os_service_default
# Example: # Example:
# { 'amqp' => 'WARN', 'amqplib' => 'WARN', 'boto' => 'WARN', # { 'amqp' => 'WARN', 'amqplib' => 'WARN', 'boto' => 'WARN',
# 'sqlalchemy' => 'WARN', 'suds' => 'INFO', 'iso8601' => 'WARN', # 'sqlalchemy' => 'WARN', 'suds' => 'INFO', 'iso8601' => 'WARN',
# 'requests.packages.urllib3.connectionpool' => 'WARN' } # 'requests.packages.urllib3.connectionpool' => 'WARN' }
# #
# [*publish_errors*] # [*publish_errors*]
# (optional) Publish error events (boolean value). # (Optional) Publish error events (boolean value).
# Defaults to $::os_service_default # Defaults to $::os_service_default
# #
# [*fatal_deprecations*] # [*fatal_deprecations*]
# (optional) Make deprecations fatal (boolean value) # (Optional) Make deprecations fatal (boolean value)
# Defaults to $::os_service_default # Defaults to $::os_service_default
# #
# [*instance_format*] # [*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). # like this (string value).
# Defaults to $::os_service_default # Defaults to $::os_service_default
# Example: '[instance: %(uuid)s] ' # Example: '[instance: %(uuid)s] '
# #
# [*instance_uuid_format*] # [*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). # it like this (string value).
# Defaults to $::os_service_default # Defaults to $::os_service_default
# Example: instance_uuid_format='[instance: %(uuid)s] ' # Example: instance_uuid_format='[instance: %(uuid)s] '
# #
# [*log_date_format*] # [*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 # Defaults to $::os_service_default
# Example: 'Y-%m-%d %H:%M:%S' # Example: 'Y-%m-%d %H:%M:%S'
# #
class manila::logging( class manila::logging(
$use_syslog = $::os_service_default, $use_syslog = $::os_service_default,

4
manifests/policy.pp
View File

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