containerlab

README

---

With the growing number of containerized Network Operating Systems grows the demand to easily run them in the user-defined, versatile lab topologies.

Unfortunately, container orchestration tools like docker-compose are not a good fit for that purpose, as they do not allow a user to easily create connections between the containers which define a topology.

Containerlab provides a CLI for orchestrating and managing container-based networking labs. It starts the containers, builds a virtual wiring between them to create lab topologies of users choice and manages labs lifecycle.

Containerlab focuses on the containerized Network Operating Systems which are typically used to test network features and designs, such as:

• Nokia SR-Linux
• Arista cEOS
• Cisco XRd
• Azure SONiC
• Juniper cRPD
• Cumulus VX
• Keysight IXIA-C
• RARE/FreeRtr
• Ostinato

In addition to native containerized NOSes, containerlab can launch traditional virtual machine based routers using vrnetlab or boxen integration:

• Nokia virtual SR OS (vSim/VSR)
• Juniper vMX
• Juniper vQFX
• Juniper vSRX
• Juniper vJunos-router
• Juniper vJunos-switch
• Juniper vJunosEvolved
• Cisco IOS XRv9k
• Cisco Nexus 9000v
• Cisco c8000v
• Cisco CSR 1000v
• Dell FTOS10v
• Arista vEOS
• Palo Alto PAN
• IPInfusion OcNOS
• Check Point Cloudguard
• Fortinet Fortigate
• Aruba AOS-CX
• OpenBSD
• FreeBSD

And, of course, containerlab is perfectly capable of wiring up arbitrary linux containers which can host your network applications, virtual functions or simply be a test client. With all that, containerlab provides a single IaaC interface to manage labs which can span contain all the needed variants of nodes:

This short clip briefly demonstrates containerlab features and explains its purpose:

Features

• IaaC approach
  Declarative way of defining the labs by means of the topology definition clab files.
• Network Operating Systems centric
  Focus on containerized Network Operating Systems. The sophisticated startup requirements of various NOS containers are abstracted with kinds which allows the user to focus on the use cases, rather than infrastructure hurdles.
• VM based nodes friendly
  With the vrnetlab integration it is possible to get the best of two worlds - running virtualized and containerized nodes alike with the same IaaC approach and workflows.
• Multi-vendor and open
  Although being kick-started by Nokia engineers, containerlab doesn't take sides and supports NOSes from other vendors and opensource projects.
• Lab orchestration
  Starting the containers and interconnecting them alone is already good, but containerlab packages even more features like managing lab lifecycle: deploy, destroy, save, inspect, graph operations.
• Scaled labs generator
  With generate capabilities of containerlab it possible to define/launch CLOS-based topologies of arbitrary scale. Just say how many tiers you need and how big each tier is, the rest will be done in a split second.
• Simplicity and convenience
  Starting from frictionless installation and upgrade capabilities and ranging to the behind-the-scenes link wiring machinery, containerlab does its best for you to enjoy the tool.
• Fast
  Blazing fast way to create container based labs on any Linux system with Docker.
• Automated TLS certificates provisioning
  The nodes which require TLS certs will get them automatically on boot.
• Documentation is a first-class citizen
  We do not let our users guess by making a complete, concise and clean documentation.
• Lab catalog
  The "most-wanted" lab topologies are documented and included with containerlab installation. Based on this cherry-picked selection you can start crafting the labs answering your needs.

Use cases

• Labs and demos
  Containerlab was meant to be a tool for provisioning networking labs built with containers. It is free, open and ubiquitous. No software apart from Docker is required!
  As with any lab environment it allows the users to validate features, topologies, perform interop testing, datapath testing, etc.
  It is also a perfect companion for your next demo. Deploy the lab fast, with all its configuration stored as a code -> destroy when done. Easily and securely share lab access if needed.
• Testing and CI
  Because of the containerlab's single-binary packaging and code-based lab definition files, it was never that easy to spin up a test bed for CI. Gitlab CI, Github Actions and virtually any CI system will be able to spin up containerlab topologies in a single simple command.
• Telemetry validation
  Coupling modern telemetry stacks with containerlab labs make a perfect fit for Telemetry use cases validation. Spin up a lab with containerized network functions with a telemetry on the side, and run comprehensive telemetry use cases.

Containerlab documentation is provided at https://containerlab.dev.