OpenStack Neutron Puppet Module
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Iury Gregory Melo Ferreira f374a0bf6e Remove verbose 6 years ago
examples Transform name to uuid. 6 years ago
lib/puppet Fix the neutron-port resource with binding options 6 years ago
manifests Remove verbose 6 years ago
releasenotes Remove verbose 6 years ago
spec dbsync: upgrade with 'heads' not 'head' 6 years ago
templates Remove use of template based config from cisco ml2 nexus plugin. 7 years ago
.gitignore Add basic structure for ReNo 7 years ago
.gitreview Update .gitreview file for project rename 7 years ago Release 8.0.0 6 years ago
Gemfile Gemfile: rely on puppet-openstack_spec_helper for dependencies 6 years ago
LICENSE Licensed under Apache\! 9 years ago Remove auth_host option 6 years ago
Rakefile Use puppet-openstack_spec_helper for Rakefile & spec_helper_acceptance 7 years ago
bindep.txt Move other-requirements.txt to bindep.txt 6 years ago
metadata.json Puppet OpenStack Newton RC2 6 years ago
setup.cfg Add basic structure for ReNo 7 years ago Add basic structure for ReNo 7 years ago
test-requirements.txt Add basic structure for ReNo 7 years ago
tox.ini Add basic structure for ReNo 7 years ago


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',
    debug           => false,

# configure authentication
class { 'neutron::server':
    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           => ['1: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/core_plugin' :
  value => openvswitch,

This will write core_plugin=openvswitch 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
  • Arista 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.