Merge "Cleanup documentation"

This commit is contained in:
Zuul 2018-12-25 05:21:48 +00:00 committed by Gerrit Code Review
commit d7f5bfc2ff
4 changed files with 39 additions and 30 deletions

View File

@ -4,17 +4,16 @@
# ==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 neutron-db-manage upgrade heads command. These will be # to the neutron-db-manage upgrade heads command. These will be
# inserted in the command line between 'neutron-db-manage' and # inserted in the command line between 'neutron-db-manage' and
# 'upgrade heads'. # 'upgrade heads'.
# Defaults to '' # Defaults to ''
# #
# [*db_sync_timeout*] # [*db_sync_timeout*]
# (optional) Timeout for the execution of the db_sync # (Optional) Timeout for the execution of the db_sync
# Defaults to 300 # Defaults to 300
# #
#
class neutron::db::sync( class neutron::db::sync(
$extra_params = '', $extra_params = '',
$db_sync_timeout = 300, $db_sync_timeout = 300,

View File

@ -5,51 +5,62 @@
# === Parameters # === Parameters
# #
# [*password*] # [*password*]
# (required) Password for Neutron user. # (Required) Password for Neutron user.
# #
# [*auth_name*] # [*auth_name*]
# Username for Neutron service. Defaults to 'neutron'. # (Optional) Username for Neutron service.
# Defaults to 'neutron'.
# #
# [*email*] # [*email*]
# Email for Neutron user. Defaults to 'neutron@localhost'. # (Optional) Email for Neutron user.
# Defaults to 'neutron@localhost'.
# #
# [*tenant*] # [*tenant*]
# Tenant for Neutron user. Defaults to 'services'. # (Optional) Tenant for Neutron user.
# Defaults to 'services'.
# #
# [*configure_endpoint*] # [*configure_endpoint*]
# Should Neutron endpoint be configured? Defaults to 'true'. # (Optional) Should Neutron endpoint be configured?
# Defaults to true.
# #
# [*configure_user*] # [*configure_user*]
# Should the Neutron service user be configured? Defaults to 'true'. # (Optional) Should the Neutron service user be configured?
# Defaults to true.
# #
# [*configure_user_role*] # [*configure_user_role*]
# 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_name*] # [*service_name*]
# Name of the service. Defaults 'neutron'. # (Optional) Name of the service.
# Defaults 'neutron'.
# #
# [*service_type*] # [*service_type*]
# Type of service. Defaults to 'network'. # (Optional) Type of service.
# Defaults to 'network'.
# #
# [*service_description*] # [*service_description*]
# Description for keystone service. # (Optional) Description for keystone service.
# (optional) Defaults to 'Neutron Networking Service'. # Defaults to 'Neutron Networking Service'.
# #
# [*region*] # [*region*]
# Region for endpoint. Defaults to 'RegionOne'. # (Optional) Region for endpoint.
# Defaults to 'RegionOne'.
# #
# [*public_url*] # [*public_url*]
# (optional) The endpoint's public url. (Defaults to 'http://127.0.0.1:9696') # (0ptional) 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:9696'
# #
# [*admin_url*] # [*admin_url*]
# (optional) The endpoint's admin url. (Defaults to 'http://127.0.0.1:9696') # (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:9696'
# #
# [*internal_url*] # [*internal_url*]
# (optional) The endpoint's internal url. (Defaults to 'http://127.0.0.1:9696') # (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:9696'
# #
# === Examples # === Examples
# #
@ -59,7 +70,6 @@
# admin_url => 'https://10.0.0.11:9696', # admin_url => 'https://10.0.0.11:9696',
# } # }
# #
#
class neutron::keystone::auth ( class neutron::keystone::auth (
$password, $password,
$auth_name = 'neutron', $auth_name = 'neutron',

View File

@ -5,36 +5,36 @@
# === Parameters: # === Parameters:
# #
# [*debug*] # [*debug*]
# (optional) Print debug messages in the logs # (Optional) Print debug messages in the logs
# 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_json*] # [*use_json*]
# (optional) Use json for logging # (Optional) Use json 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_stderr*] # [*use_stderr*]
# (optional) Use stderr for logging # (Optional) Use stderr for logging
# Defaults to $::os_service_default # Defaults to $::os_service_default
# #
# [*log_file*] # [*log_file*]
# (optional) Where to log # (Optional) Where to log
# 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/neutron # Defaults to /var/log/neutron
# #
# [*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
# #

View File

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