OpenBACH Example 4 Agent : install, set up and run tests using OpenBACH

This project provides the scripts to install, to set up and run tests using OpenBACH.

This project does not prevent the reader from looking at OpenBACH installation manual. (in particular for the requirements on each target and instal machines)

Usage

By cloning the current repository, the user can:

1. run the 00-install.sh script to install OpenBACH - you can skip the NTP with ENTER if you do not want to specify an NTP server
2. run the 10-setup.sh script to set up an OpenBACH project

Based on this, the user can either use the auditorium scripts, the IHM or the provided scripts 20-run-quic.sh to build and run scenarios based on quic_configure_link example.

Installation details

If you encounter python-version related errors, we recommend you to either:

• On the installation machine (nuc5)

  • You may want to disabley key checking in ansible export ANSIBLE_HOST_KEY_CHECKING=False
  • Use virtual env
  • Update your paths on the installation machine, e.g.
    • vim ~/.bashrc
      • add export PYTHONPATH="$PYTHONPATH:/home/star/Desktop/openbach-extra/apis"
      • add export PATH="$PATH:/home/star/.local/bin"
    • source ~/.bashrc

• On the target machines (nuc1 .. nuc4)

  • Update the PYTHONPATH to use the correct version of python, e.g.
    • vim ~/.bashrc
      • add export PYTHONPATH="$PYTHONPATH:/usr/bin/python3"
    • source ~/.bashrc

• On the router machines (nuc2)

  • Activate ip_forward
    • Edit the /etc/sysctl.conf and make sure that the following line is uncommented:
      • net.ipv4.ip_forward = 1
    • You can check that the change if effective as follows:
      • cat /proc/sys/net/ipv4/ip_forward
      • The output should be 1

Five NUCs are exploited and the network architecture is showed below.

Each NUC exploits Ubuntu 20.04 with the username star and the root password azerty123.

Network details

The network is configured using netplan.

• netplan configuration files are located at /etc/netplan/* for each machines.

If the file is modified, the configuration can be applied using :

• sudo netplan apply

netplan file for nuc1

network:
  ethernets:
    enp0s25:
      match: 
        macaddress: 94:c6:91:18:bd:5e
      addresses:
      - 10.10.0.1/24
      gateway4: 10.10.0.1
      set-name: ensA
    enx503eaa3bcb9c:
      match: 
        macaddress: 50:3e:aa:3b:cb:9c
      addresses:
      - 10.10.1.1/24
      gateway4: 10.10.1.2
      set-name: ensI1
      routes:
        - to: 10.10.2.0/24
          via: 10.10.1.2
          on-link: true
  version: 2
  renderer: NetworkManager

netplan file for nuc2

network:
  ethernets:
    enp0s25:
      match:
        macaddress: 94:c6:91:18:be:b4
      addresses:
      - 10.10.0.2/24
      gateway4: 10.10.0.1
      set-name: ensA
    enx503eaa3bcab8:
      match:
        macaddress: 50:3e:aa:3b:ca:b8
      addresses:
      - 10.10.1.2/24
      gateway4: 10.10.1.2
      set-name: ensI1
    enx503eaa31b0ef:
      match:
        macaddress: 50:3e:aa:31:b0:ef
      addresses:
      - 10.10.2.2/24
      gateway4: 10.10.1.2
      set-name: ensI2
  version: 2
  renderer: NetworkManager

netplan file for nuc3

network:
  ethernets:
    enp0s25:
      match:
        macaddress: 94:c6:91:18:79:c3
      addresses:
      - 10.10.0.3/24
      gateway4: 10.10.0.1
      set-name: ensA
    enx503eaa31b0cd:
      match:
        macaddress: 50:3e:aa:31:b0:cd
      addresses:
      - 10.10.2.3/24
      gateway4: 10.10.2.2
      set-name: ensI2
      routes: 
        - to: 10.10.1.0/24
          via: 10.10.2.2
          on-link: true
  version: 2
  renderer: NetworkManager

netplan file for nuc4

network:
  ethernets:
    enp0s25:
      match: 
        macaddress: 94:c6:91:18:bc:96
      addresses: 
      - 10.10.0.4/24
      gateway4: 10.10.0.1
      set-name: ensA
  version: 2
  renderer: NetworkManager

netplan file for nuc5

network:
  ethernets:
    enp0s25:
      match:
        macaddress: 94:c6:91:17:c4:5e
      addresses: 
      - 10.10.0.5/24
      gateway4: 10.10.0.5
      set-name: ensA
  version: 2
  renderer: NetworkManager