Merge "lint: Add and fix missing parameter documentation"
This commit is contained in:
commit
c13ed0c97b
@ -65,6 +65,10 @@
|
||||
# This option requires enable_isolated_metadata = True
|
||||
# Defaults to false.
|
||||
#
|
||||
# [*dhcp_broadcast_reply*]
|
||||
# (optional) Use broadcast in DHCP replies
|
||||
# Defaults to false.
|
||||
#
|
||||
class neutron::agents::dhcp (
|
||||
$package_ensure = present,
|
||||
$enabled = true,
|
||||
|
@ -38,7 +38,7 @@
|
||||
# bridge mapping.
|
||||
# Defaults to empty list
|
||||
#
|
||||
# [*bridge_mapping*]
|
||||
# [*bridge_mappings*]
|
||||
# (optional) List of <physical_network>:<bridge>
|
||||
# Defaults to empty list
|
||||
#
|
||||
|
@ -13,7 +13,7 @@
|
||||
# (required) N1KV VSM(Virtual Supervisor Module) VM's IP.
|
||||
# Defaults to ::1
|
||||
#
|
||||
# [*n1kv_vsm_domainid*]
|
||||
# [*n1kv_vsm_domain_id*]
|
||||
# (required) N1KV VSM DomainID.
|
||||
# Defaults to 1000
|
||||
#
|
||||
|
@ -37,7 +37,7 @@
|
||||
# [*interface_driver*]
|
||||
# (optional) Defaults to 'neutron.agent.linux.interface.OVSInterfaceDriver'.
|
||||
#
|
||||
# [*external_network_bridge]
|
||||
# [*external_network_bridge*]
|
||||
# (optional) Defaults to undef
|
||||
#
|
||||
# [*ipsec_status_check_interval*]
|
||||
|
@ -21,51 +21,57 @@
|
||||
# DEFAULT/bar:
|
||||
# value: barValue
|
||||
#
|
||||
# [**server_config**]
|
||||
# [*server_config*]
|
||||
# (optional) Manage configuration of neutron.conf
|
||||
#
|
||||
# [**api_config**]
|
||||
# [*api_config*]
|
||||
# (optional) Manage configuration of api-paste.ini
|
||||
#
|
||||
# [**l3_agent_config**]
|
||||
# [*l3_agent_config*]
|
||||
# (optional) Manage configuration of l3_agent.ini
|
||||
#
|
||||
# [**dhcp_agent_config**]
|
||||
# [*dhcp_agent_config*]
|
||||
# (optional) Manage configuration of dhcp_agent.ini
|
||||
#
|
||||
# [**lbaas_agent_config**]
|
||||
# [*lbaas_agent_config*]
|
||||
# (optional) Manage configuration of lbaas_agent.ini
|
||||
#
|
||||
# [**metadata_agent_config**]
|
||||
# [*metadata_agent_config*]
|
||||
# (optional) Manage configuration of metadata_agent.ini
|
||||
#
|
||||
# [**metering_agent_config**]
|
||||
# [*metering_agent_config*]
|
||||
# (optional) Manage configuration of metering_agent.ini
|
||||
#
|
||||
# [**vpnaas_agent_config**]
|
||||
# [*vpnaas_agent_config*]
|
||||
# (optional) Manage configuration of vpn_agent.ini
|
||||
#
|
||||
# [**plugin_linuxbridge_config**]
|
||||
# [*plugin_linuxbridge_config*]
|
||||
# (optional) Manage configuration of linuxbridge_conf.ini
|
||||
#
|
||||
# [**plugin_cisco_db_conn_config**]
|
||||
# [*plugin_cisco_db_conn_config*]
|
||||
# (optional) Manage configuration of plugins/cisco/db_conn.ini
|
||||
#
|
||||
# [**plugin_cisco_config**]
|
||||
# [*plugin_cisco_l2network_config*]
|
||||
# (optional) Manage configuration of plugins/cisco/l2network_plugin.ini
|
||||
#
|
||||
# [*plugin_cisco_config*]
|
||||
# (optional) Manage configuration of cisco_plugins.ini
|
||||
#
|
||||
# [**plugin_midonet_config**]
|
||||
# [*plugin_midonet_config*]
|
||||
# (optional) Manage configuration of plugins/midonet/midonet.ini
|
||||
#
|
||||
# [**plugin_plumgrid_config**]
|
||||
# [*plugin_plumgrid_config*]
|
||||
# (optional) Manage configuration of plugins/plumgrid/plumgrid.ini
|
||||
#
|
||||
# [**plugin_opencontrail_config**]
|
||||
# [*plugin_opencontrail_config*]
|
||||
# (optional) Manage configuration of plugins/opencontrail/ContrailPlugin.ini
|
||||
#
|
||||
# [**plugin_ml2_config**]
|
||||
# [*plugin_ml2_config*]
|
||||
# (optional) Manage configuration of ml2_conf.ini
|
||||
#
|
||||
# [*plugin_ovs_config*]
|
||||
# (optional) Manage configuration of ovs_neutron_plugin.ini
|
||||
#
|
||||
# NOTE: The configuration MUST NOT be already handled by this module
|
||||
# or Puppet catalog compilation will fail with duplicate resources.
|
||||
#
|
||||
|
@ -29,6 +29,8 @@
|
||||
# [*mysql_module*]
|
||||
# (optional) Deprecated. Does nothing.
|
||||
#
|
||||
# [*cluster_id*]
|
||||
# (optional) Deprecated. Does nothing.
|
||||
class neutron::db::mysql (
|
||||
$password,
|
||||
$dbname = 'neutron',
|
||||
@ -37,8 +39,9 @@ class neutron::db::mysql (
|
||||
$allowed_hosts = undef,
|
||||
$charset = 'utf8',
|
||||
$collate = 'utf8_general_ci',
|
||||
$cluster_id = 'localzone',
|
||||
# DEPRECATED
|
||||
$mysql_module = undef,
|
||||
$cluster_id = 'localzone',
|
||||
) {
|
||||
|
||||
if $mysql_module {
|
||||
|
@ -100,6 +100,12 @@
|
||||
# module in use needs to load.
|
||||
# Defaults to undef
|
||||
#
|
||||
# [*root_helper*]
|
||||
# (optional) Use "sudo neutron-rootwrap /etc/neutron/rootwrap.conf" to use the real
|
||||
# root filter facility. Change to "sudo" to skip the filtering and just run the command
|
||||
# directly
|
||||
# Defaults to 'sudo neutron-rootwrap /etc/neutron/rootwrap.conf'.
|
||||
#
|
||||
# [*report_interval*]
|
||||
# (optional) Seconds between nodes reporting state to server; should be less than
|
||||
# agent_down_time, best if it is half or less than agent_down_time.
|
||||
@ -107,7 +113,7 @@
|
||||
# report_interval is a config for neutron agents, set by class neutron
|
||||
# Defaults to: 30
|
||||
#
|
||||
# [memcache_servers]
|
||||
# [*memcache_servers*]
|
||||
# List of memcache servers in format of server:port.
|
||||
# Optional. Defaults to false. Example: ['localhost:11211']
|
||||
#
|
||||
@ -125,6 +131,10 @@
|
||||
# [*rabbit_user*]
|
||||
# (optional) Various rabbitmq settings
|
||||
#
|
||||
# [*rabbit_virtual_host*]
|
||||
# (optional) virtualhost to use.
|
||||
# Defaults to '/'
|
||||
#
|
||||
# [*rabbit_hosts*]
|
||||
# (optional) array of rabbitmq servers for HA.
|
||||
# A single IP address, such as a VIP, can be used for load-balancing
|
||||
|
@ -45,6 +45,42 @@
|
||||
# Defaults to undef. This will not set a nexus plugin to use
|
||||
# Can be set to neutron.plugins.cisco.nexus.cisco_nexus_plugin_v2.NexusPlugin
|
||||
#
|
||||
# [*vlan_start*]
|
||||
# (optional) First VLAN for private networks.
|
||||
# Defaults to '100'.
|
||||
#
|
||||
# [*vlan_end*]
|
||||
# (optional) Last VLAN for private networks.
|
||||
# Defaults to '3000'.
|
||||
#
|
||||
# [*vlan_name_prefix*]
|
||||
# (optional) VLAN Name prefix
|
||||
# Defaults to 'q-'
|
||||
#
|
||||
# [*model_class*]
|
||||
# (optional) Model Class
|
||||
# Defaults to 'neutron.plugins.cisco.models.virt_phy_sw_v2.VirtualPhysicalSwitchModelV2'
|
||||
#
|
||||
# [*max_ports*]
|
||||
# (optional) Number max of ports
|
||||
# Defaults to '100'
|
||||
#
|
||||
# [*max_port_profiles*]
|
||||
# (optional) Number max of port profiles
|
||||
# Defaults to '65568'
|
||||
#
|
||||
# [*manager_class*]
|
||||
# (optional) Manager Class
|
||||
# Defaults to 'neutron.plugins.cisco.segmentation.l2network_vlan_mgr_v2.L2NetworkVLANMgr'
|
||||
#
|
||||
# [*max_networks*]
|
||||
# (optional)
|
||||
# Defaults to '65568'
|
||||
#
|
||||
# [*package_ensure*]
|
||||
# (optional) the ensure state of the package resource
|
||||
# Defaults to 'present'
|
||||
#
|
||||
# Other parameters are currently not used by the plugin and
|
||||
# can be left unchanged, but in grizzly the plugin will fail
|
||||
# to launch if they are not there. The config for Havana will
|
||||
|
@ -88,6 +88,10 @@
|
||||
# It should be false when you use nova security group.
|
||||
# Defaults to true.
|
||||
#
|
||||
# [*package_ensure*]
|
||||
# (optional) Ensure state for package.
|
||||
# Defaults to 'present'.
|
||||
#
|
||||
# [*supported_pci_vendor_devs*]
|
||||
# (optional) Supported PCI vendor devices, defined by
|
||||
# vendor_id:product_id according to the PCI ID
|
||||
|
@ -1,9 +1,10 @@
|
||||
# == Class: neutron::plugins::ml2::cisco::nexus
|
||||
#
|
||||
# Configure the Mech Driver for cisco neutron plugin
|
||||
# More info available here:
|
||||
# https://wiki.openstack.org/wiki/Neutron/ML2/MechCiscoNexus
|
||||
#
|
||||
# === Parameters
|
||||
# === Parameters:
|
||||
#
|
||||
# [*nexus_config*]
|
||||
# (required) Nexus switch configuration for ml2_cisco_conf.ini
|
||||
@ -93,7 +94,6 @@
|
||||
# when connecting to Nexus switches.
|
||||
# Defaults to false
|
||||
#
|
||||
|
||||
class neutron::plugins::ml2::cisco::nexus (
|
||||
$nexus_config,
|
||||
$managed_physical_network,
|
||||
@ -135,4 +135,3 @@ class neutron::plugins::ml2::cisco::nexus (
|
||||
create_resources(neutron::plugins::ml2::cisco::nexus_creds, $nexus_config)
|
||||
|
||||
}
|
||||
|
||||
|
@ -1,3 +1,4 @@
|
||||
# == Define: neutron::plugins::ml2::cisco::nexus_creds
|
||||
#
|
||||
# Defined type to configure the Cisco Nexus Switch Credentials
|
||||
# for use by the ML2 Mech Driver for Cisco Nexus Switches.
|
||||
@ -9,16 +10,16 @@
|
||||
# neutron::plugins::ml2::cisco::nexus_creds used by
|
||||
# neutron::plugins::ml2::cisco::nexus
|
||||
#
|
||||
# === Parameters
|
||||
# === Parameters:
|
||||
#
|
||||
# [*username*]
|
||||
# (required) The username for logging into the switch to manage it.
|
||||
# (not used) The username for logging into the switch to manage it.
|
||||
#
|
||||
# [*password*]
|
||||
# (required) The password for logging into the switch to manage it.
|
||||
# (not used) The password for logging into the switch to manage it.
|
||||
#
|
||||
# [*servers*]
|
||||
# (required) A hash of server names (key) mapped to the switch's
|
||||
# (not used) A hash of server names (key) mapped to the switch's
|
||||
# interfaces (value). For each host connected to a port on the
|
||||
# switch, specify the hostname and the Nexus physical port/s
|
||||
# (interface/s) it is connected to. The values in the hash can
|
||||
@ -47,10 +48,10 @@
|
||||
# (required) The IP address of the switch.
|
||||
#
|
||||
# [*ssh_port*]
|
||||
# (required) The SSH port to use when connecting to the switch.
|
||||
# (not used) The SSH port to use when connecting to the switch.
|
||||
#
|
||||
# [*nve_src_intf*]
|
||||
# (optional) Only valid if VXLAN overlay is configured and
|
||||
# (not used) Only valid if VXLAN overlay is configured and
|
||||
# vxlan_global_config is set to True.
|
||||
#
|
||||
# The NVE source interface is a loopback interface that is configured on
|
||||
@ -63,7 +64,7 @@
|
||||
# Defaults to undef.
|
||||
#
|
||||
# [*physnet*]
|
||||
# (optional) Only valid if VXLAN overlay is configured.
|
||||
# (not used) Only valid if VXLAN overlay is configured.
|
||||
# The physical network name defined in the network_vlan_ranges variable
|
||||
# (defined under the ml2_type_vlan section) that this switch is controlling.
|
||||
# The configured 'physnet' is the physical network domain that is connected
|
||||
@ -72,15 +73,18 @@
|
||||
# network. These dynamic vlans may be reused across physical networks.
|
||||
#
|
||||
# Defaults to undef.
|
||||
|
||||
#
|
||||
define neutron::plugins::ml2::cisco::nexus_creds(
|
||||
# Not used parameters
|
||||
$username,
|
||||
$password,
|
||||
$servers,
|
||||
$ip_address,
|
||||
$ssh_port,
|
||||
# Used parameters
|
||||
$ip_address,
|
||||
$nve_src_intf = undef,
|
||||
$physnet = undef,
|
||||
|
||||
) {
|
||||
# Ensure Neutron server is installed before configuring ssh keys
|
||||
if ($::neutron::params::server_package) {
|
||||
|
@ -17,7 +17,15 @@
|
||||
#
|
||||
# neutron::plugins::ml2::mech_driver used by neutron::plugins::ml2
|
||||
#
|
||||
|
||||
# === Parameters:
|
||||
#
|
||||
# [*supported_pci_vendor_devs*]
|
||||
# (required) Supported PCI vendor devices, defined by vendor_id:product_id according
|
||||
# to the PCI ID Repository. Default enables support for Intel and Mellanox SR-IOV capable NICs
|
||||
#
|
||||
# [*sriov_agent_required*]
|
||||
# (required) SRIOV neutron agent is required for port binding
|
||||
#
|
||||
define neutron::plugins::ml2::mech_driver (
|
||||
$supported_pci_vendor_devs,
|
||||
$sriov_agent_required,
|
||||
|
@ -17,7 +17,28 @@
|
||||
#
|
||||
# neutron::plugins::ml2::type_driver used by neutron::plugins::ml2
|
||||
#
|
||||
|
||||
# === Parameters:
|
||||
#
|
||||
# [*flat_networks*]
|
||||
# (required) List of physical_network names with which flat networks can be created.
|
||||
# Use * to allow flat networks with arbitrary physical_network names.
|
||||
#
|
||||
# [*tunnel_id_ranges*]
|
||||
# (required) Comma-separated list of <tun_min>:<tun_max> tuples enumerating ranges
|
||||
# of GRE tunnel IDs that are available for tenant network allocation
|
||||
#
|
||||
# [*network_vlan_ranges*]
|
||||
# (required) List of <physical_network>:<vlan_min>:<vlan_max> or <physical_network>
|
||||
# specifying physical_network names usable for VLAN provider and tenant networks, as
|
||||
# well as ranges of VLAN tags on each available for allocation to tenant networks.
|
||||
#
|
||||
# [*vni_ranges*]
|
||||
# (required) Comma-separated list of <vni_min> tuples enumerating ranges of VXLAN VNI IDs
|
||||
# that are available for tenant network allocation.
|
||||
#
|
||||
# [*vxlan_group*]
|
||||
# (required) Multicast group for VXLAN. If unset, disables VXLAN multicast mode.
|
||||
#
|
||||
define neutron::plugins::ml2::type_driver (
|
||||
$flat_networks,
|
||||
$tunnel_id_ranges,
|
||||
|
@ -21,6 +21,10 @@
|
||||
# To be specified if planning to use logical routers with external gateways.
|
||||
# Defaults to None.
|
||||
#
|
||||
# [*package_ensure*]
|
||||
# (optional) Ensure state for package.
|
||||
# Defaults to 'present'.
|
||||
#
|
||||
class neutron::plugins::nvp (
|
||||
$default_tz_uuid,
|
||||
$nvp_controllers,
|
||||
|
@ -43,6 +43,10 @@
|
||||
# Admin token
|
||||
# Defaults to undef
|
||||
#
|
||||
# [*package_ensure*]
|
||||
# (optional) Ensure state for package.
|
||||
# Defaults to 'present'.
|
||||
#
|
||||
class neutron::plugins::opencontrail (
|
||||
$api_server_ip = undef,
|
||||
$api_server_port = undef,
|
||||
|
@ -5,36 +5,51 @@
|
||||
# [*director_server*]
|
||||
# IP address of the PLUMgrid Director Server
|
||||
# Defaults to 127.0.0.1
|
||||
#
|
||||
# [*director_server_port*]
|
||||
# Port of the PLUMgrid Director Server.
|
||||
# Defaults to 443
|
||||
#
|
||||
# [*username*]
|
||||
# PLUMgrid platform username
|
||||
#
|
||||
# [*password*]
|
||||
# PLUMgrid platform password
|
||||
#
|
||||
# [*servertimeout*]
|
||||
# Request timeout duration (seconds) to PLUMgrid paltform
|
||||
# Defaults to 99
|
||||
#
|
||||
# [*connection*]
|
||||
# Database connection
|
||||
# Defaults to http://127.0.0.1:35357/v2.0
|
||||
#
|
||||
# [*admin_password*]
|
||||
# Keystone admin password
|
||||
#
|
||||
# [*controller_priv_host*]
|
||||
# Controller private host IP
|
||||
# Defaults to 127.0.0.1
|
||||
#
|
||||
# [*auth_protocol*]
|
||||
# Authorization protocol
|
||||
# Defaults to http
|
||||
#
|
||||
# [*nova_metadata_ip*]
|
||||
# Nova metadata IP
|
||||
# Defaults to 127.0.0.1
|
||||
#
|
||||
# [*nova_metadata_port*]
|
||||
# Nova metadata port
|
||||
# Defaults to 8775
|
||||
#
|
||||
# [*metadata_proxy_shared_secret*]
|
||||
# Neutron metadata shared secret key
|
||||
|
||||
#
|
||||
# [*package_ensure*]
|
||||
# (optional) Ensure state for package.
|
||||
# Defaults to 'present'.
|
||||
#
|
||||
class neutron::plugins::plumgrid (
|
||||
$director_server = '127.0.0.1',
|
||||
$director_server_port = '443',
|
||||
|
@ -195,6 +195,10 @@
|
||||
# (optional) CIDR of the administrative network if HA mode is enabled.
|
||||
# Defaults to '169.254.192.0/18'
|
||||
#
|
||||
# [*report_interval*]
|
||||
# (optional) Deprecated, does nothing.
|
||||
# Defaults to 'undef'.
|
||||
#
|
||||
class neutron::server (
|
||||
$package_ensure = 'present',
|
||||
$enabled = true,
|
||||
|
Loading…
Reference in New Issue
Block a user