a734ec5dde
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/0636b82d0d52aa3ba6a08c8a2af3aa88 Change-Id: I2dd87512fb6d4f142c625d381ba53a42ca5b160e
57 lines
1.7 KiB
Markdown
57 lines
1.7 KiB
Markdown
Team and repository tags
|
|
========================
|
|
|
|
[](http://governance.openstack.org/reference/tags/index.html)
|
|
|
|
<!-- Change things from this point on -->
|
|
|
|
# OVN
|
|
|
|
#### Table of Contents
|
|
|
|
1. [Overview](#overview)
|
|
2. [Module Description - What the module does and why it is useful](#module-description)
|
|
3. [Setup - The basics of getting started with ovn](#setup)
|
|
* [What ovn affects](#what-ovn-affects)
|
|
4. [Functional testing with Beaker-Rspec](#Beaker-Rspec)
|
|
|
|
## Overview
|
|
|
|
Puppet module for the OVN project.
|
|
|
|
## Module Description
|
|
|
|
This module has two class
|
|
1. ovn::northd to be used in machines that needs to run ovn-northd daemon
|
|
2. ovn::controller to be used in the compute nodes
|
|
|
|
## Setup
|
|
|
|
### Effects
|
|
|
|
ovn::northd just installs the ovn package and starts the ovn-northd serivce.
|
|
ovn::controller installs ovn package and starts the ovn-controller service.
|
|
Before starting ovn-controller process it updates the external_ids column
|
|
of Open_vSwitch table in vswitchd ovsdb. It relies on external data for some
|
|
of its parameters
|
|
* ovn_remote_ip - This should point to the url where ovn-nb and ovn-sb
|
|
db server is running
|
|
* ovn_encap_ip - This should point to the ip address that other hypervisors
|
|
would use to tunnel to this hypervisor.
|
|
* ovn_encap_type - Encapsulation type to be used by this controller. Defaults
|
|
to geneve
|
|
|
|
## Beaker-Rspec
|
|
|
|
This module has beaker-rspec tests.
|
|
To run the tests on the default vagrant node:
|
|
|
|
```shell
|
|
bundle install
|
|
bundle exec rake acceptance
|
|
```
|
|
|
|
For more information on writing and running beaker-rspec tests visit the documentation:
|
|
|
|
* https://github.com/puppetlabs/beaker/wiki/How-to-Write-a-Beaker-Test-for-a-Module
|