quickstart.rst

Quickstart

Docker

You do not need to install Kytos to try it.

We have prepared a docker image for you to try Kytos, so all you have to do is:

run kytos/tryfirst docker image:

$ docker run --privileged -it kytos/tryfirst

run kytos daemon inside docker:

$ kytosd -f

and you will have your instance of a basic openflow controller built with Kytos SDN Platform.

Install

In order to install and run kytos you need:

• Python3.6 (python.org)
• pip (get pip)

Kytos main distribution happens through pypi, so install it by using pip:

$ python3.6 -m pip install kytos

Run

once kytos is installed, you can:

start the kytos daemon in the foreground, and access its console:

$ kytosd -f

install and enable kytos napps (must have kytos daemon running):

$ kytos napps install user/napp

---

NB:

Notice that in order to have basic openflow funcionality, Kytos needs at least the kytos/of_core napp installed and loaded. For full OpenFlow functionality, including web-ui features you should install the following napps:

• kytos/of_core
• kytos/of_l2ls
• kytos/of_lldp
• kytos/of_stats
• kytos/of_topology
• kytos/of_flow_manager
• kytos/of_ipv6drop
• kytos/web_topology_layout

to do it, run:

$ kytos napps install kytos/of_core kytos/of_l2ls \
kytos/of_lldp kytos/of_stats kytos/of_topology \
kytos/of_flow_manager kytos/of_ipv6drop \
kytos/web_topology_layout