openstack
/
kuryr
Code Issues Proposed changes
Bridge between container framework networking and storage models to OpenStack networking and storage abstractions.
348 Commits 9 Branches 16 Tags 9.9 MiB
Python 91.5%
Shell 8.5%
Go to file
Mike Spreitzer 5107602c0d Noted other requirements for generating documentation 
Generating the documentation requires the pip packages oslosphinx,
reno, and reno[sphinx] and they are not in requirements.txt.

Change-Id: I52156fc314a10ae5adc44bb88917461ca417df66
 		2016-03-08 22:43:07 -05:00
contrib/vagrant Expose horizon on Vagrant guest to localhost port 8080 2016-02-23 19:19:49 -08:00
devstack plugin.sh stops docker service rather than kill docker daemon. 2016-02-22 08:52:00 -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 Merge "make scope retrievable from env vars" 2016-02-29 19:44:23 +00: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 Modify run_kuryr.sh for more clear output 2016-02-29 06:37:13 +00:00
tools Make sure correct branch of Neutron is pulled on testing 2015-12-12 20:12:34 +02:00
usr/libexec/kuryr Merge "Modify external_ids in /usr/libexec/kuryr/ovs" 2016-02-29 19:48:50 +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 Noted other requirements for generating documentation 2016-03-08 22:43:07 -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 Updated from global requirements 2016-02-24 21:45:57 +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

Currently, Kuryr utilizes a bash script to start the service.

$ 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