Cleanup documentation
Make sure documentation is the same and follow the standard which we are trying to enforce on all modules. Change-Id: Id94b5c3da7f1999e260d061c7670946f8f5bd29b
This commit is contained in:
parent
7cf9f3c3d6
commit
8d9472f1f4
@ -3,7 +3,7 @@
|
||||
# This class can be used to create tables, users and grant
|
||||
# privileges for a mysql gnocchi database.
|
||||
#
|
||||
# == parameters
|
||||
# == Parameters
|
||||
#
|
||||
# [*password*]
|
||||
# (Required) Password to connect to the database.
|
||||
@ -33,15 +33,6 @@
|
||||
# Only used with mysql modules >= 2.2.
|
||||
# Defaults to 'utf8_general_ci'
|
||||
#
|
||||
# == Dependencies
|
||||
# Class['mysql::server']
|
||||
#
|
||||
# == Examples
|
||||
#
|
||||
# == Authors
|
||||
#
|
||||
# == Copyright
|
||||
#
|
||||
class gnocchi::db::mysql(
|
||||
$password,
|
||||
$dbname = 'gnocchi',
|
||||
|
@ -2,14 +2,14 @@
|
||||
# Class to execute "gnocchi-dbsync"
|
||||
#
|
||||
# [*user*]
|
||||
# (optional) User to run dbsync command.
|
||||
# (Optional) User to run dbsync command.
|
||||
# Defaults to 'gnocchi'
|
||||
#
|
||||
# [*extra_opts*]
|
||||
# (optional) String of extra command line parameters to append
|
||||
# (Optional) String of extra command line parameters to append
|
||||
# to the gnocchi-db-sync command.
|
||||
# Defaults to undef
|
||||
|
||||
#
|
||||
class gnocchi::db::sync (
|
||||
$user = 'gnocchi',
|
||||
$extra_opts = undef,
|
||||
|
@ -5,49 +5,58 @@
|
||||
# === Parameters
|
||||
#
|
||||
# [*password*]
|
||||
# (required) Password for gnocchi user.
|
||||
# (Required) Password for gnocchi user.
|
||||
#
|
||||
# [*auth_name*]
|
||||
# Username for gnocchi service. Defaults to 'gnocchi'.
|
||||
# (Optional) Username for gnocchi service.
|
||||
# Defaults to 'gnocchi'.
|
||||
#
|
||||
# [*email*]
|
||||
# Email for gnocchi user. Defaults to 'gnocchi@localhost'.
|
||||
# (Optional) Email for gnocchi user.
|
||||
# Defaults to 'gnocchi@localhost'.
|
||||
#
|
||||
# [*tenant*]
|
||||
# Tenant for gnocchi user. Defaults to 'services'.
|
||||
# (Optional) Tenant for gnocchi user.
|
||||
# Defaults to 'services'.
|
||||
#
|
||||
# [*configure_endpoint*]
|
||||
# Should gnocchi endpoint be configured? Defaults to 'true'.
|
||||
# (Optional) Should gnocchi 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 'key-manager'.
|
||||
# (Optional) Type of service.
|
||||
# Defaults to 'key-manager'.
|
||||
#
|
||||
# [*region*]
|
||||
# Region for endpoint. Defaults to 'RegionOne'.
|
||||
# (Optional) Region for endpoint.
|
||||
# Defaults to 'RegionOne'.
|
||||
#
|
||||
# [*service_name*]
|
||||
# (optional) Name of the service.
|
||||
# (Optional) Name of the service.
|
||||
# Defaults to 'gnocchi'
|
||||
#
|
||||
# [*public_url*]
|
||||
# (optional) The endpoint's public url. (Defaults to 'http://127.0.0.1:8041')
|
||||
# (0ptional) The endpoint's public url.
|
||||
# This url should *not* contain any trailing '/'.
|
||||
# Defaults to 'http://127.0.0.1:8041'
|
||||
#
|
||||
# [*admin_url*]
|
||||
# (optional) The endpoint's admin url. (Defaults to 'http://127.0.0.1:8041')
|
||||
# (Optional) The endpoint's admin url.
|
||||
# This url should *not* contain any trailing '/'.
|
||||
# Defaults to 'http://127.0.0.1:8041'
|
||||
#
|
||||
# [*internal_url*]
|
||||
# (optional) The endpoint's internal url. (Defaults to 'http://127.0.0.1:8041')
|
||||
# (Optional) The endpoint's internal url.
|
||||
# This url should *not* contain any trailing '/'.
|
||||
# Defaults to 'http://127.0.0.1:8041'
|
||||
#
|
||||
# [*service_description*]
|
||||
# (Optional) Description for keystone service.
|
||||
|
@ -4,35 +4,35 @@
|
||||
#
|
||||
# == 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 boolean false or the $::os_service_default, it will not log to
|
||||
# any directory.
|
||||
# Defaults to '/var/log/gnocchi'
|
||||
# [*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/gnocchi'
|
||||
#
|
||||
class gnocchi::logging(
|
||||
$use_syslog = $::os_service_default,
|
||||
|
@ -5,7 +5,7 @@
|
||||
# === Parameters
|
||||
#
|
||||
# [*policies*]
|
||||
# (optional) Set of policies to configure for gnocchi
|
||||
# (Optional) Set of policies to configure for gnocchi
|
||||
# Example :
|
||||
# {
|
||||
# 'gnocchi-context_is_admin' => {
|
||||
@ -20,7 +20,7 @@
|
||||
# Defaults to empty hash.
|
||||
#
|
||||
# [*policy_path*]
|
||||
# (optional) Path to the nova policy.json file
|
||||
# (Optional) Path to the nova policy.json file
|
||||
# Defaults to /etc/gnocchi/policy.json
|
||||
#
|
||||
class gnocchi::policy (
|
||||
|
Loading…
Reference in New Issue
Block a user