Cleanup documentation
Make sure documentation is the same and follow the standard which we are trying to enforce on all modules. Change-Id: I3ec7774580b861371290d0ce3aa257d2aa7a15ab
This commit is contained in:
ZhongShengping
parent
52410af493
commit
f765eb0b0b
|
|
@ -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 heat-manage db_sync command. These will be inserted
|
||||
# in the command line between 'heat-manage' and 'db_sync'.
|
||||
# Defaults to '--config-file /etc/heat/heat.conf'
|
||||
|
|
|
|||
|
|
@ -16,19 +16,19 @@
|
|||
#
|
||||
# [*configure_endpoint*]
|
||||
# (Optional) Should heat endpoint be configured?
|
||||
# Defaults to 'true'.
|
||||
# Defaults to true.
|
||||
#
|
||||
# [*configure_service*]
|
||||
# (Optional) Should heat service be configured?
|
||||
# Defaults to 'true'.
|
||||
# Defaults to true.
|
||||
#
|
||||
# [*configure_user*]
|
||||
# (Optional) Whether to create the service user.
|
||||
# Defaults to 'true'.
|
||||
# Defaults to true.
|
||||
#
|
||||
# [*configure_user_role*]
|
||||
# (Optional) Whether to configure the admin role for the service user.
|
||||
# Defaults to 'true'.
|
||||
# Defaults to true.
|
||||
#
|
||||
# [*service_name*]
|
||||
# (Optional) Name of the service.
|
||||
|
|
@ -51,28 +51,31 @@
|
|||
# Defaults to 'services'.
|
||||
#
|
||||
# [*trusts_delegated_roles*]
|
||||
# (optional) Array of trustor roles to be delegated to heat.
|
||||
# (Optional) Array of trustor roles to be delegated to heat.
|
||||
# Defaults to ['heat_stack_owner']
|
||||
#
|
||||
# [*configure_delegated_roles*]
|
||||
# (optional) Whether to configure the delegated roles.
|
||||
# (Optional) Whether to configure the delegated roles.
|
||||
# Defaults to false until the deprecated parameters in heat::engine
|
||||
# are removed after Kilo.
|
||||
#
|
||||
# [*public_url*]
|
||||
# (optional) The endpoint's public url. (Defaults to 'http://127.0.0.1:8004/v1/%(tenant_id)s')
|
||||
# (Optional) The endpoint's public url.
|
||||
# This url should *not* contain any trailing '/'.
|
||||
# Defaults to 'http://127.0.0.1:8004/v1/%(tenant_id)s'
|
||||
#
|
||||
# [*admin_url*]
|
||||
# (optional) The endpoint's admin url. (Defaults to 'http://127.0.0.1:8004/v1/%(tenant_id)s')
|
||||
# (Optional) The endpoint's admin url.
|
||||
# This url should *not* contain any trailing '/'.
|
||||
# Defaults to 'http://127.0.0.1:8004/v1/%(tenant_id)s'
|
||||
#
|
||||
# [*internal_url*]
|
||||
# (optional) The endpoint's internal url. (Defaults to 'http://127.0.0.1:8004/v1/%(tenant_id)s')
|
||||
# (Optional) The endpoint's internal url.
|
||||
# This url should *not* contain any trailing '/'.
|
||||
# Defaults to 'http://127.0.0.1:8004/v1/%(tenant_id)s'
|
||||
#
|
||||
# [*heat_stack_user_role*]
|
||||
# (optional) Keystone role for heat template-defined users.
|
||||
# (Optional) Keystone role for heat template-defined users.
|
||||
# In this context this will create the role for the heat_stack_user.
|
||||
# It will not set the value in the config file, if you want to do
|
||||
# that you must set heat::engine::heat_stack_user_role. Generally
|
||||
|
|
@ -80,7 +83,7 @@
|
|||
# Defaults to 'heat_stack_user'
|
||||
|
||||
# [*manage_heat_stack_user_role*]
|
||||
# (optional) If true, this will manage the Keystone role for
|
||||
# (Optional) If true, this will manage the Keystone role for
|
||||
# $heat_stack_user_role.
|
||||
# Defaults to true
|
||||
#
|
||||
|
|
|
|||
|
|
@ -4,64 +4,64 @@
|
|||
#
|
||||
# === 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 $::os_service_default, it will not log to any directory.
|
||||
# Defaults to '/var/log/heat'
|
||||
# [*log_dir*]
|
||||
# (Optional) Directory where logs should be stored.
|
||||
# If set to $::os_service_default, it will not log to any directory.
|
||||
# Defaults to '/var/log/heat'
|
||||
#
|
||||
# [*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
|
||||
# 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.
|
||||
# (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.
|
||||
# (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.
|
||||
# (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.
|
||||
# (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.
|
||||
# (0ptional) Hash of logger (keys) and level (values) pairs.
|
||||
# Defaults to $::os_service_default.
|
||||
# Example:
|
||||
# {'amqp' => 'WARN', 'amqplib' => 'WARN', 'boto' => 'WARN',
|
||||
|
|
@ -69,27 +69,27 @@
|
|||
# 'requests.packages.urllib3.connectionpool' => 'WARN' }
|
||||
#
|
||||
# [*publish_errors*]
|
||||
# (optional) Publish error events (boolean value).
|
||||
# (Optional) Publish error events (boolean value).
|
||||
# Defaults to $::os_service_default.
|
||||
#
|
||||
# [*fatal_deprecations*]
|
||||
# (optional) Make deprecations fatal (boolean value).
|
||||
# (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
|
||||
# (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
|
||||
# (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.
|
||||
# (Optional) Format string for %%(asctime)s in log records.
|
||||
# Defaults to $::os_service_default.
|
||||
# Example: 'Y-%m-%d %H:%M:%S'
|
||||
#
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@
|
|||
# === Parameters
|
||||
#
|
||||
# [*policies*]
|
||||
# (optional) Set of policies to configure for heat
|
||||
# (Optional) Set of policies to configure for heat
|
||||
# Example :
|
||||
# {
|
||||
# 'heat-context_is_admin' => {
|
||||
|
|
@ -20,7 +20,7 @@
|
|||
# Defaults to empty hash.
|
||||
#
|
||||
# [*policy_path*]
|
||||
# (optional) Path to the heat policy.json file
|
||||
# (Optional) Path to the heat policy.json file
|
||||
# Defaults to /etc/heat/policy.json
|
||||
#
|
||||
class heat::policy (
|
||||
|
|
|
|||
Loading…
Reference in New Issue