OpenStack Neutron Puppet Module
Go to file
Emilien Macchi 1140ae26e3 Use puppet-openstack_spec_helper for Rakefile & spec_helper_acceptance
Use common code in puppet-openstack_spec_helper in Rakefile and

Change-Id: Id95e433ef563cb2bc15e9cd2a0af85a0a2776a26
2016-01-18 09:11:27 -05:00
examples Invalid parameter keystone_password and connection neutron/examples/neutron.pp 2015-12-10 13:49:57 +08:00
lib/puppet Merge "Correctly parse csv even with extra output." 2016-01-18 13:34:21 +00:00
manifests Merge "LBaaSv2 support" 2016-01-15 11:21:22 +00:00
spec Use puppet-openstack_spec_helper for Rakefile & spec_helper_acceptance 2016-01-18 09:11:27 -05:00
templates Remove use of template based config from cisco ml2 nexus plugin. 2015-09-15 12:00:18 -04:00
.gitignore Try to use zuul-cloner to prepare fixtures 2015-10-08 15:08:52 -07:00
.gitreview Update .gitreview file for project rename 2015-06-12 23:12:30 +00:00 release: prepare 7.0.0 (liberty) 2015-11-25 16:39:50 +01:00
Gemfile Add rspec-puppet-facts to the spec_helper 2016-01-14 20:21:48 +03:00
LICENSE Licensed under Apache\! 2013-04-12 10:28:17 -07:00 update README to reflect new puppet-nova parameter 2016-01-15 16:38:07 +11:00
Rakefile Use puppet-openstack_spec_helper for Rakefile & spec_helper_acceptance 2016-01-18 09:11:27 -05:00
metadata.json release: prepare 7.0.0 (liberty) 2015-11-25 16:39:50 +01:00


7.0.0 - 2015.2.0 - Liberty

Table of Contents

  1. Overview - What is the neutron module?
  2. Module Description - What does the module do?
  3. Setup - Tha basics of getting started with neutron.
  4. Implementation - An under-the-hood peek at what the module is doing.
  5. Limitations - OS compatibility, etc.
  6. Development - Guide for contributing to the module
  7. Contributors - Those with commits


The neutron module is a part of OpenStack, an effort by the Openstack infrastructure team to provide continuous integration testing and code review for Openstack and Openstack community projects as part of the core software. The module itself is used to flexibly configure and manage the network 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.


What the neutron module affects:

  • Neutron, the network service for Openstack.

Installing neutron

puppet module install openstack/neutron

Beginning with neutron

To utilize the neutron module's functionality you will need to declare multiple resources. The following example displays the setting up of an Open vSwitch neutron installation. This is not an exhaustive list of all the components needed. We recommend that you consult and understand the core openstack documentation to assist you in understanding the available deployment options.

# enable the neutron service
class { '::neutron':
    enabled         => true,
    bind_host       => '',
    rabbit_host     => '',
    rabbit_user     => 'neutron',
    rabbit_password => 'rabbit_secret',
    verbose         => false,
    debug           => false,

# configure authentication
class { 'neutron::server':
    auth_host       => '', # the keystone host address
    auth_password   => 'keystone_neutron_secret',
    sql_connection  => 'mysql://neutron:neutron_sql_secret@',

# ml2 plugin with vxlan as ml2 driver and ovs as mechanism driver
class { '::neutron::plugins::ml2':
  type_drivers         => ['vxlan'],
  tenant_network_types => ['vxlan'],
  vxlan_group          => '',
  mechanism_drivers    => ['openvswitch'],
  vni_ranges           => ['0:300']

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_password  => 'neutron_admin_secret',

The examples directory also provides a quick tutorial on how to use this module.



neutron is a combination of Puppet manifest and ruby code to deliver configuration and extra functionality through types and providers.



The neutron_config provider is a children of the ini_setting provider. It allows one to write an entry in the /etc/neutron/neutron.conf file.

neutron_config { 'DEFAULT/verbose' :
  value => true,

This will write verbose=true in the [DEFAULT] section.


Section/setting name to manage from neutron.conf


The value of the setting to be defined.


Whether to hide the value from Puppet logs. Defaults to false.


If value is equal to ensure_absent_val then the resource will behave as if ensure => absent was specified. Defaults to <SERVICE DEFAULT>


This module supports the following neutron plugins:

  • Open vSwitch with ML2
  • linuxbridge with ML2
  • cisco-neutron with and without ML2
  • NVP
  • PLUMgrid

The following platforms are supported:

  • Ubuntu 12.04 (Precise)
  • Debian (Wheezy)
  • RHEL 6
  • Fedora 18


This module has beaker-rspec tests

To run:

bundle install
bundle exec rspec spec/acceptance


The puppet-openstack modules follow the Openstack development model. Developer documentation for the entire puppet-openstack project is at:


The github contributor graph.