openstack/puppet-vitrage
Code Issues Proposed changes

Fix parameters comments

Browse Source 
Fix comments format.
Add default values.

Change-Id: I000c184b573a9b6f487d8fd4f06e656131ac4af4
This commit is contained in:
ZhongShengping 2016-06-02 11:25:35 +08:00
parent 46171713bc
commit caa4e47bea
10 changed files with 133 additions and 124 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
manifests/api.pp
View File

@ -12,7 +12,7 @@
# #
# [*keystone_user*] # [*keystone_user*]
# (optional) The name of the auth user # (optional) The name of the auth user
# Defaults to vitrage # Defaults to 'vitrage'
# #
# [*keystone_tenant*] # [*keystone_tenant*]
# (optional) Tenant to authenticate with. # (optional) Tenant to authenticate with.
@ -21,22 +21,23 @@
# [*keystone_password*] # [*keystone_password*]
# Password to authenticate with. # Password to authenticate with.
# Mandatory. # Mandatory.
# Defaults to false.
# #
# [*keystone_auth_uri*] # [*keystone_auth_uri*]
# (optional) Public Identity API endpoint. # (optional) Public Identity API endpoint.
# Defaults to 'false'. # Defaults to false.
# #
# [*keystone_identity_uri*] # [*keystone_identity_uri*]
# (optional) Complete admin Identity API endpoint. # (optional) Complete admin Identity API endpoint.
# Defaults to: false # Defaults to false
# #
# [*host*] # [*host*]
# (optional) The vitrage api bind address. # (optional) The vitrage api bind address.
# Defaults to 0.0.0.0 # Defaults to '0.0.0.0'
# #
# [*port*] # [*port*]
# (optional) The vitrage api port. # (optional) The vitrage api port.
# Defaults to 8999 # Defaults to '8999'
# #
# [*package_ensure*] # [*package_ensure*]
# (optional) ensure state for package. # (optional) ensure state for package.
@ -51,8 +52,6 @@
# to make vitrage-api be a web app using apache mod_wsgi. # to make vitrage-api be a web app using apache mod_wsgi.
# Defaults to '$::vitrage::params::api_service_name' # Defaults to '$::vitrage::params::api_service_name'
# #
class vitrage::api ( class vitrage::api (
$manage_service = true, $manage_service = true,
$enabled = true, $enabled = true,

49
manifests/auth.pp
View File

@ -1,38 +1,37 @@
# The vitrage::auth class helps configure auth settings # The vitrage::auth class helps configure auth settings
# #
# == Parameters # == Parameters
# [*auth_url*] # [*auth_url*]
# the keystone public endpoint # (Optional) The keystone public endpoint
# Optional. Defaults to 'http://localhost:5000' # Defaults to 'http://localhost:5000'
# #
# [*auth_region*] # [*auth_region*]
# the keystone region of this node # (Optional) The keystone region of this node
# Optional. Defaults to 'RegionOne' # Defaults to 'RegionOne'
# #
# [*auth_user*] # [*auth_user*]
# the keystone user for vitrage services # (Optional) The keystone user for vitrage services
# Optional. Defaults to 'vitrage' # Defaults to 'vitrage'
# #
# [*auth_password*] # [*auth_password*]
# the keystone password for vitrage services # (Required) The keystone password for vitrage services
# Required.
# #
# [*auth_tenant_name*] # [*auth_tenant_name*]
# the keystone tenant name for vitrage services # (Optional) The keystone tenant name for vitrage services
# Optional. Defaults to 'services' # Defaults to 'services'
# #
# [*auth_tenant_id*] # [*auth_tenant_id*]
# the keystone tenant id for vitrage services. # (Optional) The keystone tenant id for vitrage services.
# Optional. Defaults to $::os_service_default. # Defaults to $::os_service_default.
# #
# [*auth_cacert*] # [*auth_cacert*]
# Certificate chain for SSL validation. # (Optional) Certificate chain for SSL validation.
# Optional. Defaults to $::os_service_default. # Defaults to $::os_service_default.
# #
# [*auth_endpoint_type*] # [*auth_endpoint_type*]
# Type of endpoint in Identity service catalog to use for # (Optional) Type of endpoint in Identity service catalog to use for
# communication with OpenStack services. # communication with OpenStack services.
# Optional. Defaults to $::os_service_default. # Defaults to $::os_service_default.
# #
class vitrage::auth ( class vitrage::auth (
$auth_password, $auth_password,

5
manifests/client.pp
View File

@ -2,8 +2,9 @@
# Installs the vitrage python library. # Installs the vitrage python library.
# #
# == parameters # == parameters
# [*ensure*] # [*ensure*]
# ensure state for package. # (Optional) Ensure state for package.
# Defaults to 'present'
# #
class vitrage::client ( class vitrage::client (
$ensure = 'present' $ensure = 'present'

4
manifests/db.pp
View File

@ -5,8 +5,8 @@
# === Parameters # === Parameters
# #
# [*database_connection*] # [*database_connection*]
# Url used to connect to database. # (Optional) Url used to connect to database.
# (Optional) Defaults to "mysql://vitrage:secrete@localhost:3306/vitrage". # Defaults to "mysql://vitrage:secrete@localhost:3306/vitrage".
# #
# [*database_max_retries*] # [*database_max_retries*]
# (Optional) Maximum number of database connection retries during startup. # (Optional) Maximum number of database connection retries during startup.

3
manifests/db/mysql.pp
View File

@ -7,7 +7,6 @@
# #
# [*password*] # [*password*]
# (Mandatory) Password to connect to the database. # (Mandatory) Password to connect to the database.
# Defaults to 'false'.
# #
# [*dbname*] # [*dbname*]
# (Optional) Name of the database. # (Optional) Name of the database.
@ -23,7 +22,7 @@
# #
# [*allowed_hosts*] # [*allowed_hosts*]
# (Optional) Other hosts the user is allowed to connect from. # (Optional) Other hosts the user is allowed to connect from.
# Defaults to 'undef'. # Defaults to undef.
# #
# [*charset*] # [*charset*]
# (Optional) The database charset. # (Optional) The database charset.

12
manifests/db/postgresql.pp
View File

@ -16,13 +16,13 @@
# (Optional) User to connect to the database. # (Optional) User to connect to the database.
# Defaults to 'vitrage'. # Defaults to 'vitrage'.
# #
# [*encoding*] # [*encoding*]
# (Optional) The charset to use for the database. # (Optional) The charset to use for the database.
# Default to undef. # Default to undef.
# #
# [*privileges*] # [*privileges*]
# (Optional) Privileges given to the database user. # (Optional) Privileges given to the database user.
# Default to 'ALL' # Default to 'ALL'
# #
class vitrage::db::postgresql( class vitrage::db::postgresql(
$password, $password,

31
manifests/keystone/auth.pp
View File

@ -8,46 +8,55 @@
# (required) Password for vitrage user. # (required) Password for vitrage user.
# #
# [*auth_name*] # [*auth_name*]
# Username for vitrage service. Defaults to 'vitrage'. # (Optional) Username for vitrage service.
# Defaults to 'vitrage'.
# #
# [*email*] # [*email*]
# Email for vitrage user. Defaults to 'vitrage@localhost'. # (Optional) Email for vitrage user.
# Defaults to 'vitrage@localhost'.
# #
# [*tenant*] # [*tenant*]
# Tenant for vitrage user. Defaults to 'services'. # (Optional) Tenant for vitrage user.
# Defaults to 'services'.
# #
# [*configure_endpoint*] # [*configure_endpoint*]
# Should vitrage endpoint be configured? Defaults to 'true'. # (Optional) Should vitrage endpoint be configured?
# Defaults to true.
# #
# [*configure_user*] # [*configure_user*]
# (Optional) Should the service user be configured? # (Optional) Should the service user be configured?
# Defaults to 'true'. # Defaults to true.
# #
# [*configure_user_role*] # [*configure_user_role*]
# (Optional) Should the admin role be configured for the service user? # (Optional) Should the admin role be configured for the service user?
# Defaults to 'true'. # Defaults to true.
# #
# [*service_type*] # [*service_type*]
# Type of service. Defaults to 'rca'. # (Optional) Type of service.
# Defaults to 'rca'.
# #
# [*region*] # [*region*]
# Region for endpoint. Defaults to 'RegionOne'. # (Optional) Region for endpoint.
# Defaults to 'RegionOne'.
# #
# [*service_name*] # [*service_name*]
# (optional) Name of the service. # (optional) Name of the service.
# Defaults to the value of auth_name. # Defaults to the value of auth_name.
# #
# [*public_url*] # [*public_url*]
# (optional) The endpoint's public url. (Defaults to 'http://127.0.0.1:8999') # (optional) 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:8999'
# #
# [*admin_url*] # [*admin_url*]
# (optional) The endpoint's admin url. (Defaults to 'http://127.0.0.1:8999') # (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:8999'
# #
# [*internal_url*] # [*internal_url*]
# (optional) The endpoint's internal url. (Defaults to 'http://127.0.0.1:8999') # (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:8999'
# #
class vitrage::keystone::auth ( class vitrage::keystone::auth (
$password, $password,

136
manifests/logging.pp
View File

@ -5,88 +5,88 @@
# == 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_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 boolean false or the $::os_service_default, it will not log to # If set to boolean false or the $::os_service_default, it will not log to
# any directory. # any directory.
# Defaults to '/var/log/vitrage'. # Defaults to '/var/log/vitrage'.
# #
# [*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. # 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. # (optional) 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*]
# (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'
# #
# [*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'
class vitrage::logging( class vitrage::logging(
$use_syslog = $::os_service_default, $use_syslog = $::os_service_default,
$use_stderr = $::os_service_default, $use_stderr = $::os_service_default,

2
manifests/params.pp
View File

@ -1,3 +1,5 @@
# == Class: vitrage::params
#
# Parameters for puppet-vitrage # Parameters for puppet-vitrage
# #
class vitrage::params { class vitrage::params {

2
manifests/policy.pp
View File

@ -21,7 +21,7 @@
# #
# [*policy_path*] # [*policy_path*]
# (optional) Path to the nova policy.json file # (optional) Path to the nova policy.json file
# Defaults to /etc/vitrage/policy.json # Defaults to '/etc/vitrage/policy.json'
# #
class vitrage::policy ( class vitrage::policy (
$policies = {}, $policies = {},