openstack/puppet-keystone
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: I215f28f4ce417a3c098cbf4be21967b2ed4013bb
This commit is contained in:
ZhongShengping 2018-12-13 17:10:01 +08:00
parent 53d21bffb7
commit 5f5eb4c369
4 changed files with 83 additions and 97 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
manifests/db/mysql.pp
View File

@ -3,7 +3,7 @@
# This class can be used to create tables, users and grant # This class can be used to create tables, users and grant
# privilege for a mysql keystone database. # privilege for a mysql keystone database.
# #
# == parameters # == Parameters
# #
# [*password*] # [*password*]
# (Required) Password to connect to the database. # (Required) Password to connect to the database.
@ -33,20 +33,6 @@
# Only used with mysql modules >= 2.2. # Only used with mysql modules >= 2.2.
# Defaults to 'utf8_general_ci' # Defaults to 'utf8_general_ci'
# #
# === Deprecated Parameters
#
# == Dependencies
# Class['mysql::server']
#
# == Examples
# == Authors
#
# Dan Bode dan@puppetlabs.com
#
# == Copyright
#
# Copyright 2012 Puppetlabs Inc, unless otherwise noted.
#
class keystone::db::mysql( class keystone::db::mysql(
$password, $password,
$dbname = 'keystone', $dbname = 'keystone',

4
manifests/db/sync.pp
View File

@ -4,14 +4,14 @@
# == Parameters # == Parameters
# #
# [*extra_params*] # [*extra_params*]
# (optional) String of extra command line parameters to append # (Optional) String of extra command line parameters to append
# to the keystone-manage db_sync command. These will be # to the keystone-manage db_sync command. These will be
# inserted in the command line between 'keystone-manage' and # inserted in the command line between 'keystone-manage' and
# 'db_sync' in the command line. # 'db_sync' in the command line.
# Defaults to '' # Defaults to ''
# #
# [*keystone_user*] # [*keystone_user*]
# (optional) Specify the keystone system user to be used with keystone-manage. # (Optional) Specify the keystone system user to be used with keystone-manage.
# Defaults to $::keystone::params::keystone_user # Defaults to $::keystone::params::keystone_user
# #
class keystone::db::sync( class keystone::db::sync(

156
manifests/logging.pp
View File

@ -4,107 +4,107 @@
# #
# == 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_journal*] # [*use_journal*]
# (Optional) Use journal for logging. # (Optional) Use journal for logging.
# Defaults to $::os_service_default # Defaults to $::os_service_default
# #
# [*use_json*] # [*use_json*]
# (Optional) Use JSON format for logging. # (Optional) Use JSON format 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/keystone' # Defaults to '/var/log/keystone'
# #
# [*log_file*] # [*log_file*]
# (optional) File where logs should be stored. # (Optional) File where logs should be stored.
# Defaults to $::os_service_default # Defaults to $::os_service_default
# #
# [*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'
# #
# [*logging_user_identity_format*] # [*logging_user_identity_format*]
# (Optional) Defines the format string for %(user_identity)s that is used in logging_context_format_string. # (Optional) Defines the format string for %(user_identity)s that is used in logging_context_format_string.
# Defaults to $::os_service_default # Defaults to $::os_service_default
# Example: '%(user)s %(tenant)s %(domain)s %(user_domain)s %(project_domain)s' # Example: '%(user)s %(tenant)s %(domain)s %(user_domain)s %(project_domain)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', # 'sqlalchemy' => 'WARN', 'suds' => 'INFO',
# 'oslo.messaging' => 'INFO', 'iso8601' => 'WARN', # 'oslo.messaging' => 'INFO', 'iso8601' => 'WARN',
# 'requests.packages.urllib3.connectionpool' => 'WARN', # 'requests.packages.urllib3.connectionpool' => 'WARN',
# 'urllib3.connectionpool' => 'WARN', # 'urllib3.connectionpool' => 'WARN',
# 'websocket' => 'WARN', 'keystonemiddleware' => 'WARN', # 'websocket' => 'WARN', 'keystonemiddleware' => 'WARN',
# 'routes.middleware' => 'WARN', stevedore => 'WARN' } # 'routes.middleware' => 'WARN', stevedore => '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'
# #
# [*watch_log_file*] # [*watch_log_file*]
# (Optional) Uses logging handler designed to watch file system (boolean value). # (Optional) Uses logging handler designed to watch file system (boolean value).

4
manifests/policy.pp
View File

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