3rdparty/modules/neutron/README.md

   1 neutron
   2 ===================================
   3
   4 5.1.0 - 2014.2 - Juno
   5
   6 #### Table of Contents
   7
   8 1. [Overview - What is the neutron module?](#overview)
   9 2. [Module Description - What does the module do?](#module-description)
  10 3. [Setup - Tha basics of getting started with neutron.](#setup)
  11 4. [Implementation - An under-the-hood peek at what the module is doing.](#implementation)
  12 5. [Limitations - OS compatibility, etc.](#limitations)
  13 6. [Development - Guide for contributing to the module](#development)
  14 7. [Contributors - Those with commits](#contributors)
  15 8. [Release Notes - Notes on the most recent updates to the module](#release-notes)
  16
  17 Overview
  18 --------
  19
  20 The neutron module is a part of [Stackforge](https://github.com/stackforge), an effort by the Openstack infrastructure team to provide continuous integration testing and code review for Openstack and Openstack community projects not part of the core software. The module itself is used to flexibly configure and manage the newtork service for Openstack.
  21
  22 Module Description
  23 ------------------
  24
  25 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.
  26
  27 This module is tested in combination with other modules needed to build and leverage an entire Openstack installation. These modules can be found, all pulled together in the [openstack module](https://github.com/stackforge/puppet-openstack).
  28
  29 Setup
  30 -----
  31
  32 **What the neutron module affects:**
  33
  34 * [Neutron](https://wiki.openstack.org/wiki/Neutron), the network service for Openstack.
  35
  36 ### Installing neutron
  37
  38     puppet module install puppetlabs/neutron
  39
  40 ### Beginning with neutron
  41
  42 To utilize the neutron module's functionality you will need to declare multiple resources. The following is a modified excerpt from the [openstack module](httpd://github.com/stackforge/puppet-openstack). It provides an example of setting up an Open vSwitch neutron installation. This is not an exhaustive list of all the components needed. We recommend that you consult and understand the [openstack module](https://github.com/stackforge/puppet-openstack) and the [core openstack](http://docs.openstack.org) documentation to assist you in understanding the available deployment options.
  43
  44 ```puppet
  45 # enable the neutron service
  46 class { '::neutron':
  47     enabled         => true,
  48     bind_host       => '127.0.0.1',
  49     rabbit_host     => '127.0.0.1',
  50     rabbit_user     => 'neutron',
  51     rabbit_password => 'rabbit_secret',
  52     verbose         => false,
  53     debug           => false,
  54 }
  55
  56 # configure authentication
  57 class { 'neutron::server':
  58     auth_host       => '127.0.0.1', # the keystone host address
  59     auth_password   => 'keystone_neutron_secret',
  60     sql_connection  => 'mysql://neutron:neutron_sql_secret@127.0.0.1/neutron?charset=utf8',
  61 }
  62
  63 # enable the Open VSwitch plugin server
  64 class { 'neutron::plugins::ovs':
  65     tenant_network_type => 'gre',
  66     network_vlan_ranges => 'physnet:1000:2000',
  67 }
  68 ```
  69
  70 Other neutron network drivers include:
  71
  72 * dhcp,
  73 * metadata,
  74 * and l3.
  75
  76 Nova will also need to be configured to connect to the neutron service. Setting up the `nova::network::neutron` class sets
  77 the `network_api_class` parameter in nova to use neutron instead of nova-network.
  78
  79 ```puppet
  80 class { 'nova::network::neutron':
  81   neutron_admin_password  => 'neutron_admin_secret',
  82 }
  83 ```
  84
  85
  86 The `examples` directory also provides a quick tutorial on how to use this module.
  87
  88 Implementation
  89 --------------
  90
  91 ### neutron
  92
  93 neutron is a combination of Puppet manifest and ruby code to deliver configuration and extra functionality through *types* and *providers*.
  94
  95
  96 Limitations
  97 -----------
  98
  99 This module supports the following neutron plugins:
 100
 101 * Open vSwitch
 102 * linuxbridge
 103 * cisco-neutron
 104
 105 The following platforms are supported:
 106
 107 * Ubuntu 12.04 (Precise)
 108 * Debian (Wheezy)
 109 * RHEL 6
 110 * Fedora 18
 111
 112 Development
 113 -----------
 114
 115 The puppet-openstack modules follow the Openstack development model. Developer documentation for the entire puppet-openstack project is at:
 116
 117 * https://wiki.openstack.org/wiki/Puppet-openstack#Developerdocumentation
 118
 119 Contributors
 120 ------------
 121 The github [contributor graph](https://github.com/stackforge/puppet-neutron/graphs/contributors).
 122
 123 Release Notes
 124 -------------
 125
 126 **5.1.0**
 127
 128 * Fix l3_ha enablement
 129 * spec: pin rspec-puppet to 1.0.1
 130 * Switch to TLSv1
 131 * Support SR-IOV mechanism driver in ML2
 132 * Implement better nova_admin_tenant_id_setter exists? method
 133 * OVS Agent with ML2: fix symlink on RH plateforms
 134 * Adding portdb and fastpath_flood to n1kv.conf
 135 * Make cisco plugin symlink coherent
 136 * Fix status messages checks for neutron provider
 137 * Make neutron_plugin_ml2 before db-sync
 138 * Pin puppetlabs-concat to 1.2.1 in fixtures
 139 * change default MySQL collate to utf8_general_ci
 140 * Fix neutron file_line dependency
 141 * Corrects "ip link set" command
 142 * Adding vxlan network type support for neutron ML2 plug-in
 143 * Raise puppet error, if nova-api unavailable
 144 * Do not run neutron-ovs-cleanup for each Puppet run
 145 * Unescape value in parse_allocation_pool
 146 * Fix neutron_network for --router:external setting
 147 * Add MidoNet plugin support
 148 * Allow l3_ha to be turned back off after it has been enabled
 149 * Update .gitreview file for project rename
 150 * Fix support for auth_uri setting in neutron provider
 151 * Reduce neutron API timeout to 10 seconds
 152
 153 **5.0.0**
 154
 155 * Stable Juno release
 156 * Added neutron::policy to control policy.json
 157 * Added parameter allow_automatic_l3agent_failover to neutron::agents::l3
 158 * Added parameter metadata_memory_cache_ttl to neutron::agents::metadata
 159 * Added l3_ext as a provider_network_type property for neutron_network type
 160 * Changed user_group parameter in neutron::agents::lbaas to have different defaults depending on operating system
 161 * Changed openswan package to libreswan for RHEL 7 for vpnaas
 162 * Ensured neutron package was installed before nova_admin_tenant_id_setter is called
 163 * Added api_extensions_path parameter to neutron class
 164 * Added database tuning parameters
 165 * Changed management of file lines in /etc/default/neutron-server only for Ubuntu
 166 * Add parameters to enable DVR and HA support in neutron::agents::l3 for Juno
 167 * Fixed meaning of manage_service parameter in neutron::agents::ovs
 168 * Made keystone user creation optional when creating a service
 169 * Fixed the enable_dhcp property of neutron_subnet
 170 * Added the ability to override the keystone service name in neutron::keystone::auth
 171 * Fixed bug in parsing allocation pools in neutron_subnet type
 172 * Added relationship to refresh neutron-server when nova_admin_tenant_id_setter changes
 173 * Migrated the neutron::db::mysql class to use openstacklib::db::mysql and deprecated the mysql_module parameter
 174 * Fixed the relationship between the HA proxy package and the neutron-lbaas-agent package
 175 * Added kombu_reconnect_delay parameter to neutron class
 176 * Fixed plugin.ini error when cisco class is used
 177 * Fixed relationship between vs_pridge types and the neutron-plugin-ovs service
 178 * Added neutron::agents::n1kv_vem to deploy N1KV VEM
 179 * Added SSL support for nova_admin_tenant_id_setter
 180 * Fixed relationship between neutron-server package and neutron_plugin_ml2 types
 181 * Stopped puppet from trying to manage the ovs cleanup service
 182 * Deprecated the network_device_mtu parameter in neutron::agents::l3 and moved it to the neutron class
 183 * Added vpnaas_agent_package parameter to neutron::services::fwaas to install the vpnaas agent package
 184
 185 **4.3.0**
 186
 187 * Added parameter to specify number of RPC workers to spawn
 188 * Added ability to manage Neutron ML2 plugin
 189 * Fixed ssl parameter requirements when using kombu and rabbit
 190 * Added ability to hide secret neutron configs from logs and fixed password leaking
 191 * Added neutron plugin config file specification in neutron-server config
 192 * Fixed installation of ML2 plugin on Ubuntu
 193 * Added support for Cisco ML2 Mech Driver
 194 * Fixed quotas parameters in neutron config
 195 * Added parameter to configure dhcp_agent_notification in neutron config
 196 * Added class for linuxbridge support
 197 * Fixed neutron-server restart
 198 * Undeprecated enable_security_group parameter
 199
 200 **4.2.0**
 201
 202 * Added ml2/ovs support.
 203 * Added multi-region support.
 204 * Set default metadata backlog to 4096.
 205 * Fixed neutron-server refresh bug.
 206
 207 **4.1.0**
 208
 209 * Added parameter to set veth MTU.
 210 * Added RabbitMQ SSL support.
 211 * Added support for '' as a valid value for gateway_ip.
 212 * Fixed potential OVS resource duplication.
 213 * Pinned major gems.
 214
 215 **4.0.0**
 216
 217 * Stable Icehouse release.
 218 * Added Neutron-Nova interactions support.
 219 * Added external network bridge and interface driver for vpn agent.
 220 * Added support for puppetlabs-mysql 2.2 and greater.
 221 * Added neutron::config to handle additional custom options.
 222 * Added https support to metadata agent.
 223 * Added manage_service paraneter.
 224 * Added quota parameters.
 225 * Added support to configure ovs without installing package.
 226 * Added support for optional haproxy package management.
 227 * Added support to configure plugins by name rather than class name.
 228 * Added multi-worker support.
 229 * Added isolated network support.
 230 * Updated security group option for ml2 plugin.
 231 * Updated packaging changes for Red Hat and Ubuntu systems.
 232 * Updated parameter defaults to track upstream (Icehouse).
 233 * Fixed bug for subnets with empty values.
 234 * Fixed typos and misconfiguration in neutron.conf.
 235 * Fixed max_retries parameter warning.
 236 * Fixed database creation bugs.
 237
 238 **3.3.0**
 239
 240 * Added neutron_port resource.
 241 * Added external network bridge for vpn agent.
 242 * Changed dhcp_lease_duration to Havana default of 86400
 243 * Fixed VPNaaS installation for Red Hat systems.
 244 * Fixed conflicting symlink.
 245 * Fixed network_vlan_ranges parameter for OVS plugin
 246
 247 **3.2.0**
 248
 249 * Added write support for dns, allocation pools, and host routes to Neutron router provider.
 250 * Fixed multi-line attribute detection in base Neutron provider.
 251 * Fixed bugs with neutron router gateway id parsing.
 252
 253 **3.1.0**
 254
 255 * Added VXLAN support.
 256 * Configures security group when using ML2 plugin.
 257 * Ensures installation of ML2 plugin.
 258 * Fixed server deprecated warnings.
 259 * Tuned report and downtime intervals for l2 agent.
 260 * Added support for neutron nvp plugin.
 261 * Ensures linuxbridge dependency is installed on RHEL.
 262 * Improved L3 scheduler support.
 263 * Fixed improper test for tunnel_types param.
 264 * Allows log_dir to be set to false in order to disable file logging.
 265 * Improves consistency with other puppet modules for OpenStack by prefixing database related parameters with database.
 266 * Removed strict checks for vlan_ranges.
 267 * Fixed neutron-metering-agent package for Ubuntu.
 268 * Fixed VPNaaS service name for Ubuntu.
 269 * Fixed FWaaS race condition.
 270 * Fixed ML2 package dependency for Ubuntu.
 271 * Removed erronious check for service_plugins.
 272 * Added support for https auth endpoints.
 273 * Makes haproxy package management optional.
 274
 275 **3.0.0**
 276
 277 * Major release for OpenStack Havana.
 278 * Renamed project from quantum to neutron.
 279 * Changed the default quota_driver.
 280 * Removed provider setting requirement.
 281 * Fixed file permissions.
 282 * Fixed bug to ensure that keystone endpoint is set before service starts.
 283 * Added database configuration support for Havana.
 284 * Ensured dnsmasq package resource for compatibility with modules that define the same resource
 285 * Added multi-worker support.
 286 * Added metering agent support.
 287 * Added vpnaas agent support.
 288 * Added ml2 plugin support.
 289 * Fixed lbass driver name.
 290
 291 **2.2.0**
 292
 293 * Improved documentation.
 294 * Added syslog support.
 295 * Added quantum-plugin-cisco package resource.
 296 * Various lint and bug fixes.