Skip to content

Commit

Permalink
Merge pull request #78 from srl-wim/docs-main-image
Browse files Browse the repository at this point in the history
Documentation main page
  • Loading branch information
hellt authored Oct 4, 2020
2 parents 70c950c + 3b7bc79 commit 4da1ea7
Showing 1 changed file with 10 additions and 13 deletions.
23 changes: 10 additions & 13 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,22 @@

[![github release](https://img.shields.io/github/release/srl-wim/container-lab.svg?style=flat-square&color=00c9ff&labelColor=bec8d2)](https://github.com/srl-wim/container-lab/releases/)
[![Github all releases](https://img.shields.io/github/downloads/srl-wim/container-lab/total.svg?style=flat-square&color=00c9ff&labelColor=bec8d2)](https://github.com/srl-wim/container-lab/releases/)
[![Go Report](https://img.shields.io/badge/go%20report-A%2B-blue?style=flat-square&color=00c9ff&labelColor=bec8d2)](https://goreportcard.com/report/github.com/srl-wim/container-lab)
[![Doc](https://img.shields.io/badge/Docs-containerlab.srlinux.dev-blue?style=flat-square&color=00c9ff&labelColor=bec8d2)](https://containerlab.srlinux.dev)
[![build](https://img.shields.io/github/workflow/status/srl-wim/container-lab/Test/master?style=flat-square&labelColor=bec8d2)](https://github.com/srl-wim/container-lab/releases/)

---

## Description
Containerlab provides a framework for setting up networking labs with containers. It builds a virtual wiring between the containers to create virtual topologies of users choice.

Containerlab provides a framework for setting up and destroying labs for networking containers. It builds a virtual wiring using veth pairs between the containers to provide virtual topologies.
![clab-example-topos](https://gitlab.com/rdodin/pics/-/wikis/uploads/a770f2886380b94f3f183f4a1096b35f/image.png)

The labs could also be wired to an external bridge to connect to external environment or to build hierarchical labs.
Conainerlab focuses on _networking_ containers which are typically used to test network features and designs, such as:

A CA can be provided per lab and when enabled, containerlab generates certificates per device that can be used for various use cases, like GNMI, JSON RPC, etc.
* [Nokia SR-Linux](https://www.nokia.com/networks/products/service-router-linux-NOS/)
* [Arista cEOS](https://www.arista.com/en/products/software-controlled-container-networking)

Lastly, containerlab also allows for a graphical output to validate the lab in a visual format using [graphviz](https://graphviz.org)
Although, containerlab can wire up any typical linux container which can be used as the test clients.

Containerlab supports the following containers:

* standard linux/alpine containers, typically used as test clients
* networking containers:
* Nokia SR-Linux
* Arista cEOS.
### Features
* Labs can be wired to an external bridge to connect to an external environment or to build hierarchical labs.
* TLS certificates can be generated automatically for every node of a lab.
* The lab topology can be graphically visualized with [graphviz](https://graphviz.org) tool (WIP).

0 comments on commit 4da1ea7

Please sign in to comment.