puppet-vswitch/README.md
Emilien Macchi 2059a77127 Release 4.0.0
* Update CHANGELOG with release notes URL.
* Update README with new release number & name.
* Update metadata.json with new tag & dependencies.
* Add release note prelude for Mitaka.
* Update Reno release note to drop prelude.
* Improve release note landing page.

Change-Id: Ic899d2d7a466c113c2b17a9000392b8e2d6ae494
2016-03-23 14:50:57 -04:00

83 lines
1.5 KiB
Markdown

VSwitch
=======
4.0.0 - 2016.1 - Mitaka
A Puppet module providing things for vSwitches. At the moment OVS is the only
one I've added but please feel free to contribute new providers through
Stackforge. It's based upon types and providers so we can support more then just
OVS or one vSwitch type.
The current layout is:
* bridges - A "Bridge" is basically the thing you plug ports / interfaces into.
* ports - A Port is a interface you plug into the bridge (switch).
* configs - Configuration settings, if any
## USAGE:
To create a new bridge, use the `vs_bridge` type:
```
vs_bridge { 'br-ex':
ensure => present,
}
```
You can then attach a device to the bridge with a virtual port:
```
vs_port { 'eth2':
ensure => present,
bridge => 'br-ex',
}
```
You can change the vswitch configuration settings using.
```
vs_config { 'parameter_name':
ensure => present,
value => "some_value"
}
```
For configuration parameters that are 'hash' data type, the resource name
should be of the following format
```
parameter-name:key-name
Ex.
vs_config { 'external_ids:ovn-remote':
ensure => present,
value => 'tcp:127.0.0.1:6640'
}
```
For 'set/array' data types, value should be in the following format
```
'[<values>]'
Ex.
vs_config { 'array_key':
ensure => present,
value => '[2, 1, 6, 4]'
}
```
## Beaker-Rspec
This module has beaker-rspec tests
To run:
``shell
bundle install
bundle exec rspec spec/acceptance
``
## TODO:
* OpenFlow controller settings
* OpenFlow Settings
* OpenFlow Tables
* More facts
* Others that are not named here