Bridge between container framework networking and storage models to OpenStack networking and storage abstractions.
Go to file
Doug Hellmann d77be7fe45 import zuul job settings from project-config
This is a mechanically generated patch to complete step 1 of moving
the zuul job settings out of project-config and into each project
repository.

Because there will be a separate patch on each branch, the branch
specifiers for branch-specific jobs have been removed.

Because this patch is generated by a script, there may be some
cosmetic changes to the layout of the YAML file(s) as the contents are
normalized.

See the python3-first goal document for details:
https://governance.openstack.org/tc/goals/stein/python3-first.html

Change-Id: If41b55a075b9f98eb5e1d3359304bb508172624d
Story: #2002586
Task: #24306
2018-08-22 14:21:16 -04:00
contrib/busybox Base busybox container for tests 2016-11-09 10:59:13 +01:00
doc Follow the new PTI for document build 2018-07-17 08:12:54 +00:00
etc Refactoring: Drop all the code except common one 2016-07-19 14:56:17 +05:30
kuryr Add logging for the original message 2018-06-09 22:07:34 +00:00
releasenotes Update reno for stable/queens 2018-01-24 18:01:27 +00:00
usr/libexec/kuryr kuryr bind port error with neutron linux bridge driver 2016-11-01 14:57:05 +08:00
.coveragerc tox: fix coverage call 2016-09-29 14:04:31 +02:00
.gitignore Merge "Add reno support to kuryr" 2016-12-11 06:30:11 +00: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
.zuul.yaml import zuul job settings from project-config 2018-08-22 14:21:16 -04:00
CONTRIBUTING.rst Initial template commit 2015-07-15 10:00:44 +03:00
HACKING.rst Update the documentation link for doc migration 2017-07-24 16:23:47 +08:00
LICENSE Initial template commit 2015-07-15 10:00:44 +03:00
README.rst Replace deprecated "auth_uri" by "www_authenticate_uri" 2018-05-11 09:33:19 +07:00
__init__.py Removes unnecessary utf-8 encoding 2016-12-21 01:29:16 +00:00
babel.cfg Initial template commit 2015-07-15 10:00:44 +03:00
lower-constraints.txt add lower-constraints job 2018-04-15 23:09:20 +00:00
requirements.txt Updated from global requirements 2018-02-17 09:36:13 +00:00
setup.cfg Follow the new PTI for document build 2018-07-17 08:12:54 +00:00
setup.py Updated from global requirements 2017-03-17 11:55:19 +00:00
test-requirements.txt Follow the new PTI for document build 2018-07-17 08:12:54 +00:00
tox.ini Follow the new PTI for document build 2018-07-17 08:12:54 +00:00

README.rst

Team and repository tags

image

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

Getting Code

$ git clone https://git.openstack.org/openstack/kuryr.git
$ cd kuryr

Prerequisites

$ sudo pip install -r requirements.txt

Installing Kuryr's libnetwork driver

For kuryr-libnetwork driver installation refer:

https://docs.openstack.org/kuryr-libnetwork/latest/readme.html

Configuring Kuryr

Generate sample config, etc/kuryr.conf.sample, running the following

$ tox -e genconfig

Rename and copy config file at required path

$ cp etc/kuryr.conf.sample /etc/kuryr/kuryr.conf

Edit keystone section in /etc/kuryr/kuryr.conf, replace ADMIN_PASSWORD:

www_authenticate_uri = http://127.0.0.1:35357/v2.0
admin_user = admin
admin_tenant_name = service
admin_password = ADMIN_PASSWORD

In the same file uncomment the bindir parameter with the path for the Kuryr vif binding executables:

bindir = /usr/local/libexec/kuryr

By default, Kuryr will use veth pairs for performing the binding. However, the Kuryr library ships with two other drivers that you can configure in the binding section:

[binding]
#driver = kuryr.lib.binding.drivers.ipvlan
#driver = kuryr.lib.binding.drivers.macvlan

Drivers may make use of other binding options. Both Kuryr library drivers in the previous snippet can be further configured setting the interface that will act as link interface for the virtual devices:

link_iface = enp4s0

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 file if it is missing.

  • /usr/lib/docker/plugins/kuryr/kuryr.json: Json spec file for libnetwork.

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

Testing Kuryr

For a quick check that Kuryr is working create a network:

$ docker network create --driver kuryr test_net
785f8c1b5ae480c4ebcb54c1c48ab875754e4680d915b270279e4f6a1aa52283
$ docker network ls
NETWORK ID          NAME                DRIVER
785f8c1b5ae4        test_net            kuryr

To test it with tox:

$ 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 openstackdocstheme 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