7f4146e044
This adds an alpine linux based docker image for running kuryr
one can try it out doing:
sudo mkdir -p /usr/lib/docker/plugins/kuryr
sudo curl -o /usr/lib/docker/plugins/kuryr/kuryr.spec \
https://raw.githubusercontent.com/openstack/kuryr/master/etc/kuryr.spec
sudo service docker restart
docker run --name kuryr-libnetwork \
--net=host \
--cap-add=NET_ADMIN \
-e SERVICE_USER=admin \
-e SERVICE_TENANT_NAME=admin \
-e SERVICE_PASSWORD=pass \
-e IDENTITY_URL=http://127.0.0.1:35357/v2.0 \
-e OS_URL=http://127.0.0.1:9696 \
-v /var/log/kuryr:/var/log/kuryr \
kuryr/libnetwork
Change-Id: I68d727194d6029da965fca90fdd464ed45b02044
Signed-off-by: Antoni Segura Puimedon <toni@midokura.com>
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.
- Free software: Apache license
- Documentation: http://docs.openstack.org/developer/kuryr
- Source: http://git.openstack.org/cgit/openstack/kuryr
- Bugs: http://bugs.launchpad.net/kuryr
Features
- TODO
Prerequisites
$ sudo pip install -r requirements.txtInstalling Kuryr's libnetwork driver
Running the following will grab the requirements and install kuryr
- ::
-
$ sudo pip install .
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.shAfter the booting, please restart your Docker service, e.g.,
- ::
-
$ sudo service docker restart
The bash script creates the following files if they are missing.
/usr/lib/docker/plugins/kuryr/kuryr.json: Json spec file for libnetwork;/etc/kuryr/kuryr.conf: Configuration file for Kuryr.
Note the root privilege is required for creating and deleting the veth pairs with pyroute2 to run.
Testing Kuryr
$ toxYou can also run specific test cases using the -e flag,
e.g., to only run the fullstack test case.
$ tox -e fullstackGenerating Documentation
We use Sphinx to maintain the documentation. You can install Sphinx using pip.
$ pip install -U SphinxIn 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 htmlNow you can serve the documentation at http://localhost:8080 as a simple website.
$ cd build/html
$ python -m SimpleHTTPServer 8080