KatharaFramework/Kathara

Project: Kathara (GitHub Link)

Kathara-master
- .github
  - ISSUE_TEMPLATE
    - feature_request.md
    - bug_report.md
- src
  - kathara.py
  - Resources
    - trdparty
      - dockerpty
        io.py
        __init__.py
        pty.py
        tty.py
      - consolemenu
        selection_menu.py
        console_menu.py
        multiselect_menu.py
        items
        submenu_item.py
        command_item.py
        external_item.py
        function_item.py
        selection_item.py
        __init__.py
        validators
        regex.py
        __init__.py
        url.py
        base.py
        version.py
        format
        menu_margins.py
        menu_borders.py
        menu_style.py
        __init__.py
        menu_padding.py
        menu_component.py
        prompt_utils.py
        menu_formatter.py
        screen.py
        __init__.py
      - __init__.py
      - depgen
        depgen.py
        __init__.py
    - exceptions.py
    - setting
      - __init__.py
      - Setting.py
    - version.py
    - test
      - BuiltinTest.py
      - __init__.py
      - UserTest.py
    - api
      - GitHubApi.py
      - DockerHubApi.py
      - __init__.py
    - validator
      - TerminalValidator.py
      - __init__.py
      - ImageValidator.py
    - os
      - Networking.py
      - __init__.py
    - __init__.py
    - strings.py
    - utils.py
    - foundation
      - test
        Test.py
        __init__.py
      - __init__.py
      - manager
        IManager.py
        __init__.py
      - command
        __init__.py
        Command.py
    - auth
      - PrivilegeHandler.py
    - model
      - Lab.py
      - Link.py
      - Machine.py
      - ExternalLink.py
      - __init__.py
    - manager
      - ManagerProxy.py
      - docker
        DockerManager.py
        DockerMachine.py
        __init__.py
        DockerPlugin.py
        DockerLink.py
        DockerImage.py
      - __init__.py
    - command
      - LstartCommand.py
      - SettingsCommand.py
      - LcleanCommand.py
      - WipeCommand.py
      - VconfigCommand.py
      - CheckCommand.py
      - LinfoCommand.py
      - LrestartCommand.py
      - ListCommand.py
      - LconfigCommand.py
      - __init__.py
      - ConnectCommand.py
      - LtestCommand.py
      - VstartCommand.py
      - VcleanCommand.py
    - parser
      - netkit
        ExtParser.py
        LabParser.py
        OptionParser.py
        FolderParser.py
        __init__.py
        DepParser.py
      - __init__.py
  - requirements.txt
- LICENSE
- README.md
- scripts
  - OSX
    - Makefile
    - kathara.spec
    - README.md
    - darwin
      - Resources
        welcome.html
        conclusion.html
      - uninstall.sh
      - Distribution
      - scripts
        postinstall
  - Windows
    - Assets
      - environment.iss
      - kathara.spec
      - app_icon.ico
    - installer.iss
    - README.md
    - WindowsBuild.bat
  - Linux
    - Makefile
    - Docker-Linux-Build
      - dput.cf
      - Dockerfile
    - debian
      - kathara.lintian-overrides
      - source
        lintian-overrides
        format
      - kathara.links
      - compat
      - kathara.postinst
      - changelog
      - rules
      - copyright
      - kathara.prerm
      - kathara.dirs
      - control
    - README.md
- .gitignore
- docs
  - kathara-settings.1.ronn
  - kathara-linfo.1.ronn
  - footer.txt
  - Makefile
  - kathara-lconfig.1.ronn
  - kathara-lab.dep.5.ronn
  - kathara-lrestart.1.ronn
  - kathara-check.1.ronn
  - kathara.1.ronn
  - kathara-ltest.1.ronn
  - index.txt
  - kathara-lab-dirs.7.ronn
  - kathara-wipe.1.ronn
  - kathara-lab.ext.5.ronn
  - kathara-vconfig.1.ronn
  - kathara.conf.5.ronn
  - kathara-lab.conf.5.ronn
  - kathara-lclean.1.ronn
  - kathara-lstart.1.ronn
  - kathara-connect.1.ronn
  - kathara-vclean.1.ronn
  - kathara-list.1.ronn
  - kathara-vstart.1.ronn

From the Greek Καθαρά.
Implementation of the notorious Netkit using Python. 10 times faster than Netkit and more than 100 times lighter, allows easy configuration and deploy of arbitrary virtual networks with SDN, NFV and traditional routing protocols. The framework has the performances to run in production and our images can emulate most network equipments.

Kathará comes with P4, OpenVSwitch, Quagga, FRRouting, Bind, and more, but can also be extended with your own container images. For more information about Kathará images please visit the dedicated repo.

Installation

Install Docker and then run the installer. For a step by step guide check the Wiki.

Graphical User Interface

Being based on Netkit, all previous tools still work. In particular we suggest Netkit Lab Generator, a GUI that allows the easy creation of a lab configuration and the visualization of its network topology.

Example

Installa Kathará by following the installation steps above
Download and unpack "BGP, OSPF and RIP interplay" from here.
The topology of this lab can be found here.
cd inside "BGP, OSPF and RIP interplay" and run kathara lstart
Kathará will read the configuration of the lab from lab.conf, lab.dep and the various *.startup files and start the machines, opening terminal windows to interact with the virtual network nodes.
After you're done experimenting, simply run kathara lclean
This will kill and remove all the machines.