Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation for extended link format is erroneous #1643

Closed
pdumais opened this issue Oct 14, 2023 · 1 comment
Closed

Documentation for extended link format is erroneous #1643

pdumais opened this issue Oct 14, 2023 · 1 comment
Labels
bug Something isn't working fix available

Comments

@pdumais
Copy link
Contributor

pdumais commented Oct 14, 2023

In https://containerlab.dev/manual/topo-def-file/#macvlan, it is shown:

 links:
  - type: macvlan
    endpoint:
      - node: <NodeA-Name>                  # mandatory
        interface: <NodeA-Interface-Name>   # mandatory
        mac: <NodeA-Interface-Mac>          # optional
    host-interface: <interface-name>        # mandatory
    mode: <macvlan-mode>                    # optional ("bridge" by default)
    vars: <link-variables>                  # optional (used in templating)
    labels: <link-labels>                   # optional (used in templating)

But The node under the endpoint is not a list. Defining it as a list makes clab throw an error: cannot unmarshal !!seq into links.EndpointRaw

It does work if defining as:

 links:
  - type: macvlan
    endpoint:
        node: <NodeA-Name>                  # mandatory
        interface: <NodeA-Interface-Name>   # mandatory
        mac: <NodeA-Interface-Mac>          # optional
    host-interface: <interface-name>        # mandatory
    mode: <macvlan-mode>                    # optional ("bridge" by default)
    vars: <link-variables>                  # optional (used in templating)
    labels: <link-labels>                   # optional (used in templating)
@steiler
Copy link
Collaborator

steiler commented Oct 16, 2023

thats a copy-paste issue.
Thanks for reporting.

@steiler steiler added bug Something isn't working fix available labels Oct 16, 2023
@hellt hellt closed this as completed Oct 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working fix available
Projects
None yet
Development

No branches or pull requests

3 participants