Skip to main content

Kuryr shared config and utilities

Project description

Team and repository tags

https://governance.openstack.org/badges/kuryr.svg

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://opendev.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:

auth_type           = v3password
auth_url            = http://127.0.0.1:5000
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:

[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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

kuryr-lib-3.1.0.tar.gz (734.8 kB view details)

Uploaded Source

Built Distribution

kuryr_lib-3.1.0-py3-none-any.whl (56.2 kB view details)

Uploaded Python 3

File details

Details for the file kuryr-lib-3.1.0.tar.gz.

File metadata

  • Download URL: kuryr-lib-3.1.0.tar.gz
  • Upload date:
  • Size: 734.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.9

File hashes

Hashes for kuryr-lib-3.1.0.tar.gz
Algorithm Hash digest
SHA256 600a15efd633ebd58c0ce49922de80550d88c4694bcbf4c0a94f3a20f5805d68
MD5 9cecf80b080757de6782c307f96abf7f
BLAKE2b-256 1e5d9bcb9a2fd272ffb06fa32a44c7b32f83f17f0fb2c09afea312fb4f1fc28c

See more details on using hashes here.

File details

Details for the file kuryr_lib-3.1.0-py3-none-any.whl.

File metadata

  • Download URL: kuryr_lib-3.1.0-py3-none-any.whl
  • Upload date:
  • Size: 56.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.9

File hashes

Hashes for kuryr_lib-3.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f691b12ba1bb0b3c9d02eefc9c35a07345cfe940381911e5df21e654c2d1138f
MD5 ec9dea6948794b91e877d7a130020edc
BLAKE2b-256 5bd4b32baa90c24b3f22de11c345ada6ac84c24ce89612a2a09e69732c958b12

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page