Bridge between container framework networking and storage models to OpenStack networking and storage abstractions.
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Go to file
OpenStack Release Bot c11675d137 Update master for stable/2023.1
Add file to the reno documentation build to show release notes for

Use pbr instruction to increment the minor version number
automatically so that master versions are higher than the versions on

Sem-Ver: feature
Change-Id: I360e8a463a4d9135db0061cc7c238aa54511780c
4 months ago
contrib/busybox Base busybox container for tests 7 years ago
doc remove unicode from code 2 years ago
etc Refactoring: Drop all the code except common one 7 years ago
kuryr Fix unit tests 2 years ago
releasenotes Update master for stable/2023.1 4 months ago
usr/libexec/kuryr kuryr bind port error with neutron linux bridge driver 7 years ago
.coveragerc tox: fix coverage call 7 years ago
.gitignore Fix kuryr CI 4 years ago
.gitreview OpenDev Migration Patch 4 years ago
.stestr.conf Fix kuryr CI 4 years ago
.zuul.yaml Fix tox4 error 4 months ago
CONTRIBUTING.rst Initial template commit 8 years ago
HACKING.rst Update the documentation link for doc migration 6 years ago
LICENSE Initial template commit 8 years ago
README.rst Replace URLs with URLs 4 years ago Removes unnecessary utf-8 encoding 7 years ago
babel.cfg Initial template commit 8 years ago
requirements.txt Drop lower-constraints.txt and its testing 1 year ago
setup.cfg setup.cfg: Replace dashes with underscores 2 years ago Cleanup py27 support 3 years ago
test-requirements.txt Fix a typo: remove the unnecessary blank from test-requirements.txt 3 years ago
tox.ini Fix tox4 error 4 months ago


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