document virtual externals #105
Conversation
add a note about hw annotations for VLABs fix a typo in the external example and remove state metadata Signed-off-by: Emanuele Di Pascale <[email protected]>
autogenerated topologies were not up-to-date, i.e. they did not account for the default ESLAG nodes. also add the virtual external that is currently created by default. Signed-off-by: Emanuele Di Pascale <[email protected]>
|
🚀 Deployed on https://preview-105--hedgehog-docs.netlify.app |
| metadata: | ||
| name: default--5835 | ||
| annotations: | ||
| type.hhfab.githedgehog.com: hw # Tells Fabric that this is a physical device |
There was a problem hiding this comment.
there is no need to mention this annotation - it's only used for the hybrid vlab which isn't documented in public docs anyways
There was a problem hiding this comment.
OK, but this documentation is not only public facing, it's also the first reference for us internally. I expect a new hire to look at this for guidance, and without these annotations hhfab vlab up will fail on start in an hybrid vlab, so isn't it worth documenting?
There was a problem hiding this comment.
if we're documenting hybrid vlab it should be clearly separate from any other docs as it's a unique case only for the hybrid vlab. maybe we can introduce a separate section about it
| ``` | ||
| !!! note | ||
| In a [VLAB](../vlab/overview.md) environment only, if the `hw` type annotation is not included, Fabric will emulate this external with an FRR VM. |
There was a problem hiding this comment.
no need for the note, same reason
add information about the virtual externals and update some outdated info re autogenerated topologies + resources required.