Skip to content

Concepts

Zoey thinking, with a question mark next to her

Antimony is built around a short chain: a collection holds topologies, a topology is deployed as labs, and a running lab has an instance with nodes. Pick a concept to learn more.

also

Collection

A folder for topologies, usually one per course, class or team. It decides who can see, edit and deploy what: users get access through an OpenID group with the same name.

Example
hs25-cn1 with "Anyone can deploy" turned on
Where you see it
The explorer in the topology editor, and the left panel of the dashboard
Users and permissions →

Topology

A network design: a containerlab topology file with nodes, their kinds and images, and the links between them. The graph layout is stored next to it in an annotations file.

Example
ospf-multiarea: 12 FRR routers in five areas
Where you see it
The topology editor, as YAML and as a graph
Topology editor →

Lab

A deployment of a topology with a start and an end time. Create as many labs from a topology as you need, for example one per student. Each lab keeps its own copy of the topology.

Example
OSPF Lab 3, Tuesday 10:00–12:00
Where you see it
The dashboard and the lab schedule
Deploying labs →

Instance

The live side of a deployed lab: its state and its nodes. It only exists while the lab is deployed, under a unique instance name.

Example
ospf-multiarea-3f9c2a1b7d4e, running
Where you see it
The lab view and its details panel
Lab lifecycle →

Node

One device in a running lab: a container with containerlab, or a pod with clabernetes. Open terminals on it, read its logs, watch its statistics and capture its traffic.

Example
r1, an FRR router with eth1 and eth2
Where you see it
The graph and node panel of the lab view
Working with a lab →

Bind file

A file that belongs to a topology and is mounted into a node when the lab starts, such as a startup configuration.

Example
configs/r1.conf → /etc/frr/frr.conf
Where you see it
Under the topology in the editor explorer
Bind files →

Kind

The containerlab node type, which tells containerlab how to start a node. Antimony adds per-kind settings, such as the SSH login for terminals.

Example
nokia_srlinux, ceos, linux
Where you see it
The Kind field of a node, and kinds.conf.yml on the server
Node kinds →

Provider

The part of the server that actually runs labs: containerlab on the same Docker host, clabernetes on a Kubernetes cluster, or dummy, which only pretends.

Example
deployment.provider: containerlab
Where you see it
The Provider field in the lab details, and config.yml
Clabernetes →
Concept Is a… Created by Lives
Collection Folder of topologies with permissions Administrators Until deleted
Topology containerlab topology file with bind files Collection members with edit rights Until deleted
Lab Deployment of a topology with a start and end time Users with deploy rights Until deleted; inactive after its end time
Instance Live state of a deployed lab Antimony, when the lab deploys While the lab is deployed
Node Container or pod running one device The provider While the lab is deployed
Domain modelA collection contains topologies. A topology has bind files and is deployed as labs. A lab has at most one instance while it is deployed, and an instance has nodes. Users create collections, topologies and labs. Instances and nodes are kept in memory only.CollectionnamepublicDeploypublicWriteTopologytopology.clab.yamlsyncUrllastDeployFailedLabnamestartTime, endTimeinstanceNameBind filerelative path, contentInstancestatedeployed, recoveredin memoryNodestate, IPscontainerIdin memoryUsersub, namegroupsfrom logincontainsdeployshas0 or 1while deployed1..ngroup names = collection names
Antimony's domain. Collections, topologies, bind files, labs and users are stored; instances and nodes (dashed) only exist while the server runs and are rebuilt when it starts.