Skip to content

Commit

Permalink
Add containerlab example (#870)
Browse files Browse the repository at this point in the history
Document a working containerlab + sros example. Adds defaults and node specific overrides.
  • Loading branch information
sdktr authored Sep 8, 2023
1 parent 985c297 commit 6db03ee
Showing 1 changed file with 21 additions and 1 deletion.
22 changes: 21 additions & 1 deletion docs/nodes.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,11 +106,31 @@ nodes:

### Containerlab Attributes

* **clab.kind** -- [containerlab device kind](https://containerlab.dev/manual/kinds/kinds/). Set in the system defaults for all supported devices.
* **clab.kind** -- [containerlab device kind](https://containerlab.dev/manual/kinds/). Set in the system defaults for all supported devices.
* **clab.type** -- device *type* when supported by containerlab (example: [SR Linux](https://containerlab.dev/manual/kinds/srl/#types))
* **clab.env** -- container environment variables. Used in system defaults to [set interface names for Arista cEOS](https://containerlab.dev/manual/kinds/ceos/#additional-interface-naming-considerations).
* **clab.license** -- license file needed for a network device running under containerlab. Used by Nokia SR OS.

For a full list of supported Containerlab attributes, have a look at [this definition](https://github.com/ipspace/netlab/blob/dev/netsim/providers/clab.yml#L22)) for the 'clab provider'.

Example Containerlab defaults and node specific overrides:
```yaml
---
defaults.devices.sros.clab:
image: vrnetlab/vr-sros:23.3.R3
mtu: 1500
node:
kind: vr-sros
type: ixr-ec
license: ../../sros/license-sros23.3.R3.txt

nodes:
e1:
mtu: 1400
clab:
type: sr-1
```
(node-augment)=
## Augmenting Node Data
Expand Down

0 comments on commit 6db03ee

Please sign in to comment.