Chef Cookbook - OpenStack Network
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.
Zuul e4abfa8d61 Merge "Drop admin endpoints" 3 weeks ago
.delivery Add delivery config 1 year ago
attributes Drop admin endpoints 1 month ago
files/default Stop iptables from being enabled by force 11 months ago
recipes Drop admin endpoints 1 month ago
spec Drop admin endpoints 1 month ago
templates/default Allow overriding replies for specific domain names via dnsmasq.conf 1 month ago
.gitignore Initial kilo updates 4 years ago
.gitreview OpenDev Migration Patch 1 month ago
.rubocop.yml starting rocky development patch 9 months ago
.rubocop_todo.yml starting rocky development patch 9 months ago
.zuul.yaml Rename openstack-chef-repo references to openstack-chef 9 months ago
Berksfile starting rocky development patch 9 months ago Workflow documentation is now in infra-manual 4 years ago
LICENSE network refactor for Pike and Chef 13 1 year ago remove unmaintained vpnaas from all recipes and attributes 7 months ago
Rakefile network refactor for Pike and Chef 13 1 year ago Sync stackforge/cookbook* to openstack/cookbook* for neutron cookbook 4 years ago Fix 3 years ago
metadata.rb Change openstack-dev to openstack-discuss 5 months ago

Team and repository tags

Team and repository tags

Chef OpenStack Logo


This cookbook installs the OpenStack Network service Neutron as part of a Chef reference deployment of OpenStack. The contains documentation for using this cookbook in the context of a full OpenStack deployment.

More information about the OpenStack Network service is available here


OpenStack Network’s design is modular, with plugins available that handle L2 and L3 networking for various hardware vendors and standards.


  • Chef 12 or higher
  • chefdk 0.9.0 or higher for testing (also includes berkshelf for cookbook dependency resolution)


  • ubuntu
  • redhat
  • centos


The following cookbooks are dependencies:

  • ‘openstack-common’, ‘>= 14.0.0’
  • ‘openstack-identity’, ‘>= 14.0.0’
  • ‘openstackclient’, ‘>= 0.1.0’


Please see the extensive inline documentation in attributes/*.rb for descriptions of all the settable attributes for this cookbook.

Note that all attributes are in the default['openstack'] “namespace”

The usage of attributes to generate the neutron.conf is described in the openstack-common cookbook.



  • Install the network client packages


  • Migrates the neutron database


  • Configures common pieces needed for all neutron services and create the neutron.conf


  • Installs the DHCP agent

The configuration for neutron-dhcp-agent is generated from the attributes in using the same template as for the neutron.conf



This is a ‘work in progress’ recipe and is currently not tested

  • Installs the Firewall as a Service


  • Registers the OpenStack Network API endpoint and service user with Keystone


  • Installs the L3 agent

The configuration for neutron-l3-agent is generated from the attributes in using the same template as for the neutron.conf



  • Installs the Loadbalancer as a Service

The configuration for neutron-lbaas-agent is generated from the attributes in using the same template as for the neutron.conf



  • Installs the metadata agent

The configuration for neutron-metadata-agent is generated from the attributes in using the same template as for the neutron.conf



  • Installs the metering agent

The configuration for neutron-metadata-agent is generated from the attributes in using the same template as for the neutron.conf



  • Configure the ml2_core_plugin


  • Configure the ml2 linuxbridge plugin


  • Configure the ml2 openvswitch plugin


  • Installs openvswitch


  • Installs the openvswitch agent


  • Generates all the needed plugin configurations directly from the attributes in:

The final configuration file is generated exactly like all OpenStack service configuration files (e.g. neutron.conf), but the attribute mentioned above allows you additionally to define the file name and patch with:

# this will also generate the path recursively if not already existent
# this defines the filename for the plugin config (e.g. ml2_conf.ini)

In the examples above, the variable ‘myplugin’ can be used to generate multiple plugin configurations with different configs and filenames. Please refer to the recipe openstack-network::ml2_openvswitch for an full example on the usage of this attributes.


  • Installs the openstack-network API server (currently aka neutron-server)


This recipe has been removed since it was unmaintained since the pike release and the vpnaas module got completely removed/refactored during the queens release. For rocky there seems to be some kind of vpnaas implementation directly in the l3 agent (, but since the documentation about it is quite sparse right now, there is no recipe for that. If you want to add vpnaas back to this cookbook, please feel free to push a pull request.

License and Author

Authors Alan Meadows (
Jay Pipes (
Ionut Artarisi (
Salman Baset (
Jian Hua Geng (
Chen Zhiwei (
Mark Vanderwiel(
Eric Zhou(
Jan Klare (
Christoph Albers (
Copyright Copyright © 2013, AT&T Services, Inc.
Copyright © 2013-2014, SUSE Linux GmbH
Copyright © 2012, Rackspace US, Inc.
Copyright © 2013-2014, IBM Corp.
Copyright © 2016, cloudbau GmbH

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.