Docker remote driver for OpenStack Neutron
Go to file
Jenkins 9961e9d39a Merge "Fix hard-code listen ip """ 2016-08-17 16:10:11 +00:00
contrib The kuryr default port has changed from 2377/2375 to 23750, we also need 2016-07-17 22:47:17 +08:00
devstack Kuryr Devstack installation has incorrect path in plugin 2016-08-02 10:07:56 +05:30
doc Doc-cleanup: remove redundant documentation 2016-07-06 13:28:53 +05:30
etc Drop common code and add kuryr_lib as requirement 2016-07-05 16:02:44 +05:30
init Add upstart config file 2016-02-15 20:54:38 +01:00
kuryr_libnetwork Fix hard-code listen ip "" 2016-08-17 11:11:24 +08:00
rally-jobs The kuryr default port has changed from 2377/2375 to 23750, we also need 2016-07-17 22:47:17 +08:00
releasenotes/notes Use reno for release notes 2015-12-14 09:41:51 -06:00
scripts Drop common code and add kuryr_lib as requirement 2016-07-05 16:02:44 +05:30
tools Update setup.cfg for kuryr-libnetwork 2016-07-27 15:33:29 +05:30
.coveragerc Update kuryr/tests to kuryr_libnetwork/tests in all files. 2016-07-16 00:14:04 +08:00
.gitignore Allow for user specified local.conf changes with Vagrant 2015-12-28 15:34:18 -06:00
.gitreview Update gitreview file 2016-07-01 08:02:48 -05:00
.testr.conf Drop common code and add kuryr_lib as requirement 2016-07-05 16:02:44 +05:30
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 Remove '' 2016-01-25 14:46:06 +08:00
README.rst Fix URL in README.rst 2016-08-17 14:16:57 +08:00 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 Merge "Fix hard-code listen ip """ 2016-08-17 16:10:11 +00:00
setup.cfg Fix pip install error for kuryr-libnetwork 2016-08-03 09:09:43 +08:00 Updated from global requirements 2016-02-19 02:32:25 +00:00
test-requirements.txt Updated from global requirements 2016-06-28 18:50:46 +00:00
tox.ini Enable DeprecationWarning in test environments 2016-08-09 19:48:22 -04:00



Kuryr mascot

Docker for OpenStack Neutron

Kuryr-libnetwork is Kuryr's Docker libnetwork driver that uses Neutron to provide networking services. It provides containerised images for the common Neutron plugins.

This repo provides libnetwork specific functionalities such as handler methods for libnetwork apis. All the logic/utilities that can be shared among different container networking frameworks such as Docker's libnetwork, K8s's CNI and so on, is maintained in separate Kuryr repo as a common library.


  • TODO

Getting Code

$ git clone
$ cd kuryr-libnetwork


$ sudo pip install -r requirements.txt

Installing Kuryr's libnetwork driver

Running the following will grab the requirements and install kuryr:

$ sudo pip install .

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_uri =
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

Running Kuryr

Currently, Kuryr utilizes a bash script to start the service. Make sure that you have installed tox before the execution of the command below:

$ sudo ./scripts/

After Kuryr starts, 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 oslosphinx 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


To create Docker networks with subnets having same/overlapping cidr, it is expected to pass unique pool name for each such network creation Docker command. Docker cli options -o and --ipam-opt should be used to pass pool names as shown below:

$ sudo docker network create --driver=kuryr --ipam-driver=kuryr \
  --subnet --ip-range \
  -o \ \

Now Docker user creates another network with same cidr as the previous one, i.e, but with different pool name, neutron_pool2:

$ sudo docker network create --driver=kuryr --ipam-driver=kuryr \
  --subnet --ip-range \
  -o \ \

External Resources

The latest and most in-depth documentation is available at: