OpenStack Neutron Puppet Module
Go to file
ZhongShengping 15dbf87bbe Dissuade .gitignore references to personal tools
Developers run all sorts of different tools within Git repositories,
any of which can leave their own special trashfiles all over the
place. We can't every hope to catalog them all, so better to
recommend developers simply configure a global core.excludesfile to
filter the irrelevant files which tend to get created by their
personal choice of tools. Add a comment block explaining this, for
clarity, and remove the one current editor-specific entry present.

We can, and should of course, continue to list files created by the
tools recommended by our workflow (test frameworks, documentation
and packaging builds, et cetera).

This change is a port of Ib58a57267b064e4142686de6c37a70dbff04b9a7
from the openstack-dev/cookiecutter repository.

Change-Id: I03b1e3f0891994bc605b6e15a19c3adbbf614d8c
2018-10-08 11:39:24 +08:00
doc Follow the new PTI for document build 2018-02-28 14:42:11 +08:00
examples Remove deprecated parameters 2018-06-19 20:05:32 +00:00
lib/puppet Make providers use auth_url for authentication 2018-08-03 12:45:37 +02:00
manifests Merge "Update neutron packages name for Fedora" 2018-10-08 00:15:17 +00:00
releasenotes Notify about deprecated neutron::services::lbaas 2018-08-29 11:59:17 +00:00
spec Update neutron packages name for Fedora 2018-10-05 16:23:18 +05:30
templates Update outdated links in document and spelling error 2017-09-19 20:37:51 -07:00
.gitignore Dissuade .gitignore references to personal tools 2018-10-08 11:39:24 +08:00
.gitreview Update .gitreview file for project rename 2015-06-12 23:12:30 +00:00
.zuul.yaml switch documentation job to new PTI 2018-08-31 08:24:40 -04:00
CHANGELOG.md Update outdated links in document and spelling error 2017-09-19 20:37:51 -07:00
Gemfile Load puppet-openstack_spec_helper locally during tests 2018-02-12 15:13:00 +00:00
LICENSE Licensed under Apache\! 2013-04-12 10:28:17 -07:00
README.md Add the missing 'Table of Contents' 2018-08-27 14:01:55 +00:00
Rakefile Use puppet-openstack_spec_helper for Rakefile & spec_helper_acceptance 2016-01-18 09:11:27 -05:00
bindep.txt Add Puppet package to bindep, for module build 2017-10-27 13:14:24 -07:00
metadata.json Bump version for the start of Stein 2018-08-30 12:10:17 -06:00
setup.cfg Update URLs in documents according to document migration 2017-07-14 08:53:02 +08:00
setup.py Add basic structure for ReNo 2016-03-14 23:18:52 +00:00
tox.ini fix tox python3 overrides 2018-06-08 14:23:32 +08:00

README.md

Team and repository tags

Team and repository tags

neutron

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
  8. Release Notes - Release notes for the project
  9. Repository - The project source code repository

Overview

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.

Setup

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             => '127.0.0.1',
    default_transport_url => 'rabbit://neutron:passw0rd@localhost:5672/neutron',
    debug                 => false,
}

# configure authentication
class { 'neutron::server':
    auth_password   => 'keystone_neutron_secret',
    sql_connection  => 'mysql+pymysql://neutron:neutron_sql_secret@127.0.0.1/neutron?charset=utf8',
}

# 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          => '239.1.1.1',
  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.

Implementation

neutron

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

Types

neutron_config

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 => ml2,
}

This will write core_plugin=ml2 in the [DEFAULT] section.

name

Section/setting name to manage from neutron.conf

value

The value of the setting to be defined.

secret

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

ensure_absent_val

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

Limitations

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

Beaker-Rspec

This module has beaker-rspec tests

To run:

bundle install
bundle exec rspec spec/acceptance

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

Repository