puppet-vswitch/README.md
Flavio Percoco 3bf8dbb121 Show team and repo badges on README
This patch adds the team's and repository's badges to the README file.
The motivation behind this is to communicate the project status and
features at first glance.

For more information about this effort, please read this email thread:

http://lists.openstack.org/pipermail/openstack-dev/2016-October/105562.html

To see an example of how this would look like check:

https://gist.github.com/3178920eb6542706ec68fd0ff3681cde

Change-Id: Idf8f19aff1675c0e5efc666671c20249f68a595b
2016-11-25 17:43:44 +01:00

90 lines
1.8 KiB
Markdown

Team and repository tags
========================
[![Team and repository tags](http://governance.openstack.org/badges/puppet-vswitch.svg)](http://governance.openstack.org/reference/tags/index.html)
<!-- Change things from this point on -->
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