doc: update beacon metadata extension docs #3963
Conversation
There was a problem hiding this comment.
Reviewable status: 0 of 15 files reviewed, 1 unresolved discussion (waiting on @matzf)
a discussion (no related file):
hi @matzf thanks for the PR, we currently have a few high prio tasks internally, so we will only be able to review this later, I estimate roughly in 1.5 weeks.
matzf
force-pushed
the
staticinfo-docs
branch
2 times, most recently
from
6050257
to
2ae8905
Compare
matzf
force-pushed
the
staticinfo-docs
branch
from
2ae8905
to
ea4457e
Compare
Fix the intra-AS metadata included for cross-over from up-segments to core-segments, to match the documented scheme (see scionproto#3963). Concretely, the core segments now contain no data for cross-over. Instead, the up/down segments now contain cross-over information to _all_ core interfaces (previously only a subset). Previously, core-segments were handled just like down segments, without taking into account that cross-over to the _ingress_ interface of the core-segment beacon also needs to be ensured; consequently, the data for the cross-over between the up- and core-segment was missing. Also, add some validation/convenience functionality for the configuration read from the staticInfoConfig.json file. Specifically, this extends missing information from the "Intra" sections to be symmetric (symmetry is an assumption of the system). Closes scionproto#3972 GitOrigin-RevId: d1cea6572623ea0f63ace7b7a9fc777dcf43d0ba
Fix the intra-AS metadata included for cross-over from up-segments to core-segments, to match the documented scheme (see scionproto#3963). Concretely, the core segments now contain no data for cross-over. Instead, the up/down segments now contain cross-over information to _all_ core interfaces (previously only a subset). Previously, core-segments were handled just like down segments, without taking into account that cross-over to the _ingress_ interface of the core-segment beacon also needs to be ensured; consequently, the data for the cross-over between the up- and core-segment was missing. Also, add some validation/convenience functionality for the configuration read from the staticInfoConfig.json file. Specifically, this extends missing information from the "Intra" sections to be symmetric (symmetry is an assumption of the system). Closes scionproto#3972 GitOrigin-RevId: d1cea6572623ea0f63ace7b7a9fc777dcf43d0ba
There was a problem hiding this comment.
Reviewed 14 of 15 files at r1, 1 of 1 files at r2.
Reviewable status: all files reviewed, 5 unresolved discussions (waiting on @matzf)
doc/beacon-metadata.rst, line 22 at r2 (raw file):
is typically this is on the order
is typically on the order
or
typically is on the order
doc/beacon-metadata.rst, line 46 at r2 (raw file):
end-end
end-to-end ?
doc/beacon-metadata.rst, line 47 at r2 (raw file):
corresponding
correspond
doc/beacon-metadata.rst, line 174 at r2 (raw file):
black list.
block list
doc/conf.py, line 22 at r2 (raw file):
2020
maybe also update that.
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`.
matzf
force-pushed
the
staticinfo-docs
branch
from
ea4457e
to
787a7c8
Compare
There was a problem hiding this comment.
Reviewable status: 13 of 15 files reviewed, 5 unresolved discussions (waiting on @lukedirtwalker)
doc/beacon-metadata.rst, line 22 at r2 (raw file):
Previously, lukedirtwalker (Lukas Vogel) wrote…
is typically this is on the orderis typically on the order
or
typically is on the order
Done.
doc/beacon-metadata.rst, line 46 at r2 (raw file):
Previously, lukedirtwalker (Lukas Vogel) wrote…
end-endend-to-end ?
Done.
doc/beacon-metadata.rst, line 47 at r2 (raw file):
Previously, lukedirtwalker (Lukas Vogel) wrote…
correspondingcorrespond
Done.
doc/beacon-metadata.rst, line 174 at r2 (raw file):
Previously, lukedirtwalker (Lukas Vogel) wrote…
black list.block list
Done.
doc/conf.py, line 22 at r2 (raw file):
Previously, lukedirtwalker (Lukas Vogel) wrote…
2020maybe also update that.
Done.
There was a problem hiding this comment.
Reviewed 2 of 2 files at r3.
Reviewable status:complete! all files reviewed, all discussions resolved
There was a problem hiding this comment.
Reviewable status:
a discussion (no related file):
Thanks, 
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
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 scionproto#3963 GitOrigin-RevId: 340e0d44624898b31071214ab6d727674a897352
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]
This change is