Chef Cookbook - OpenStack Network
Go to file
Lance Albertson 75e073a7b0 CentOS 8 support
- Update various packages for EL8
- Use platform family for installing dnsmasq
- ChefSpec updates

Change-Id: Ia566d70348f1245733b5074b3ad6e0bb30c3e405
Signed-off-by: Lance Albertson <>
2021-10-22 16:33:19 -07:00
.delivery Stein fixes 2020-03-23 14:23:34 -07:00
attributes CentOS 8 support 2021-10-22 16:33:19 -07:00
files/default Stop iptables from being enabled by force 2018-06-25 06:17:04 -07:00
recipes CentOS 8 support 2021-10-22 16:33:19 -07:00
spec CentOS 8 support 2021-10-22 16:33:19 -07:00
templates/default Updates for Train 2020-05-29 17:18:15 -07:00
.gitignore Initial kilo updates 2015-02-27 13:52:42 -06:00
.gitreview OpenDev Migration Patch 2019-04-19 19:44:27 +00:00
.rubocop.yml Chef 17 support 2021-10-14 12:40:56 -07:00
.zuul.yaml Rename openstack-chef-repo references to openstack-chef 2018-08-06 21:50:02 -07:00
Berksfile Chef 17 support 2021-10-14 12:40:56 -07:00 Moving IRC network reference to OFTC 2021-07-15 10:51:39 -07:00
LICENSE network refactor for Pike and Chef 13 2018-01-09 15:14:37 +00:00
README.rst Chef 17 support 2021-10-14 12:40:56 -07:00
Rakefile Updates for rocky 2019-12-06 11:27:39 -08:00 Sync stackforge/cookbook* to openstack/cookbook* for neutron cookbook 2015-06-15 15:29:37 +08:00
metadata.rb Chef 17 support 2021-10-14 12:40:56 -07:00


OpenStack Chef Cookbook - network



This cookbook installs the OpenStack Network service Neutron as part of a Chef reference deployment of OpenStack. The OpenStack chef-repo contains documentation for using this cookbook in the context of a full OpenStack deployment. Neutron is currently installed from packages.


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


  • Chef 16 or higher
  • Chef Workstation 21.10.640 for testing (also includes Berkshelf for cookbook dependency resolution)


  • ubuntu
  • redhat
  • centos


The following cookbooks are dependencies:

  • 'openstackclient'
  • 'openstack-common', '>= 20.0.0'
  • 'openstack-identity', '>= 20.0.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.



  • Example bridge recipe used in kitchen tests


  • 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



  • 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 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)

License and Author

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

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.