RUNOS

What is RUNOS?

RUNOS is an open-source distributed SDN/OpenFlow controller for enterprise software-defined networks, datacenter and career grade SDN networks. RUNOS is developed by Applied Research Center for Computer Networks (ARCCN) from Russia.

RUNOS Key Features

• High performance and scalability is ensured by implementation in C++17 and and the using of multithreading.
• High Availability (Active/Standby).
• Modularity.
• Extensibility of functionality.
• REST API for external applications.
• Monitoring tools (port statistics, control traffic statistics).
• Support OpenFlow version 1.3.
• Support CLI for debugging.
• Support Web UI: visualization of the entire network topology and detailed information about individual elements(switches, ports, links, hosts).
• Documentation and support.

Getting Started

Minimal Requirements

• RAM: 2Gb
• HDD: 8Gb
• Operating System: Ubuntu 18.04 and higher
• Browser: Google Chrome

Dependencies

1. Install curl and Nix package manager:

sudo apt-get install curl
curl -L https://nixos.org/nix/install | sh 

2. Install Redis in-memory data store:

sudo apt install redis-server

3. Install nginx server:

sudo apt install nginx

Build RUNOS from Source

1. Getting sources:

git clone https://github.com/ARCCN/runos.git 

2. Run nix-shell inside runos directory to build dependencies:

cd runos
nix-shell

3. Create build directory, run cmake and make:

mkdir build
cd build
cmake ..
make
cd ..

Install Application from Source

1. Go to the apps folder:

cd /runos/src/apps

2. Getting application sources:

git clone http://<application repository path>/app.git

3. If it is necessary, edit application's configuration file (settings.json) inside application directory.

4. Run nix-shell inside runos directory:

cd ../..
nix-shell

5. Rebuild RUNOS with application inside build directory:

cd build
cmake ..
make
cd ..

Start RUNOS

• Start RUNOS with default RUNOS settings file (runos-settings.json):

./build/runos

• Start RUNOS with your settings file (your_runos_settings.json):

./build/runos -c /path_to_file/your_runos_settings.json

RUNOS Web UI Configuring

1. Configure nginx server (edit nginx.conf):

sudo vim /etc/nginx/nginx.conf

2. Add the following text about server into http section of nginx.conf file (you need add your absolute path to the runos build directory):

http {
    server {
        listen 8080;
        root <...absolute/path/to/runos/build/directory...>/web;
        location ~*\.(html|css|js)$ {}
        location /images {}
        location / {
            proxy_pass http://localhost:8000;
        }
    }
}

3. Restart nginx server:

sudo service nginx restart

4. Start RUNOS Web UI in your browser:

http://$CONTROLLER_IP:8080/topology.html

Quick RUNOS Test Using Mininet

1. Install Mininet network emulator:

git clone git://github.com/mininet/mininet
cd mininet
sudo ./util/install.sh -nfv
cd ..

2. Start RUNOS controller:

cd runos
nix-shell
./build/runos

3. Start a simple network topology in Mininet (4 switches and 4 hosts):

sudo mn --topo linear,4 --switch ovsk,protocols=OpenFlow13 --controller remote,ip=127.0.0.1,port=6653

4. Start RUNOS Web UI, open the following link in your browser: http://localhost:8080/topology.html

Documentation

• Install RUNOS using virtual machine: Installation guide

• Install RUNOS using docker: Installation guide

• User's and developer's guide: RUNOS Documentation 2.0

• REST API description: RUNOS REST API

Support

• Telegram:

• email: [email protected]

• Wiki:

• Official mailing list:

License

RUNOS SDN/OpenFlow controller is published under Apache License 2.0