openstack
/
kuryr
Code Issues Proposed changes
Bridge between container framework networking and storage models to OpenStack networking and storage abstractions.
278 Commits 9 Branches 42 Tags 9.9 MiB
Python 91.5%
Shell 8.5%
Go to file
Taku Fukushima 672906eef3 Add "sudo" to the instruction for running Kuryr 
This patch adds "sudo" to "Running Kuryr" section of README.rst. Some
people get stuck with the errors of pyroute2 and that's because of the
lack of the privilege for manipulating the veth interfaces.

Related-Bug: #1516539

Change-Id: I44f44755a1aec4ec29d0afa4852e989eca28d381
Signed-off-by: Taku Fukushima <f.tac.mac@gmail.com>
 		2016-01-26 12:56:05 +09:00
contrib/vagrant Update the invalid URL. 2016-01-20 00:45:34 +08:00
devstack Change url from http to https in local.conf.sample 2016-01-05 14:03:28 +00:00
doc Fix term inside the spec 2016-01-25 10:58:56 +08:00
etc Correct location of auto-generated config file 2015-12-03 11:46:08 -05:00
kuryr Merge "Change capability_scope default value to local" 2016-01-22 10:21:22 +00:00
rally-jobs Add rally integration point 2015-12-10 07:33:55 +00: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 Fix the unbind_port method in libexec of ovs. 2015-12-21 05:12:57 -08: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 Initial template commit 2015-07-15 10:00:44 +03:00
README.rst Add "sudo" to the instruction for running Kuryr 2016-01-26 12:56:05 +09: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 Fix missing tox in the requirement file 2016-01-21 13:57:10 -05:00
setup.cfg remove python 2.6 trove classifier 2015-12-23 01:31:10 +00:00
setup.py Initial template commit 2015-07-15 10:00:44 +03:00
test-requirements.txt Fix docker-py lib version from 1.4.0+ to 1.5.0+ 2016-01-07 08:49:57 -06:00
tox.ini Clean up removed hacking rule from [flake8] ignore lists 2016-01-14 17:04:44 +08: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 Sphinix to maintain the documentation. You can install Sphinix 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