Baohua Yang 7a128a4b10 Add Makefile to generate the doc, and add steps into README
Change-Id: I8663dfd43fec0394c4a3b5bb87a4646102b69e2e
2016-01-06 23:57:13 -06:00
2015-12-10 07:33:55 +00:00
2015-07-27 19:40:49 +09:00
2015-10-08 21:37:54 +09:00
2015-07-14 18:00:33 +00:00
2015-07-15 10:00:44 +03:00
2015-07-15 10:00:44 +03:00
2015-07-15 10:00:44 +03:00
2015-07-15 10:00:44 +03:00
2015-07-15 10:00:44 +03:00
2015-07-15 10:00:44 +03:00
2015-11-04 17:03:49 +09:00
2015-12-23 01:31:10 +00:00
2015-07-15 10:00:44 +03:00

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.

$ ./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
Description
Bridge between container framework networking and storage models to OpenStack networking and storage abstractions.
Readme 10 MiB
Languages
Python 91.5%
Shell 8.5%