openstack
/
puppet-neutron
Code Issues Proposed changes

Cleanup documentation 

Make sure documentation is the same and follow
the standard which we are trying to enforce on
all modules.

Change-Id: I73b016ed23354e04a8cc0c1290b6d25a0de92cc0
This commit is contained in:
ZhongShengping 2018-12-13 17:10:02 +08:00 committed by Tobias Urdin
parent 61b26933f7
commit e7b61fe7de
4 changed files with 39 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
manifests/db/sync.pp
View File

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

44
manifests/keystone/auth.pp
View File

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

16
manifests/logging.pp
View File

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

4
manifests/policy.pp
View File

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