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

doc: add some diagrams #4678

Merged
merged 8 commits into from
Jan 21, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions doc/data-plane.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,5 @@ Data Plane
protocols/authenticator-option
protocols/bfd
protocols/assigned-protocol-numbers
protocols/stack

Binary file added doc/fig/overview-topology.excalidraw.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
26 changes: 25 additions & 1 deletion doc/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,31 @@ There are three types of links between ASes in SCION:
- A **peering link** also includes at least one non-core AS. The ASes may be in different ISDs.
Peering links are only available for use by children (direct or indirect) of the two linked ASes.

Topology summary
^^^^^^^^^^^^^^^^

The following diagram provides a visual summary of the topology of a SCION network.

.. figure:: fig/overview-topology.excalidraw.png

Core links (in bright red) connect core ASes, thereby providing inter-ISD connectivity. Intra ISD
links (in green) connect ASes within an ISD. AS-internal networks (in blue) connect the various
hosts within an AS (including border routers). Peering links (in purple) provide restricted use
shortcuts between ISDs.

This diagram attempts to illustrate the variety of valid configurations. For example, notice that:

- There may be multiple core ASes per ISD.
- There may be connections between a non-core AS and multiple core-ASes.
- There may be multiple connections between any two ASes.
- There may be multiple border routers per AS.
- There may be any number of end-hosts (includng none) in an AS.
- Border routers need not be dedicated to one particular kind of links.
- Excludig core links, the ASes within an ISD form a directed acyclic graph (no other constraint).
- The core ASes themselves form an arbitrary graph.

The dark red dashed arrows show examples of possible paths through the network.

Routing
^^^^^^^

Expand All @@ -123,7 +148,6 @@ The process of creating an end-to-end forwarding path consists of the following

.. figure:: fig/overview-routing.excalidraw.png


.. seealso::

:doc:`control-plane`
Expand Down
Binary file added doc/protocols/fig/stack.excalidraw.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 9 additions & 0 deletions doc/protocols/stack.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
********************
SCION Protocol Stack
********************

.. _stack:

This document provides a visual summary of the SCION overall protocol stack.

.. figure:: fig/stack.excalidraw.png
Loading