Version information
released Oct 2nd 2015
This version is compatible with:
- Puppet Enterprise 3.x
- Puppet 3.x
- , , ,
Start using this module
Add this module to your Puppetfile:
mod 'stackforge-neutron', '5.2.0'Learn more about managing modules with a PuppetfileDocumentation
stackforge/neutron — version 5.2.0 Oct 2nd 2015
neutron
5.2.0 - 2014.2 - Juno
Table of Contents
- Overview - What is the neutron module?
- Module Description - What does the module do?
- Setup - Tha basics of getting started with neutron.
- Implementation - An under-the-hood peek at what the module is doing.
- Limitations - OS compatibility, etc.
- Development - Guide for contributing to the module
- Contributors - Those with commits
- Release Notes - Notes on the most recent updates to the module
Overview
The neutron module is a part of Stackforge, an effort by the Openstack infrastructure team to provide continuous integration testing and code review for Openstack and Openstack community projects not part of the core software. The module itself is used to flexibly configure and manage the newtork service for Openstack.
Module Description
The neutron module is an attempt to make Puppet capable of managing the entirety of neutron. This includes manifests to provision such things as keystone endpoints, RPC configurations specific to neutron, database connections, and network driver plugins. Types are shipped as part of the neutron module to assist in manipulation of the Openstack configuration files.
This module is tested in combination with other modules needed to build and leverage an entire Openstack installation. These modules can be found, all pulled together in the openstack module.
Setup
What the neutron module affects:
- Neutron, the network service for Openstack.
Installing neutron
puppet module install puppetlabs/neutron
Beginning with neutron
To utilize the neutron module's functionality you will need to declare multiple resources. The following is a modified excerpt from the openstack module. It provides an example of setting up an Open vSwitch neutron installation. This is not an exhaustive list of all the components needed. We recommend that you consult and understand the openstack module and the core openstack documentation to assist you in understanding the available deployment options.
# enable the neutron service
class { '::neutron':
enabled => true,
bind_host => '127.0.0.1',
rabbit_host => '127.0.0.1',
rabbit_user => 'neutron',
rabbit_password => 'rabbit_secret',
verbose => false,
debug => false,
}
# configure authentication
class { 'neutron::server':
auth_host => '127.0.0.1', # the keystone host address
auth_password => 'keystone_neutron_secret',
sql_connection => 'mysql://neutron:neutron_sql_secret@127.0.0.1/neutron?charset=utf8',
}
# enable the Open VSwitch plugin server
class { 'neutron::plugins::ovs':
tenant_network_type => 'gre',
network_vlan_ranges => 'physnet:1000:2000',
}
Other neutron network drivers include:
- dhcp,
- metadata,
- and l3.
Nova will also need to be configured to connect to the neutron service. Setting up the nova::network::neutron class sets
the network_api_class parameter in nova to use neutron instead of nova-network.
class { 'nova::network::neutron':
neutron_admin_password => 'neutron_admin_secret',
}
The examples directory also provides a quick tutorial on how to use this module.
Implementation
neutron
neutron is a combination of Puppet manifest and ruby code to deliver configuration and extra functionality through types and providers.
Limitations
This module supports the following neutron plugins:
- Open vSwitch
- linuxbridge
- cisco-neutron
The following platforms are supported:
- Ubuntu 12.04 (Precise)
- Debian (Wheezy)
- RHEL 6
- Fedora 18
Development
The puppet-openstack modules follow the Openstack development model. Developer documentation for the entire puppet-openstack project is at:
Contributors
The github contributor graph.
Release Notes
5.2.0
- Add an ability to manage use_stderr parameter
- Create file /etc/default/neutron-server
- ml2: Fix typo with ml2_srvio/supported_pci_vendor_devs param
- Opencontrail: Create neutron::plugins::opencontrail
5.1.0
- Fix l3_ha enablement
- spec: pin rspec-puppet to 1.0.1
- Switch to TLSv1
- Support SR-IOV mechanism driver in ML2
- Implement better nova_admin_tenant_id_setter exists? method
- OVS Agent with ML2: fix symlink on RH plateforms
- Adding portdb and fastpath_flood to n1kv.conf
- Make cisco plugin symlink coherent
- Fix status messages checks for neutron provider
- Make neutron_plugin_ml2 before db-sync
- Pin puppetlabs-concat to 1.2.1 in fixtures
- change default MySQL collate to utf8_general_ci
- Fix neutron file_line dependency
- Corrects "ip link set" command
- Adding vxlan network type support for neutron ML2 plug-in
- Raise puppet error, if nova-api unavailable
- Do not run neutron-ovs-cleanup for each Puppet run
- Unescape value in parse_allocation_pool
- Fix neutron_network for --router:external setting
- Add MidoNet plugin support
- Allow l3_ha to be turned back off after it has been enabled
- Update .gitreview file for project rename
- Fix support for auth_uri setting in neutron provider
- Reduce neutron API timeout to 10 seconds
5.0.0
- Stable Juno release
- Added neutron::policy to control policy.json
- Added parameter allow_automatic_l3agent_failover to neutron::agents::l3
- Added parameter metadata_memory_cache_ttl to neutron::agents::metadata
- Added l3_ext as a provider_network_type property for neutron_network type
- Changed user_group parameter in neutron::agents::lbaas to have different defaults depending on operating system
- Changed openswan package to libreswan for RHEL 7 for vpnaas
- Ensured neutron package was installed before nova_admin_tenant_id_setter is called
- Added api_extensions_path parameter to neutron class
- Added database tuning parameters
- Changed management of file lines in /etc/default/neutron-server only for Ubuntu
- Add parameters to enable DVR and HA support in neutron::agents::l3 for Juno
- Fixed meaning of manage_service parameter in neutron::agents::ovs
- Made keystone user creation optional when creating a service
- Fixed the enable_dhcp property of neutron_subnet
- Added the ability to override the keystone service name in neutron::keystone::auth
- Fixed bug in parsing allocation pools in neutron_subnet type
- Added relationship to refresh neutron-server when nova_admin_tenant_id_setter changes
- Migrated the neutron::db::mysql class to use openstacklib::db::mysql and deprecated the mysql_module parameter
- Fixed the relationship between the HA proxy package and the neutron-lbaas-agent package
- Added kombu_reconnect_delay parameter to neutron class
- Fixed plugin.ini error when cisco class is used
- Fixed relationship between vs_pridge types and the neutron-plugin-ovs service
- Added neutron::agents::n1kv_vem to deploy N1KV VEM
- Added SSL support for nova_admin_tenant_id_setter
- Fixed relationship between neutron-server package and neutron_plugin_ml2 types
- Stopped puppet from trying to manage the ovs cleanup service
- Deprecated the network_device_mtu parameter in neutron::agents::l3 and moved it to the neutron class
- Added vpnaas_agent_package parameter to neutron::services::fwaas to install the vpnaas agent package
4.3.0
- Added parameter to specify number of RPC workers to spawn
- Added ability to manage Neutron ML2 plugin
- Fixed ssl parameter requirements when using kombu and rabbit
- Added ability to hide secret neutron configs from logs and fixed password leaking
- Added neutron plugin config file specification in neutron-server config
- Fixed installation of ML2 plugin on Ubuntu
- Added support for Cisco ML2 Mech Driver
- Fixed quotas parameters in neutron config
- Added parameter to configure dhcp_agent_notification in neutron config
- Added class for linuxbridge support
- Fixed neutron-server restart
- Undeprecated enable_security_group parameter
4.2.0
- Added ml2/ovs support.
- Added multi-region support.
- Set default metadata backlog to 4096.
- Fixed neutron-server refresh bug.
4.1.0
- Added parameter to set veth MTU.
- Added RabbitMQ SSL support.
- Added support for '' as a valid value for gateway_ip.
- Fixed potential OVS resource duplication.
- Pinned major gems.
4.0.0
- Stable Icehouse release.
- Added Neutron-Nova interactions support.
- Added external network bridge and interface driver for vpn agent.
- Added support for puppetlabs-mysql 2.2 and greater.
- Added neutron::config to handle additional custom options.
- Added https support to metadata agent.
- Added manage_service paraneter.
- Added quota parameters.
- Added support to configure ovs without installing package.
- Added support for optional haproxy package management.
- Added support to configure plugins by name rather than class name.
- Added multi-worker support.
- Added isolated network support.
- Updated security group option for ml2 plugin.
- Updated packaging changes for Red Hat and Ubuntu systems.
- Updated parameter defaults to track upstream (Icehouse).
- Fixed bug for subnets with empty values.
- Fixed typos and misconfiguration in neutron.conf.
- Fixed max_retries parameter warning.
- Fixed database creation bugs.
3.3.0
- Added neutron_port resource.
- Added external network bridge for vpn agent.
- Changed dhcp_lease_duration to Havana default of 86400
- Fixed VPNaaS installation for Red Hat systems.
- Fixed conflicting symlink.
- Fixed network_vlan_ranges parameter for OVS plugin
3.2.0
- Added write support for dns, allocation pools, and host routes to Neutron router provider.
- Fixed multi-line attribute detection in base Neutron provider.
- Fixed bugs with neutron router gateway id parsing.
3.1.0
- Added VXLAN support.
- Configures security group when using ML2 plugin.
- Ensures installation of ML2 plugin.
- Fixed server deprecated warnings.
- Tuned report and downtime intervals for l2 agent.
- Added support for neutron nvp plugin.
- Ensures linuxbridge dependency is installed on RHEL.
- Improved L3 scheduler support.
- Fixed improper test for tunnel_types param.
- Allows log_dir to be set to false in order to disable file logging.
- Improves consistency with other puppet modules for OpenStack by prefixing database related parameters with database.
- Removed strict checks for vlan_ranges.
- Fixed neutron-metering-agent package for Ubuntu.
- Fixed VPNaaS service name for Ubuntu.
- Fixed FWaaS race condition.
- Fixed ML2 package dependency for Ubuntu.
- Removed erronious check for service_plugins.
- Added support for https auth endpoints.
- Makes haproxy package management optional.
3.0.0
- Major release for OpenStack Havana.
- Renamed project from quantum to neutron.
- Changed the default quota_driver.
- Removed provider setting requirement.
- Fixed file permissions.
- Fixed bug to ensure that keystone endpoint is set before service starts.
- Added database configuration support for Havana.
- Ensured dnsmasq package resource for compatibility with modules that define the same resource
- Added multi-worker support.
- Added metering agent support.
- Added vpnaas agent support.
- Added ml2 plugin support.
- Fixed lbass driver name.
2.2.0
- Improved documentation.
- Added syslog support.
- Added quantum-plugin-cisco package resource.
- Various lint and bug fixes.
Types in this module release
Dependencies
- puppetlabs/inifile (>=1.0.0 <2.0.0)
- stackforge/keystone (>=5.0.0 <6.0.0)
- stackforge/nova (>=5.0.0 <6.0.0)
- puppetlabs/stdlib (>=4.0.0 <5.0.0)
- stackforge/vswitch (>=1.0.0 <2.0.0)
- duritong/sysctl (>=0.0.1 <1.0.0)
- stackforge/openstacklib (>=5.0.0 <6.0.0)
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.