pyveth - veth driver for Docker Engine written in Python
edit | blame | history | raw

pyveth - Docker Plugin for veth networks

Simple network plugin for Docker Engine that can replace macvlan
in container-as-VM scenarios, allowing host-to-container communication
(see https://github.com/docker/for-linux/issues/931 for bug details).

It should be a drop-in replacement for macvlan module.

Build status

Installation

Plugin is packaged as Docker Engine-managed plugin.
Check out plugin page on Docker Hub.

To install it simply run:

docker plugin install jacekkow/pyveth

Usage

After installation you can use driver in newly-created networks:

docker network create --driver jacekkow/pyveth:latest new-network

By default it will simply create a pair of veth interfaces for each container.
One will be pushed inside the container and another will remain on host
(without any IP assigned).

Options

To use options, add --opt option=value as an argument of docker network create:

docker network create --driver jacekkow/pyveth:latest --opt parent=br0 new-network

Available options:

parent=brname

Automatically attach host interface to the bridge interface brname.

nogw=1

Disable assignment of gateway IP.

nogw4=1

Disable assignment of IPv4 gateway IP.

nogw6=1

Disable assignment of IPv6 gateway IP.

gw4=IP

gw6=IP

Forces assignment of a specified gateway (only if one is not provided by the IPAM module)
when creating the interface. Useful for pyipam
with ptp=1 option and nogw=1/nogw4=1/nogw6=1 here.

Using these would add routes like:
default via IP dev eth0 IP dev eth0 scope link

Container creation options

To use these options add --network name=network_name,driver-opt=option=value,driver-opt=option=value
to the docker run invocation:

docker run -i -t --rm --network name=test,ip=192.168.1.1,driver-opt=gw4=192.168.0.1,driver-opt=gw6=fe80:: alpine

Available options:

gw4=IP

gw6=IP

Overrides network-level gw4/gw6 options.

Manual packaging

In order to test this module in development environment, you can build it
by following Docker Engine documentation.

You can also use package.sh helper script which will perform
all the steps (including installation) automatically.

edit | blame | history | raw
BSD 3-Clause License

Copyright (c) 2020, Jacek Kowalski (http://jacekk.info)
All rights reserved.

Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this
   list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice,
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution.

3. Neither the name Jacekk.info, nor Jacekk.net, nor the names of its
   contributors may be used to endorse or promote products derived from this
   software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
README 2 KB
requirements 47 b