ContainerLab yaml file with absolute paths can be problematic

[italovalcy]

The CLab yaml file with absolute directory paths can be very problematic, resulting on the message below while trying to create a new CLab:

Example:

> tree .
.
├── README.md
├── configs
│   ├── client.sh
│   ├── default.yml
│   ├── nodes.yml
│   ├── single-tag-10.yml
│   ├── single-tag-range-10-15.yml
│   ├── srl.cfg
│   └── untagged.yml
├── ping.sh
├── set-iface.sh
└── vlan.clab.yml

2 directories, 11 files
> cat vlan.clab.yml
name: vlan

topology:
  nodes:
    srl1:
      kind: nokia_srlinux
      image: ghcr.io/nokia/srlinux:24.10.1
      startup-config: /home/users/fulano/srlinux-vlan-handling-lab/configs/srl.cfg

    srl2:
      kind: nokia_srlinux
      image: ghcr.io/nokia/srlinux:24.10.1
      startup-config: /home/users/fulano/srlinux-vlan-handling-lab/configs/srl.cfg

    client1:
      kind: linux
      image: ghcr.io/srl-labs/alpine
      binds:
        - /home/users/fulano/srlinux-vlan-handling-lab/configs/client.sh:/config.sh
      exec:
        - "ash -c '/config.sh 1'"

    client2:
      kind: linux
      image: ghcr.io/srl-labs/alpine
      binds:
        - /home/users/fulano/srlinux-vlan-handling-lab/configs/client.sh:/config.sh
      exec:
        - "ash -c '/config.sh 2'"

  links:
    # links between client1 and srl1
    - endpoints: [client1:eth1, srl1:e1-1]

    # inter-switch link
    - endpoints: [srl1:e1-10, srl2:e1-10]

    # links between client2 and srl2
    - endpoints: [srl2:e1-1, client2:eth1]

[italovalcy]

Looking into how clabverter loads the files (startup-files and then binds), we can see that it utilizes a function that prepend the full path to begin of the file:

https://github.com/srl-labs/clabernetes/blob/19c2e86dad4fd5d916e5966847855583f38ad42b/clabverter/clabverter.go#L254-L288

We should be aware of this behaving when implementing our methodology.

Also interesting to see that it allows remove files (likely from GitHub)