Bridge between container framework networking and storage models to OpenStack networking and storage abstractions.
Go to file
OpenStack Release Bot 84c22b9a85 reno: Update master for unmaintained/zed
Update the zed release notes configuration to build from

Change-Id: I33f6b93e4e1c6e6cf1d42d072cf775e5e0daf97c
2024-05-08 11:24:37 +00:00
contrib/busybox Base busybox container for tests 2016-11-09 10:59:13 +01:00
doc remove unicode from code 2021-03-04 10:33:52 +08:00
etc Refactoring: Drop all the code except common one 2016-07-19 14:56:17 +05:30
kuryr Fix unit tests 2021-09-15 12:32:40 +02:00
releasenotes reno: Update master for unmaintained/zed 2024-05-08 11:24:37 +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 Fix kuryr CI 2019-07-09 00:40:31 +00:00
.gitreview OpenDev Migration Patch 2019-04-19 19:31:37 +00:00
.stestr.conf Fix kuryr CI 2019-07-09 00:40:31 +00:00
.zuul.yaml Fix tox4 error 2023-01-31 03:29:38 +00: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 URLs with URLs 2019-10-13 09:01:56 +00:00 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
requirements.txt Drop lower-constraints.txt and its testing 2022-04-30 20:20:15 -05:00
setup.cfg Update python classifier in setup.cfg 2024-01-05 03:48:33 +00:00 Cleanup py27 support 2020-04-04 17:34:28 +02:00
test-requirements.txt Fix a typo: remove the unnecessary blank from test-requirements.txt 2020-10-06 21:35:07 +08:00
tox.ini Use py3 as the default runtime for tox 2023-08-03 15:23:50 +08:00


Team and repository tags



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.


  • TODO

Getting Code

$ git clone
$ cd kuryr


$ sudo pip install -r requirements.txt

Installing Kuryr's libnetwork driver

For kuryr-libnetwork driver installation refer:

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:

auth_type           = v3password
auth_url            =
region_name         = regionOne
user_doamin_name    = Default
username            = admin
project_domain_name = Default
project_name        = service
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:

#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/

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