Docker remote driver for OpenStack Neutron
Go to file
Jenkins bc885f2bf4 Merge "Only install docker in case it is not installed" 2016-05-02 15:28:38 +00:00
contrib/vagrant Merge "Vagrant: Allow running the "docker" command as the vagrant user" 2016-04-19 22:48:40 +00:00
devstack Merge "Only install docker in case it is not installed" 2016-05-02 15:28:38 +00:00
doc Shrink logo size 2016-04-29 10:49:32 -05:00
etc Activate libnetwork plugin with .spec instead of .json 2016-04-21 18:15:56 -07:00
init Add upstart config file 2016-02-15 20:54:38 +01:00
kuryr Adding support for OVS Hybrid binding 2016-05-02 09:52:56 -04:00
rally-jobs Add rally case for create and delete network 2016-03-07 13:57:44 +08:00
releasenotes/notes Use reno for release notes 2015-12-14 09:41:51 -06:00
scripts Modify run_kuryr.sh to accepts arguments 2016-04-14 18:19:42 +09:00
tools Make sure correct branch of Neutron is pulled on testing 2015-12-12 20:12:34 +02:00
usr/libexec/kuryr Adding support for OVS Hybrid binding 2016-05-02 09:52:56 -04: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 Shrink logo size 2016-04-29 10:49:32 -05: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 Add oslo.log and use its config options by default 2016-04-13 20:36:47 +09: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-04-07 17:19:08 +00:00
tox.ini Merge "Support py34 in Kuryr" 2016-02-10 06:58:40 +00:00

README.rst

kuryr

Kuryr mascot

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

Currently, Kuryr utilizes a bash script to start the service. Make sure that you have installed tox before the execution of the below command.

$ sudo ./scripts/run_kuryr.sh

After the booting, please restart your Docker service, e.g.,

::

$ sudo service docker restart

The bash script creates the following files if they are missing.

  • /usr/lib/docker/plugins/kuryr/kuryr.json: Json spec file for libnetwork;
  • /etc/kuryr/kuryr.conf: Configuration file for Kuryr.

Note the root privilege is required for creating and deleting the veth pairs with pyroute2 to run.

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

Generating Documentation

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

$ pip install -U Sphinx

In addition to Sphinx you will also need the following requirements (not covered by requirements.txt):

$ pip install oslosphinx reno 'reno[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