Fix parameters comments
Fix comments format. Add default values. Change-Id: I000c184b573a9b6f487d8fd4f06e656131ac4af4
This commit is contained in:
ZhongShengping
parent
46171713bc
commit
caa4e47bea
@ -12,7 +12,7 @@
|
||||
#
|
||||
# [*keystone_user*]
|
||||
# (optional) The name of the auth user
|
||||
# Defaults to vitrage
|
||||
# Defaults to 'vitrage'
|
||||
#
|
||||
# [*keystone_tenant*]
|
||||
# (optional) Tenant to authenticate with.
|
||||
@ -21,22 +21,23 @@
|
||||
# [*keystone_password*]
|
||||
# Password to authenticate with.
|
||||
# Mandatory.
|
||||
# Defaults to false.
|
||||
#
|
||||
# [*keystone_auth_uri*]
|
||||
# (optional) Public Identity API endpoint.
|
||||
# Defaults to 'false'.
|
||||
# Defaults to false.
|
||||
#
|
||||
# [*keystone_identity_uri*]
|
||||
# (optional) Complete admin Identity API endpoint.
|
||||
# Defaults to: false
|
||||
# Defaults to false
|
||||
#
|
||||
# [*host*]
|
||||
# (optional) The vitrage api bind address.
|
||||
# Defaults to 0.0.0.0
|
||||
# Defaults to '0.0.0.0'
|
||||
#
|
||||
# [*port*]
|
||||
# (optional) The vitrage api port.
|
||||
# Defaults to 8999
|
||||
# Defaults to '8999'
|
||||
#
|
||||
# [*package_ensure*]
|
||||
# (optional) ensure state for package.
|
||||
@ -51,8 +52,6 @@
|
||||
# to make vitrage-api be a web app using apache mod_wsgi.
|
||||
# Defaults to '$::vitrage::params::api_service_name'
|
||||
#
|
||||
|
||||
|
||||
class vitrage::api (
|
||||
$manage_service = true,
|
||||
$enabled = true,
|
||||
|
||||
@ -1,38 +1,37 @@
|
||||
# The vitrage::auth class helps configure auth settings
|
||||
#
|
||||
# == Parameters
|
||||
# [*auth_url*]
|
||||
# the keystone public endpoint
|
||||
# Optional. Defaults to 'http://localhost:5000'
|
||||
# [*auth_url*]
|
||||
# (Optional) The keystone public endpoint
|
||||
# Defaults to 'http://localhost:5000'
|
||||
#
|
||||
# [*auth_region*]
|
||||
# the keystone region of this node
|
||||
# Optional. Defaults to 'RegionOne'
|
||||
# [*auth_region*]
|
||||
# (Optional) The keystone region of this node
|
||||
# Defaults to 'RegionOne'
|
||||
#
|
||||
# [*auth_user*]
|
||||
# the keystone user for vitrage services
|
||||
# Optional. Defaults to 'vitrage'
|
||||
# [*auth_user*]
|
||||
# (Optional) The keystone user for vitrage services
|
||||
# Defaults to 'vitrage'
|
||||
#
|
||||
# [*auth_password*]
|
||||
# the keystone password for vitrage services
|
||||
# Required.
|
||||
# [*auth_password*]
|
||||
# (Required) The keystone password for vitrage services
|
||||
#
|
||||
# [*auth_tenant_name*]
|
||||
# the keystone tenant name for vitrage services
|
||||
# Optional. Defaults to 'services'
|
||||
# [*auth_tenant_name*]
|
||||
# (Optional) The keystone tenant name for vitrage services
|
||||
# Defaults to 'services'
|
||||
#
|
||||
# [*auth_tenant_id*]
|
||||
# the keystone tenant id for vitrage services.
|
||||
# Optional. Defaults to $::os_service_default.
|
||||
# [*auth_tenant_id*]
|
||||
# (Optional) The keystone tenant id for vitrage services.
|
||||
# Defaults to $::os_service_default.
|
||||
#
|
||||
# [*auth_cacert*]
|
||||
# Certificate chain for SSL validation.
|
||||
# Optional. Defaults to $::os_service_default.
|
||||
# [*auth_cacert*]
|
||||
# (Optional) Certificate chain for SSL validation.
|
||||
# Defaults to $::os_service_default.
|
||||
#
|
||||
# [*auth_endpoint_type*]
|
||||
# Type of endpoint in Identity service catalog to use for
|
||||
# communication with OpenStack services.
|
||||
# Optional. Defaults to $::os_service_default.
|
||||
# [*auth_endpoint_type*]
|
||||
# (Optional) Type of endpoint in Identity service catalog to use for
|
||||
# communication with OpenStack services.
|
||||
# Defaults to $::os_service_default.
|
||||
#
|
||||
class vitrage::auth (
|
||||
$auth_password,
|
||||
|
||||
@ -2,8 +2,9 @@
|
||||
# Installs the vitrage python library.
|
||||
#
|
||||
# == parameters
|
||||
# [*ensure*]
|
||||
# ensure state for package.
|
||||
# [*ensure*]
|
||||
# (Optional) Ensure state for package.
|
||||
# Defaults to 'present'
|
||||
#
|
||||
class vitrage::client (
|
||||
$ensure = 'present'
|
||||
|
||||
@ -5,8 +5,8 @@
|
||||
# === Parameters
|
||||
#
|
||||
# [*database_connection*]
|
||||
# Url used to connect to database.
|
||||
# (Optional) Defaults to "mysql://vitrage:secrete@localhost:3306/vitrage".
|
||||
# (Optional) Url used to connect to database.
|
||||
# Defaults to "mysql://vitrage:secrete@localhost:3306/vitrage".
|
||||
#
|
||||
# [*database_max_retries*]
|
||||
# (Optional) Maximum number of database connection retries during startup.
|
||||
|
||||
@ -7,7 +7,6 @@
|
||||
#
|
||||
# [*password*]
|
||||
# (Mandatory) Password to connect to the database.
|
||||
# Defaults to 'false'.
|
||||
#
|
||||
# [*dbname*]
|
||||
# (Optional) Name of the database.
|
||||
@ -23,7 +22,7 @@
|
||||
#
|
||||
# [*allowed_hosts*]
|
||||
# (Optional) Other hosts the user is allowed to connect from.
|
||||
# Defaults to 'undef'.
|
||||
# Defaults to undef.
|
||||
#
|
||||
# [*charset*]
|
||||
# (Optional) The database charset.
|
||||
|
||||
@ -16,13 +16,13 @@
|
||||
# (Optional) User to connect to the database.
|
||||
# Defaults to 'vitrage'.
|
||||
#
|
||||
# [*encoding*]
|
||||
# (Optional) The charset to use for the database.
|
||||
# Default to undef.
|
||||
# [*encoding*]
|
||||
# (Optional) The charset to use for the database.
|
||||
# Default to undef.
|
||||
#
|
||||
# [*privileges*]
|
||||
# (Optional) Privileges given to the database user.
|
||||
# Default to 'ALL'
|
||||
# [*privileges*]
|
||||
# (Optional) Privileges given to the database user.
|
||||
# Default to 'ALL'
|
||||
#
|
||||
class vitrage::db::postgresql(
|
||||
$password,
|
||||
|
||||
@ -8,46 +8,55 @@
|
||||
# (required) Password for vitrage user.
|
||||
#
|
||||
# [*auth_name*]
|
||||
# Username for vitrage service. Defaults to 'vitrage'.
|
||||
# (Optional) Username for vitrage service.
|
||||
# Defaults to 'vitrage'.
|
||||
#
|
||||
# [*email*]
|
||||
# Email for vitrage user. Defaults to 'vitrage@localhost'.
|
||||
# (Optional) Email for vitrage user.
|
||||
# Defaults to 'vitrage@localhost'.
|
||||
#
|
||||
# [*tenant*]
|
||||
# Tenant for vitrage user. Defaults to 'services'.
|
||||
# (Optional) Tenant for vitrage user.
|
||||
# Defaults to 'services'.
|
||||
#
|
||||
# [*configure_endpoint*]
|
||||
# Should vitrage endpoint be configured? Defaults to 'true'.
|
||||
# (Optional) Should vitrage endpoint be configured?
|
||||
# Defaults to true.
|
||||
#
|
||||
# [*configure_user*]
|
||||
# (Optional) Should the service user be configured?
|
||||
# Defaults to 'true'.
|
||||
# Defaults to true.
|
||||
#
|
||||
# [*configure_user_role*]
|
||||
# (Optional) Should the admin role be configured for the service user?
|
||||
# Defaults to 'true'.
|
||||
# Defaults to true.
|
||||
#
|
||||
# [*service_type*]
|
||||
# Type of service. Defaults to 'rca'.
|
||||
# (Optional) Type of service.
|
||||
# Defaults to 'rca'.
|
||||
#
|
||||
# [*region*]
|
||||
# Region for endpoint. Defaults to 'RegionOne'.
|
||||
# (Optional) Region for endpoint.
|
||||
# Defaults to 'RegionOne'.
|
||||
#
|
||||
# [*service_name*]
|
||||
# (optional) Name of the service.
|
||||
# Defaults to the value of auth_name.
|
||||
#
|
||||
# [*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 '/'.
|
||||
# Defaults to 'http://127.0.0.1:8999'
|
||||
#
|
||||
# [*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 '/'.
|
||||
# Defaults to 'http://127.0.0.1:8999'
|
||||
#
|
||||
# [*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 '/'.
|
||||
# Defaults to 'http://127.0.0.1:8999'
|
||||
#
|
||||
class vitrage::keystone::auth (
|
||||
$password,
|
||||
|
||||
@ -5,88 +5,88 @@
|
||||
# == 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_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 the $::os_service_default, it will not log to
|
||||
# any directory.
|
||||
# Defaults to '/var/log/vitrage'.
|
||||
# [*log_dir*]
|
||||
# (optional) Directory where logs should be stored.
|
||||
# If set to boolean false or the $::os_service_default, it will not log to
|
||||
# any directory.
|
||||
# Defaults to '/var/log/vitrage'.
|
||||
#
|
||||
# [*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*]
|
||||
# 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*]
|
||||
# (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' }
|
||||
#
|
||||
# [*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).
|
||||
# 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(
|
||||
$use_syslog = $::os_service_default,
|
||||
$use_stderr = $::os_service_default,
|
||||
|
||||
@ -1,3 +1,5 @@
|
||||
# == Class: vitrage::params
|
||||
#
|
||||
# Parameters for puppet-vitrage
|
||||
#
|
||||
class vitrage::params {
|
||||
|
||||
@ -21,7 +21,7 @@
|
||||
#
|
||||
# [*policy_path*]
|
||||
# (optional) Path to the nova policy.json file
|
||||
# Defaults to /etc/vitrage/policy.json
|
||||
# Defaults to '/etc/vitrage/policy.json'
|
||||
#
|
||||
class vitrage::policy (
|
||||
$policies = {},
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user