FreerTr docker container
Shell
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
run
scripts
Dockerfile
LICENSE
README.md

README.md

freertr-docker

A basic FreerTr docker container

Prerequisite

  • Install docker on Dockerhost with the method of your choice
  • Make sure that docker the container inherit from docker host DNS configuration
  • Check this by issuing:
sudo docker run busybox nslookup www.google.com

How to build freerTr container

git clone https://github.com/frederic-loui/freertr-docker.git
cd ./freertr-docker
sudo docker build --tag freertr/freertr:latest .

How to configure FreerTr before running the container

There are 2 files in ./freertr-docker/run :

./freertr-hw.txt  
./freertr-sw.txt

These files are in the format -hw.txt and -sw.txt

As a start use the sample provided and replace eth2 by your NIC device (usually eth0)

freertr-hw.txt:

In this sample file you'll indicate which Dockerhost interface will be bind to FreerTr container.
The line use to attach an interface to FreerTr container is:

int <network-device> eth <mac@> <bind_ip@> <tx_port> <bind_ip@> <rx_port> <br>
...
int eth2 eth 0000.1111.2222 127.0.0.1 22706 127.0.0.1 22705
int eth3 eth 0000.1111.3333 127.0.0.1 20011 127.0.0.1 20010
...

For more detail please refer to FreerTr homepage: http://freerouter.nop.hu/

freertr-sw.txt

It is the FreerTr router configuration.
For more detail please refer to FreerTr homepage: http://freerouter.nop.hu/

How to run FreerTr container

There is 2 processes that is run inside this container:

  • A "control plane" process: This process is written in Java and can be run in user space
  • A "data plane" process: This process is written in C run in kernel space and need thus more priviledges => This explain why we use --privileged flag. In addition

In addition FreerTr will manipulate the network interface attached to it.
=> This explain why we use --network host flag. In addition

sudo docker run --detach --privileged --network host -e "FREERTR_INTF_LIST=eth2/20010/20011" -e "FREERTR_HOSTNAME=freertr" -v "/home/kubeadm/freertr/run:/opt/freertr/run" --name freertr-001 freertr/freertr:latest 

Acknowledgement

I would like to thank the original maintainer of FreerTr for this awesome piece of code.
If you need to understand networking protocol. Read the source, it is exceptionnally well written.
If you like reading IETF RFCs you will enjoy studying this code. (You'll save tons of sleeping pills ;-) )

Kudos to Csaba MATE then... all credits goes to him !