Skip to content

Module System

Jump to bottom
sat edited this page Jan 3, 2026 · 3 revisions

Module System

This page explains how to use modules in dot2net.

Overview

Modules extend dot2net with platform-specific functionality. Loading a module adds:

  • File definitions - Platform-specific output files (e.g., topo.yaml, spec.yaml)
  • FormatStyles - Pre-defined formatting rules for specific config formats
  • Internal classes - Network/node/interface classes for platform integration
  • Requirements - Expected config blocks or parameters from user configuration

Loading Modules

Modules are loaded via the module section in YAML configuration:

module:
  - containerlab
  - frr

What Happens When a Module is Loaded

1. File Definitions Are Added

Each module defines its output files. For example:

Module File Description
containerlab topo.yaml Containerlab topology file
tinet spec.yaml TiNET specification file

These files are generated automatically based on the network model.

2. FormatStyles Become Available

Modules may provide FormatStyles for specific configuration formats:

# FRR module provides these FormatStyles
interfaceclass:
  - name: ospf
    config:
      - name: ospf_config
        format: frrVtysh      # Provided by frr module
        template:
          - "router ospf"
          - " network {{ .ip_network }} area 0"
Module FormatStyles
frr frrVtysh, frrDaemons, frrVtyshConf
containerlab clabCmd
tinet tinetSpecCmd

3. Requirements Are Established

Modules may require specific config blocks or parameters:

Module Required Parameters Required Config Blocks
containerlab image, kind startup (optional)
tinet image startup (optional)
frr - -

If requirements are not met, dot2net reports an error.

Combining Modules

Multiple modules can be loaded together. Each module's files are generated simultaneously:

module:
  - containerlab    # Generates topo.yaml
  - frr             # Provides FormatStyles for FRR config

This generates:

  • topo.yaml - Containerlab topology with node definitions
  • r1/frr.conf, r2/frr.conf - FRR configuration files (user-defined)

Example: Containerlab + FRR

module:
  - containerlab
  - frr

file:
  - name: frr.conf
    path: /etc/frr/frr.conf

nodeclass:
  - name: router
    values:
      image: quay.io/frrouting/frr:8.5.0
      kind: linux
    config:
      - file: frr.conf
        format: frrVtysh        # From frr module
        template:
          - "hostname {{ .name }}"
          - "!"

      - name: startup
        template:
          - "vtysh -b"

Result:

output/
├── topo.yaml           # From containerlab module
├── r1/
│   └── frr.conf        # User-defined, formatted with frrVtysh
└── r2/
    └── frr.conf

Available Modules

Module Purpose Documentation
containerlab Containerlab topology generation Module: Containerlab
tinet TiNET specification generation Module: TiNET
frr FRR configuration FormatStyles Module: FRR

See Also

Clone this wiki locally