kytos-ng / dockers

Kytos Dockers

WARNING: As previously announced on our communication channels, the Kytos project will enter the "shutdown" phase on May 31, 2021. After this date, only critical patches (security and core bug fixes) will be accepted, and the project will be in "critical-only" mode for another six months (until November 30, 2021). For more information visit the FAQ at https://kytos.io/faq. We'll have eternal gratitude to the entire community of developers and users that made the project so far.

This is the official repository of the Docker images for Kytos SDN Platform.

Quick Start

First, just install docker from your package provider and choose one of the following versions:

Try First: This version installs the latest pre-release Kytos version

Nightly: This version installs the latest uploaded Kytos version

Running

First, clone this repo:

   $ https://github.com/kytos/dockers.git

After cloning, run the following commands to start Docker container:

   $ cd <version>
   $ sudo docker build -t <version> .
   $ sudo docker run -it -p <host_port>:<container_port> --privileged <version>

Then, execute kytos:

    $ sudo docker exec -it <container_id> kytosd <kytos_parameters>

If you want to run any kytos-utils command, run:

    $ sudo docker exec -it <container_id> kytos <kytos-utils_command>

Parameters:

• version: version to be executed (tryfirst, nightly)
• host_port: any port on the host
• container_port: port to be assigned in container (6653, 8181)
• container_id: identifier of Docker container
• kytos_parameters: any kytos parameter (Configuring Kytos)
• kytos-utils_command: any kytos-utils command, try -h to see a list of them

Contributing

If you want to contribute to this project, please read Kytos Documentation website.

License

This software is under MIT-License. For more information please read LICENSE file.