Skip to content

Commit

Permalink
doc: update beacon metadata extension docs
Browse files Browse the repository at this point in the history
Update beacon metadata docs after various changes to the implementation,
in particular changes done to the data representation when converting the
beacon extension to protobuf/gRPC.

Rewrite parts of the introduction, add (better) illustrations for the data included in the beacons.
The new figures were created with draw.io, the source file is `beacon-metadata.xml`.

[doc]

Closes #3963

GitOrigin-RevId: 340e0d44624898b31071214ab6d727674a897352
  • Loading branch information
matzf authored and lukedirtwalker committed Feb 9, 2021
1 parent d69b5e8 commit e842d91
Show file tree
Hide file tree
Showing 15 changed files with 497 additions and 750 deletions.
747 changes: 0 additions & 747 deletions doc/BeaconExtensions.md

This file was deleted.

493 changes: 493 additions & 0 deletions doc/beacon-metadata.rst

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions doc/conf.py
Expand Up @@ -19,8 +19,8 @@
# -- Project information -----------------------------------------------------

project = 'SCION'
copyright = '2020, Anapaya Systems'
author = 'Anapaya Systems'
copyright = '2021, Anapaya Systems, ETH Zurich'
author = 'Anapaya Systems, ETH Zurich'


# -- General configuration ---------------------------------------------------
Expand Down
Binary file added doc/fig/beacon_metadata/beacon-metadata-peer.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions doc/fig/beacon_metadata/beacon-metadata.xml
@@ -0,0 +1 @@
<mxfile host="app.diagrams.net" modified="2021-01-06T15:08:16.235Z" agent="5.0 (X11)" etag="8trYryCwsUKOe7TCQvQQ" version="14.1.8" type="device" pages="4"><diagram id="fZXJXOq7JiPZlpDjx5MT" name="topo">7VpLk5s4EP41Po4LSTzMMbYzk1QltdmdqmzmSEC2VcHIK8uv+fUrgQAhsIdx7IE48cFFt6QW6v66pW40QJPl/oEFq8VnGuF4AK1oP0DTAYS+Y4l/yThkDMcBGWPOSJSxNMYjecaKqcbNNyTC60pHTmnMyarKDGmS4JBXeAFjdFftNqNxddZVMMc1xmMYxHXuvyTii4w7ypcl+R8wmS/ymYGlWpZB3lkx1osgojuNhd4P0IRRyrOn5X6CY6m7XC/ZuPsjrcWLMZzwNgO2/uNs/3H07D08/PV3+OHraPr9052Ssg3ijVqwell+yDUgpAhlC2K8WxCOH1dBKFt2wtyCt+DLWFBAPAbrVWaBGdljMem4WLEliR+Yh4uc4Iz+KBQKC86ExpSl0yI3/YmWOQsiItY4JUyIJzQR7QllcuR4RhOujcl+2hitbZb+5BgSxxp/kv4EX2kCM473R1UMCsMJwGO6xJwdRJd8QG5rBXZbkTsNOYq10ECT8wKF1XkhuDSneFAWfYV14TWtewl9WVV9Abdjhdk9V5hd1VehiK705fRcXwWg+qIw90+8vWC8RW6/4q3Xc3ewYc/i7aiFwpLonTzHCYqKflUl4T3h37TnJ4n3oaOo6V7BPyUOOZGIN/+mE9ooSZbDUioft+YB48arpLx7Ehfvk0QaFW7YVpouJbKF4ah23DSMJxZPNyzELx/axNxzzF8KNnUwaMZ2Goyd8xiOA0621ddtQoCa4QslYiGlb/pG6PUNEGXLVKP0c6shyDY3PdsQlOmhJkiYKjho3Vayw/r4CxcoV/N4leO0eMgElmAvVHo+/vMs56cdoAT9k9bykgOUmH+qQP5SDtAB5mGXmC+yVgWhcyGPvNNyjiD+YqhskxW2QyV0USU0+wXdNTbltF8wI0JZmCkpF8QrbIlXu0u8AgNnAJ0JWOAYgrw3RmybTPcUYs/Az5lILX3Dc0zfOO0a/QCs0ylgIRh6wPHgyHOgg7yRVz0aoNEQjmzoAWh7tivwfB6cXzq6XBvNbcoQ7eKv53tVjNn+7xF/3ZZw9v7E30sgtu+FIPNw33khCLSpBLXzcdvyNR8HQwuMbs7HE/i8d5/uV/8Ek/novzu4+vr5vnVOADrds2wjKQCue56T28ipYtgyBF3byevVGmDltipRK5yUm4crvdaY0AQbZUHFCmIyl9XGUCBB4mUsXZ6EQfxONSxJFMXHIgijmyRKyy3WZWKGcQooPlZosLEbYAOvFjL8hpDhxlLZEdmKx7l8BBJuGVfMojXcrqGMXbSwQFeGygXrjgJu2FGMAIcayvBvq/+m+kWDo8DfzVGK82VvLFXP2+EtbykI9WxPgahugOLCyi0awEc92yvquT685b0COt2FoFNJRG8zV9ThHZlGhdVDdl1hLT8OwGptCrX+buUCV89c76yhBS///TYdb+avb1+3Og7bzlLaap01T0xyhILG1lenu2Zx7Ho1rUYN1ws0xUH3ZGBuH3AZXpPn4HsqSsJIfaEWcp3xwJlKWRtO19mdWHCh+NthstSo5jZ3Zspwoja1KFgvipsV+qZYuQFVufT01tdFrnX5A/4KAQKZuzww4NM6CBi7H3TbBYFXX/4wLpkA/6dufwiyvNiddS9vx6P3/wM=</diagram><diagram name="up-core-down" id="_wcD5pG9QNr8s24kN10A">7V3LcqM4FP0aL5NCEs9l5zXZTE1qMlXTvaQNsakmkMEkcfrrRzwE0sWJBUYgx/GiC12QAOmc+9IlvSCXj9s/Mv9p/WcahPECG8F2Qa4WGDuuQ/8tBG+VwLRqwSqLgkqEWsF99DushUYtfY6CcCNcmKdpnEdPonCZJkm4zAWZn2Xpq3jZQxqLd33yV2FHcL/046703yjI15XUtYxWfhtGqzW7MzLqM48+u7gWbNZ+kL5yInK9IJdZmubV0eP2MoyLuWPzsv7LRy+X//x9e729uSXr19//RWdn1WA3fbo0r5CFST7u0Lga+sWPn+v5qt81f2MTSEeha0UbF6/rKA/vn/xlceaVooXK1vljTFuIHvqbp2oBH6JtSG960UyYUTR+hflyzRp5lv5q1gM3kss0TrPytsQuf/TMKvODiL74VZTR4aM0oeeTNCt6XjykSc71qX5cH+7cQ/kr+kRxzMkvyx+V1zMRZnm4BdDZM++oAQMlUZg+hnn2RvuxURh+GIHq5iuHxlq05oDIZH6N/1UzcLvG9KBe5h5LTlQuubJJNMRJRPbMs2ge4yya4iQ2szPXJFrHOIkN9HSZRftLh6vW4cTWS4c7x0gcE2umw12JWUyCb4UTSlspvU6cuXAb5d+54x8FM86tunW1rYlSNt5YI6FP/p1vcL2KZtutbLF+m9zPcvAopewmipvnSQKutXzOXor1LBvVi4VBx1eWWVE6I+lztgz3+5H0gVbhR+PZuxHCIcDagQAmy8LYz6MX8R12waK+w10a0bdrWewBze0BZFWvWffiXWkwkAkNqQkGquahMxBdP/+Nu+ypuGDz/gM30K/v4wgePj2oBmwZ0EzpcFJ4I5GiJcIP7sw+UrQ8+CHQYCxS6MIDMicPmti8htVQGhDn43HeYcFYSGVvMQJUsU0EHe417bkBW9z2LswiOllhVo+iGsREEsTmnCBGAHyIDEQxssBAzsQwRgfCeACoBsK3JYxjQcJ8zBeNUWzNimKMzh1kOdh1LGyRJtvKHAvinmPXxA7CpmPaFOTDML7P8VENcTyapnY8RwSe6Z2wprYlMe58aeoxYHyUqVMYRMyer0IyuVM5bWAaHqcN0LmB3BPWBmwe96oDNGv4YYLwA9n2MH1gEktEtgEGUq0PuvlrZLDFarFM+ZxDj41PlCZpEoKcZi3y42hVpEqXFB8Fii4K7RAt/fhbfeIxCoL4PWWTpc9JUGaADIXqBbgWzUYNhyVzB5awMu2yKx1ux8UKBNELPVwVh6jAYCWld+FOnNjqAdPcLMtsq9fNbCN0apQC+pHs2G2YdlF2Jcp3UAp/UWrBubfaLF83pYtPzkwRopmdYgPzq9JUGp3MqnhEL/uDu8k4fHL2B1uaaTAW2BxX4E10q1nCMvkLyQ0TLGbhiPQGn41sPvI+M84NPP7md9kfxt86Z+iqpZgtJBfzzMxjYMBFO8/2DtdhHnDi9B3u5p0aV/tD3S6vs7NwE/32f5ZDFeiqN/jpuNbFwroqxnrO001VJI1UqnDdAjssU+vX0T2Bv1k3NSy8tRWq0oRCtKkLc4QyG/0KEmR3webVPwR6HAjgUFrHAJuLbTkd07syB1QAIW+C0hwsU+nZcqj2ODnagLLJwA/dh2XHeS0KN5du+PNBsPgDqnnQIUxipaaow/BinHoZmTEvvL0oWbHLK7C8c5JXHQexb7b9NFCMiqDSliULBmSBjudIXIH7f5NQRaZCdn6qzAB5GRNVtutPudyTpwmCul6RTelsb5MpiNKvCFqeKFys6IBg0XL0IwVg9ZV5jW4Yj2epXJqvIskVPShijkQbyXCvN20YYptdYHMC2vQrkx5EG1iTqiNtZGxJH2qNanlOhmrvVfiMzDRYRWhNQDQik/odQjS9rEybH/U8F4RN5r7AaWeyU0idFI07P6dnk1JS6MiDyaX3Rw7ws+vONzrSdgym0gxFdoxBnd0HTUGvflsCPexYi2gHANoz9UsE7KHmF7kgucC+LavE600uaFNg4m8scpmAXHgKcvUrdNXcdg1w9a6/2Rfl998HkWG2pDRIIECvSjrNhj4eZ6yUNLBT9gTZA6IqDNLBBBBi28bRZokJCArQ0C0VYou6XhF84fNOkSVmLuHngG//vK4iyMuWRWhDjaEfJMFtS1WZYWiJJskMM4/pM5CDj0ZsGI7sLT/aGQK8zx0NggO96DXY8rii5UGKIm9YNMDuo5ZeqiJvHVynJnpWzYXZAmCYcoXQlA4OYACsCOMY1r+7U2D85ALgPf6V51wZjnOsoIffUAxOqRJWiql4w6JznyliYlNVlZYOir0B8GdV7ONhHFYiKlLsnQdGU2BcVXmVVhjnv1ogYtBgkOaCPkHDQZTQv4p3NO6gibhjzcEdVRVXenGH1bEs5Evw1QfOkn9CYy4CdYKBwSWLU0UVpuhgIe+gbTXabP+cfnV5+38SkOv/AQ==</diagram><diagram name="peer" id="lEfZrgkP7ObyzS_1qvXe">7V1bV6s4FP41fdRFEq6PanVmHlzjjLPWHOeNU2LLOhRclGr110+4BJJNtQG51dqHs8iGBEi+b9+y8czI1Xr3W+w+rW4jjwYzrHm7GZnPMDYNk/2bCl5zAbG1XLCMfS8XoUpw77/RQsgv2/oe3UgXJlEUJP6TLFxEYUgXiSRz4zh6kS97jAL5rk/uktYE9ws3qEv/9b1klUttQ6vkv1N/ueJ3RlpxZu3yiwvBZuV60YsgItczchVHUZIfrXdXNEjnjs/L/Oyv6IFu72/P1trtn3+8/f2P8d9ZPthNky7lK8Q0TLodGudDP7vBtpiv4l2TVz6BbBS2Vqxx+bLyE3r/5C7SMy8MLUy2StYBayF26G6e8gV89HeU3fSynDAtbfyiyWLFG0kc/SrXA5eSqyiI4uy2xMx+7Mwydj2fvfjcj9nwfhSy82EUpz0vH6MwEfrkP6GPcO4x+6V9/CAQ5FfZj8mLmaBxQncAOgfmHZVgYCSi0Zom8Svrx0fh+CkIpBfNFwGNhWglAJHL3AL/y3Lgao3ZQbHMDZac9LnkvU2iJk8iMkeeRf0YZ1GXJ7GcnbEm0TjGSSyhN5VZNL91eN86nJjT0uHWMRJHxxPT4bbCLIbeReqEslbErpNnju785Idw/JAy49woWvNdQZSs8cobIXvyH2JD6JU2q25Zi/fbJG6cgEfJZDd+UD5P6AmtxTZ+Ttcza+QvRr2ar6yyomxGom28oIf9SPZAS/rReOZ+hAgIMPYggMtiGriJ/yy/wz5YFHe4i3z2dhWLHaC5HYCs/DWLXqIrDQbSoSHVwUD5PNQGYuvnvgqXPaUXbN5/4BL6xX0sycNnB/mAFQPKKW1PCqcjUlREeBDOHCJFxYMHiQZdkWIqPCBj8qCMzQtYtaUBsT4e5x0WdIVU/hYdQBWbRNLhTtkeG7Dpbe9o7LPJonExSt8gJoog1scEMQLgQ6QlipEBBrIGhjH6JIxbgKolfCvCWAYkzMd8mTCKjVFRjNG5hQwL25aBDWLZluxYEPsc2zq2ENYt3WQgb4fxQ45P3xDHnWlqy7Fk4OnOCWtqUxHj1rem7gLGR5k6hUHE6PkqpJI7VdMGuuYI2gCda8g+YW3A5/GgOkCjhh86CD+QabbTBzoxZGRrYKC+9UE9f400vlgVlhmfE+ixiYnSMAopyGkWIjfwl2mqdMHwkaLoMtUO/sINLooTa9/zgveUTRxtQy/LAGk9qhfgWpQbNQKW9D1Ywr1pl33pcDNIV8Dzn9nhMj1EKQZzKbuLcOLEVg+Y5nJZRlu9emYboVOjFNCPZM9uw7CLsi9RvodS+JtSM8G9nczy1VO6+OTMFCETs1N8YHFVykqjk1kVh0zL/uB6Mg6fnP3BxsQ0GA9sjivwJlOrWcIq+QvFDRMsZ+GI8gafiUwx8j7TzjXc/eZ31h/G31PO0OVLMVpILueZucfAgYv2nm0crsM84MDpO1zPO5Wu9oe6XV1nx3Tjv7k/s6FSdBUb/Gxc43JmzNOxtkm0yYukUZ8qfGqBHVap9avpHs/drMoaFtHaSlVpUiHa0IU5UpnN9AoSVHfBxtU/BHocCOBQWccAm4tNNR3TuDIHVAAhZ4DSHKxS6VlxqPA4BdqAsknPpfbjoua8poWbC5v+fJQsfotqHvQZJvFSU1RjeDpOsYzcmKfenh8u+eU5WN45KaoOSb+kjTs3YT3CTII1/bMEHW3LDdSrIqjXVfmEAZ+gb9oRneAW4SBsUimiHZ9NI7BCxYpl7eJrL/ubSQqb19Bi9GSZapvkZAguNSulVueSEHFaIOQ0rOnxBhB/rl+jG051GHn2zRhV53C80idbdtWI3hGzFOPKxszioC63m/UBmNWsHrsVs2Dx6xSZpWKRmrAP2q9vqqlQ7b1Soo6ZBssVjQGIxveHOifatAxRlYh1HBvEZ/qhCG1vVvWTzJn2pxLw4+3alz7KRgom5LSejBQBRgoNwZ1mJewNjFQFVwug1dGnl044wLsPPcAvTiOwz8sr9xrTCJoGmCjsikY6oBEegkb4K5mgFh7b9YV5mX0v/lWzCfA7cug/Kafl0MfjdJXlBkbLHCCVQJptUk+cBADghJim9pUTzwRECKjtRg4xZYvRE8Lh8w6ReObB19dAePNU8XisUK3XmAx72n4pBfdT+0o2Q3s2SLKZNCslmDR/xADHhBHOwbqovVHFmPSa+N//6Mw42bJxQj0F87Cagd+nX3r1VWUwBQesDMiP0rtCMP8KcaccP8AwuicAY1h1bw8B4L429o/Vv3KsuWZZxwp6+OVG6xQs4QWgPe9e1O4zSNjc1w78FLT2N4DzgWBxY09au/bAaAgA97XRPSkAix9CENnd10h5QRN3fwJOfb5Sx08vNBC9jBHoxSfli9OLF7XM1Av/P8kOxb/KMRY7ap5+6/rFoUIGXfaekPOpnTfWrP5Cf3559d8ckOv/AQ==</diagram><diagram name="shortcut" id="b54VydfRmdqssGxyhgpT">7Vxbc5s6EP41fkwGSVwfGydpz7RnJjM5Z9o8UqPYtBhyME6c/vojQAKxOLEg3GLHDxm0IAGr79tdrZbMyHy9+xy7D6u/I48GM6x5uxm5nGFs2Rb7mwqec4FucMEy9r1chErBrf+HcqHGpVvfo5vKhUkUBYn/UBUuojCki6Qic+M4eqpedh8F1bs+uEtaE9wu3KAu/e57ySqX2oZWyr9Qf7kSd0YaP7N2xcVcsFm5XvQkicjVjMzjKEryo/VuToNUd0Iv8Rf61+Ovq8SO59+/ft5chP+u5mf5YNdNuhSvENMw6XZonA/96AZbri/+rsmzUCAbhc0Va1w8rfyE3j64i/TME0MLk62SdcBaiB26m4d8Au/9HWU3vSgUpqWN3zRZrEQjiaPfxXzgQjKPgijObkvM7MfOLGPX89mLX/oxG96PQnY+jOK058V9FCZSn/wn9ZHO3We/tI8fBJJ8nv2YnGuCxgndAegc0DsqwMBIRKM1TeJn1k+MIvAjCMSbTxIauWglAVHIXI7/ZTFwOcfsgE9zgyknfU55b0rUqkpE5sha1N+jFvWqEgvtjKVE4z0qsYDeVLRo9mrDG1jqNtb4Ves+sKUm5rQstfUe6aHjiVlqW0GLofcpDTVZK2LXVTVHd37yQzq+S2OYc4O3Lnc8pMkaz6IRsif/ITekXmmz7Ja1RL9N4sYJeJRMdu0HxfOEntRabOPHdD6zRv5i1KtFxCozyjQSbeMFPRwtsgda0tfGM/cjREKAsQcBQhbTwE38x+o77IMFv8NN5LO3K1nsAPvsAGTlr8l7yQEzGEiH7lIHA+V6qA3E5s99li57SC/YvPzABfT5faxKHM8O8gFLBhQqbU8KpyNSlES4k84cIkXJg7sKDboixVR4QMbkQbEC57BqSwNivT7OCyzoCqniLTqAKjZJxYY7RXtswKa3vaGxz5RFYz5K3yAmiiDWxwQxAuBDpCWKkQEGsgaGMXojjFuAqiV8S8JYBiTM63yZMIqNUVGM0bmFDAvbloENUuRURWBB7HNs69hCWLd0k4G8HcYPBT59Qxx3Zqktx6oCT3dO2FKbihi3Pix1FzB+lwlSuIgYPSuFVDKkatZA1xzJGqBzDdknbA2EHg+aAzTq8kMHyw9kmu3sgU6MKrI1MFDf9qCepUaamKwSy4zPCYzY5ERpGIUU5DS5yA38ZZr2XDB8pCi6SK2Dv3CDT/zE2ve84CVjE0fb0MsyQFqP5gWEFsV2jIQlfQ+WcG/WZV/S2wzSGfD8R3a4TA9RisFcyu4inTix2QOuuZiW0WavntlG6NQoBewj2bPbMOyk7EuU76EU/qDUTApvJzN99ZQuPjk3RcjE/JQYWJ6Vop7oZGbFIdPyP7iejMMn53+wMTELJhY272vhTaZWmYRV8heKGya4moUjyht8JjLllfeZdq7h7je/s/5w/T3lDF0+FaMtyat5ZhExCOCivWcbL9dhHnDg9B2u552KUPtV265us2O68f+4P7OhUnTxDX42rnExMy7TsbZJtMlLoVGPtmdyCzusUtFXsz2eu1kVNSyyt63UD1cK0YYuzKmU2UyvIEF1F2xc+0NgxIEADpVtDPC52FSzMY0rc0AFEHIGKM3BKvWcJYd4xCnRBpRNei617xe14DUt3FzY9Od9xeO3qOZBb2GS+CgA1RiejsOnUTjzNNrzw6W4PAfLCydl01GxL2njxk1YjzCTYE1/K0FH23ID9aoI2nVVPmHAJxibdkQnuEU4CJtUimjHZ9MIrFDxYlmbf9NlfzBJYfMaeoyePFNtk5wMwaVmpdTqXJJWnBZYchrW9HgDiH+pX6FrQXW48uybMarB4XilT3Y1VCN6R8xSXFc2ZpYAdbHdrA/ArGb12K2YBYtfp8gsFY/UhH3Qf31QTYVqL5USdcw0WK5oDEA0sT/UOdGm5YjKRKzj2GB9ph9aoe3Nqvbvx6b9NQX8irv2MZCyH4M5O60nP0aAH0ND0KtZlXsDP1Yi2gKAdvTpZRwOULPj7YmpMwfs/op6vsbMgQ4Dpg+7Yo4OmIOHYE5fWb9Jof9o8wcwZIJGXTkTBzHek3fAsFDGHiB/oPfuHY4iF12jDyGmqQ3hJ/CoHOosm33gw9fGFOp6i1r4l+Ow9b1kkdt/wjEWd8aNsTrLX7f8+KpxjAUfWB/C/zSrjDo63tXI4ViXmmW926AL/iOmtktyuP3Z2/4njBKNbkHvbr/69q+7f56X357+W66/OavF9VlfMdfYmOdPKmN+X8b3Zcwf7VqkK1oMtpcJKwY7rgvYS4tjDcE+aKFKi9bfpx9a6/flLbQBaHGsEdIHLfrOXMHvIHrLXHVbk8ma5X9wzi8v/w02ufof</diagram></mxfile>
File renamed without changes
Binary file added doc/fig/beacon_metadata/path_combinations.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed doc/fig/inter_vs_intra_metrics.png
Binary file not shown.
Binary file removed doc/fig/metrics_summary.png
Binary file not shown.
Binary file removed doc/fig/normal_paths_with_labels.png
Binary file not shown.
Binary file removed doc/fig/peering_paths_with_labels.png
Binary file not shown.
Binary file removed doc/fig/shortcut_paths_with_labels.png
Binary file not shown.
2 changes: 1 addition & 1 deletion doc/index.rst
Expand Up @@ -14,7 +14,7 @@ is a good place to start.
protocols/index
testing/index
BeaconService
BeaconExtensions
beacon-metadata
PathService
PathPolicy
hidden-paths
Expand Down

0 comments on commit e842d91

Please sign in to comment.