https://github.com/openstack/puppet-neutron
OpenStack Neutron Puppet Module. Mirror of code maintained at opendev.org.
https://github.com/openstack/puppet-neutron
Last synced: 21 days ago
JSON representation
OpenStack Neutron Puppet Module. Mirror of code maintained at opendev.org.
- Host: GitHub
- URL: https://github.com/openstack/puppet-neutron
- Owner: openstack
- License: apache-2.0
- Created: 2013-08-18T02:04:09.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2025-03-18T18:24:29.000Z (about 2 months ago)
- Last Synced: 2025-03-28T02:11:48.936Z (about 1 month ago)
- Language: Ruby
- Homepage: https://opendev.org/openstack/puppet-neutron
- Size: 4.98 MB
- Stars: 64
- Watchers: 19
- Forks: 107
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.rst
- License: LICENSE
Awesome Lists containing this project
- awesome-repositories - openstack/puppet-neutron - OpenStack Neutron Puppet Module. Mirror of code maintained at opendev.org. (Ruby)
README
Team and repository tags
========================
[](https://governance.openstack.org/tc/reference/tags/index.html)
neutron
=======
#### Table of Contents
1. [Overview - What is the neutron module?](#overview)
2. [Module Description - What does the module do?](#module-description)
3. [Setup - Tha basics of getting started with neutron.](#setup)
4. [Implementation - An under-the-hood peek at what the module is doing.](#implementation)
5. [Limitations - OS compatibility, etc.](#limitations)
6. [Development - Guide for contributing to the module](#development)
7. [Contributors - Those with commits](#contributors)
8. [Release Notes - Release notes for the project](#release-notes)
9. [Repository - The project source code repository](#repository)
Overview
--------
The neutron module is a part of [OpenStack](https://opendev.org/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](https://docs.openstack.org/neutron/latest/), 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](https://docs.openstack.org) documentation to assist you in understanding the available deployment options.
```puppet
class { 'neutron':
bind_host => '127.0.0.1',
default_transport_url => 'rabbit://neutron:passw0rd@localhost:5672/neutron',
debug => false,
}
class { 'neutron::db':
database_connection => 'mysql+pymysql://neutron:[email protected]/neutron?charset=utf8',
}
class { 'neutron::server':
}
class { 'neutron::keystone::authtoken':
password => 'keystone_neutron_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 => '239.1.1.1',
mechanism_drivers => ['openvswitch'],
vni_ranges => ['1:300']
}
```
Other neutron network drivers include:
* dhcp,
* metadata,
* and l3.
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.
```puppet
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 ``
Limitations
-----------
This module supports only the ml2 plugin, and its mechanism drivers listed below.
* Arista
* Baremetal
* L2 Population
* Macvtap
* Open vSwitch
* OVN
* SR-IOV
Development
-----------
The puppet-openstack modules follow the OpenStack development model. Developer documentation for the entire puppet-openstack project is at:
* https://docs.openstack.org/puppet-openstack-guide/latest/
Contributors
------------
The github [contributor graph](https://github.com/openstack/puppet-neutron/graphs/contributors).
Release Notes
-------------
* https://docs.openstack.org/releasenotes/puppet-neutron
Repository
----------
* https://opendev.org/openstack/puppet-neutron