Bridge between container framework networking and storage models to OpenStack networking and storage abstractions.
Go to file
Fawad Khaliq 894d2b7313 Add PLUMgrid/IOvisor binding for Kuryr
Implements: blueprint plumgrid-kuryr-binding
Change-Id: I478dc305bba418b84e3a64dd6ec35e5b2b5c2f5b
2016-02-27 20:48:37 +00:00
contrib/vagrant Virtualbox now uses 'ubuntu/trusty64' instead of 'trusty' 2016-02-18 22:47:00 -08:00
devstack Renaming service from docker-engine to docker to fix 'vagrant up' 2016-02-18 11:47:09 -08:00
doc Merge "Adjust underline length and change default scope to local" 2016-02-22 20:10:03 +00:00
etc Correct location of auto-generated config file 2015-12-03 11:46:08 -05:00
init Add upstart config file 2016-02-15 20:54:38 +01:00
kuryr Expose additional vif params to bind/unbind scripts 2016-02-27 07:23:10 -08:00
rally-jobs Add the kuryr plugin for rally 2016-02-17 17:02:15 +08:00
releasenotes/notes Use reno for release notes 2015-12-14 09:41:51 -06:00
scripts Completing the basic configuration for Kuryr 2015-12-07 09:35:26 -05:00
tools Make sure correct branch of Neutron is pulled on testing 2015-12-12 20:12:34 +02:00
usr/libexec/kuryr Add PLUMgrid/IOvisor binding for Kuryr 2016-02-27 20:48:37 +00:00
.coveragerc Exclude tests from coverage 2015-10-08 21:37:54 +09:00
.gitignore Allow for user specified local.conf changes with Vagrant 2015-12-28 15:34:18 -06:00
.gitreview Added .gitreview 2015-07-14 18:00:33 +00:00
.testr.conf Separate unit tests from fullstack tests 2015-12-08 09:08:04 +02:00
CONTRIBUTING.rst Initial template commit 2015-07-15 10:00:44 +03:00
HACKING.rst Initial template commit 2015-07-15 10:00:44 +03:00
LICENSE Initial template commit 2015-07-15 10:00:44 +03:00
MANIFEST.in Remove 'MANIFEST.in' 2016-01-25 14:46:06 +08:00
README.rst Merge "Fixed typo in README.rst" 2016-02-09 04:04:29 +00:00
__init__.py Add entrypoint of Kuryr 2015-07-27 19:40:49 +09:00
babel.cfg Initial template commit 2015-07-15 10:00:44 +03:00
requirements.txt Updated from global requirements 2016-02-19 02:32:25 +00:00
setup.cfg Remove support for Python 3.3 2016-02-11 08:47:34 +09:00
setup.py Updated from global requirements 2016-02-19 02:32:25 +00:00
test-requirements.txt Updated from global requirements 2016-02-19 02:32:25 +00:00
tox.ini Merge "Support py34 in Kuryr" 2016-02-10 06:58:40 +00:00

README.rst

kuryr

Kuryr

Docker for OpenStack Neutron

Kuryr is a Docker network plugin that uses Neutron to provide networking services to Docker containers. It provides containerised images for the common Neutron plugins.

Features

  • TODO

Prerequisites

$ sudo pip install -r requirements.txt

Running Kuryr

Please run the following script, it creates /usr/lib/docker/plugins/kuryr and the JSON spec file, /usr/lib/docker/plugins/kuryr/kuryr.json, if they don't exist. Kuryr requires the root privilege for creating and deleting the veth pairs with pyroute2 to run.

$ sudo ./scripts/run_kuryr.sh

Testing Kuryr

$ tox

You can also run specific test cases using the -e flag, e.g., to only run the fullstack test case.

$ tox -e fullstack

Generate Documentation

We use Sphinx to maintain the documentation. You can install Sphinx using pip.

$ pip install -U Sphinx

The source code of the documentation are under doc, you can generate the html files using the following command. If the generation succeeds,a build/html dir will be created under doc.

$ cd doc
$ make html

Now you can serve the documentation at http://localhost:8080 as a simple website.

$ cd build/html
$ python -m SimpleHTTPServer 8080