Labs Section¶

Defines network labs. Each lab contains network nodes and links.

Warning

docker compose 2.36.0 or later requred

Example:

labs:
  lab1:
    pool: test
    nodes:
      r1:
        type: vyos
        version: 1.4
        router-id: 10.0.0.1
      r2:
        type: vyos
        version: 1.4
        router-id: 10.0.0.2
    links:
      - prefix: 10.0.1.0/30
        node-a: r1
        node-b: r2
        protocols:
          isis:
            metric: 1000

lab1 is the lab name. A configuration file can define multiple labs.

pool¶

If lab is attached to dedicated pool, pool must refer to one of pools. If pool is set, one of the nodes must be designated as pool-gw

labs:
  lab1:
    pool: test

nodes¶

Defines the list of nodes in the lab. Node names are used as keys.

labs:
  lab1:
    nodes:
      r1:
        type: vyos
        version: 1.4
        router-id: 10.0.0.1
      r2:
        type: vyos
        version: 1.4
        router-id: 10.0.0.2

type¶

Specifies the node type. Supported values:

vyos — VyOS virtual router.

Example:

labs:
  lab1:
    nodes:
      r1:
        type: vyos

version¶

Image version for the node.

Type	Version
vyos	1.4

Example:

labs:
  lab1:
    nodes:
      r1:
        type: vyos
        version: "1.4"

router-id¶

Specifies the router ID, assigned to the loopback interface.

labs:
  lab1:
    nodes:
      r1:
        router-id: 10.0.0.1

pool-gw¶

Node will serve as designated gateway to pools. Only one node of lab may be marked as pool-gw.

labs:
  lab1:
    nodes:
      r1:
        pool-gw: true

users¶

List of user credentials

labs:
  lab1:
    nodes:
      r1:
        users:
          - user: user1
            password: secret1

user¶

User name.

labs:
  lab1:
    nodes:
      r1:
        users:
          - user: user1

password¶

Plaintext password.

labs:
  lab1:
    nodes:
      r1:
        users:
          - password: secret1

snmp¶

Set up snmp credentials. Contains a list of items.

labs:
  lab1:
    nodes:
      r1:
        snmp:
          - version: v2c
            community: public

version¶

SNMP protocol version. Following versions are supported:

v2c

community¶

SNMP community for SNMP v2c. Requred, when version is set to v2c.

links¶

Defines the connections between nodes. Each link is described as an item in the list.

labs:
  lab1:
    links:
      - prefix: 10.0.1.0/30
        node-a: r1
        node-b: r2
        protocols:
          isis:
            metric: 1000

prefix¶

Network prefix used for the link, typically a /30 subnet.

labs:
  lab1:
    links:
      - prefix: 10.0.1.0/30

node-a¶

Starting node of the link.

labs:
  lab1:
    links:
      - node-a: r1

node-b¶

Ending node of the link.

labs:
  lab1:
    links:
      - node-b: r2

protocols¶

Defines enabled protocols on the link.

labs:
  lab1:
    links:
      - protocols:
          isis:
            metric: 1000

isis¶

Enables the IS-IS protocol on the link.

labs:
  lab1:
    links:
      - prefix: 10.0.1.0/30
        node-a: r1
        node-b: r2
        protocols:
          isis:
            metric: 1000

metric¶

Optional IS-IS metric for the link.

labs:
  lab1:
    links:
      - protocols:
          isis:
            metric: 1000