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.

Sign up for GitHub

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

topology: document topogen config file #4701

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

topology: document topogen config file #4701

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 40 additions & 11 deletions topology/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,30 +2,59 @@

Brief description of sections in .topo files

## Table of Contents

- [ASes Section](#ases-section)
- [Links Section](#links-section)
- [Examples](#examples)

## ASes Section

The 'ASes' section describes all the ASes in a topology.
You can specify different attributes like Core, MTU, certificate issuer and number
of services among other things.

The 'links' section describes the links between the BRs of different ASes.
**Supported attributes:**

When defining the links in .topo files, we can specify whether the new interface
for the link should belong to an existing BR or a new one. This is achieved with
an optional ID in the BR name of a link entry.
- "core" -- boolean, whether the AS is a core AS
- "issuing" -- boolean, whether the AS is an issuing AS
- "underlay" -- default is UDP/IPv4, can be set to UDP/IPv6
- "cert_issuer" -- string, the issuer IA of the CA. This attribute is necessary if AS is not issuing.
- "MTU" -- integer, the internal MTU of the AS

Without an ID, a new BR with a single interface is created.
When an ID is specified, the interface is added to the BR with such ID.
## Links Section

NOTE that the IDs in the .topo files do not correspond to the element ID of the
BRs in the final generated topology. The order of the links is what determines
the element ID.
The 'links' section describes the links between the BRs of different ASes.

Consider the following example:

- {a: "1-ff00:0:110", b: "1-ff00:0:120-1", linkAtoB: CORE}
- {a: "1-ff00:0:120-1", b: "1-ff00:0:130", linkAtoB: CORE}
```yaml
links:
- {a: "1-ff00:0:110", b: "1-ff00:0:120-1", linkAtoB: CORE}
- {a: "1-ff00:0:120-1", b: "1-ff00:0:130", linkAtoB: CORE, mtu: 1280}
```

In the example above, two links are defined resulting in:

- BR 1-ff00:0:110 with a single interface
- BR 1-ff00:0:120 with multiple interfaces
- BR 1-ff00:0:130 with a single interface

**Supported attributes:**

- "a" -- string, mandatory, see above
- "b" -- string, mandatory, see above
- "linkAtoB" -- string, mandatory, the type of link, can be CORE, PEER, CHILD
- "mtu" -- integer, the MTU of the link

## Examples

This is a list of examples:

- [tiny.topo](tiny.topo): A simple topology with 3 ASes and 2 links.
- [tiny4.topo](tiny4.topo): same topology as tiny.topo but using IPv4.
- [wide.topo](wide.topo)
- [default.topo](default.topo)
- [default-no-peers.topo](default-no-peers.topo)
- [peering-test.topo](peering-test.topo): example with one peering link
- [peering-test-multi.topo](peering-test-multi.topo): example with multiple peering links
Loading