Damien/fabric-orchestrator
1
0
Fork 0
Code Issues 3 Pull Requests Actions Packages Projects 1 Releases Wiki Activity

[Phase 2] Define Infrahub Schema for EVPN-VXLAN Fabric #51

Merged
Damien merged 58 commits from feature/41-infrahub-schema into main 2026-02-13 19:36:27 +00:00
Conversation 0 Commits 58 Files Changed 11 +1855 -34
Damien commented 2026-02-13 19:25:36 +00:00
Owner
Copy Link

Summary

This PR introduces the complete Infrahub schema definition for modeling an Arista EVPN-VXLAN fabric, based on the overlaid.net reference topology (2 spines, 8 leafs in 4 MLAG pairs).

Changes

Schema files (schemas/)

  • base.yml — Core infrastructure: InfraDevice, InfraInterface (generic), InterfaceEthernet, InterfaceLoopback, InterfaceVlan, InterfaceVxlan, InterfacePortChannel, InfraIPAddress
  • bgp.yml — BGP stack: InfraBGPRouterConfig, InfraBGPPeerGroup, InfraBGPSession, InfraBGPAddressFamily
  • vlan_vxlan.yml — VLAN/VXLAN overlay: InfraVLAN, InfraVTEP, InfraVlanVniMapping, InfraEVPNInstance
  • vrf.yml — VRF/L3VNI: InfraVRFConfig, InfraRouteTarget
  • mlag.yml — MLAG domains: InfraMLAGDomain, InfraMLAGPeerConfig
  • extensions.yml — Topology helpers: InfraUnderlayLink, InfraFabric, InfraAutonomousSystem

Configuration

  • .infrahub.yml — Schema loading + menus
  • menus/fabric-menu.yml — UI navigation structure

Documentation

  • schemas/README.md — Complete ER diagram, node inventory, and topology mapping

Topology Coverage

The schema can model the complete reference topology:

  • 2 spines (AS 65000) + 8 leafs (AS 65001-65004)
  • 4 MLAG pairs with peer-link, iBGP, and dual-active detection
  • Underlay eBGP (point-to-point) + overlay EVPN (loopback-to-loopback)
  • L2VXLAN (VLAN-to-VNI) + L3VXLAN (VRF-to-VNI)
  • Anycast gateway with virtual-router addresses

Known Issues (tracked separately)

Les issues suivantes ont été identifiées et seront traitées dans des PRs ultérieures :

  • #43 — human_friendly_id non-unique sur BGPPeerGroup/BGPSession (🔴 critique)
  • #44 — Duplication InterfaceVxlan vs VTEP (🔴 critique)
  • #45 — Contrainte unique manquante sur InfraVLAN.vlan_id (🔴 critique)
  • #46 — Anycast gateway + autostate manquants sur InterfaceVlan (🟠)
  • #47 — UnderlayLink avec IPs dupliquées (🟠)
  • #48 — router_id redondant + distances BGP manquantes (🟠)
  • #49 — trunk_groups + stp_enabled manquants sur InfraVLAN (🟡)
  • #50 — BGP sessions en contexte VRF (🟠)

Next Step

L'étape suivante est de créer les object files (.yml) pour charger les données de la topologie de référence via l'entrée objects du .infrahub.yml, en se basant sur les configs du repo arista-evpn-vxlan-clab.

Refs

## Summary This PR introduces the complete Infrahub schema definition for modeling an Arista EVPN-VXLAN fabric, based on the overlaid.net reference topology (2 spines, 8 leafs in 4 MLAG pairs). ## Changes ### Schema files (`schemas/`) - **base.yml** — Core infrastructure: `InfraDevice`, `InfraInterface` (generic), `InterfaceEthernet`, `InterfaceLoopback`, `InterfaceVlan`, `InterfaceVxlan`, `InterfacePortChannel`, `InfraIPAddress` - **bgp.yml** — BGP stack: `InfraBGPRouterConfig`, `InfraBGPPeerGroup`, `InfraBGPSession`, `InfraBGPAddressFamily` - **vlan_vxlan.yml** — VLAN/VXLAN overlay: `InfraVLAN`, `InfraVTEP`, `InfraVlanVniMapping`, `InfraEVPNInstance` - **vrf.yml** — VRF/L3VNI: `InfraVRFConfig`, `InfraRouteTarget` - **mlag.yml** — MLAG domains: `InfraMLAGDomain`, `InfraMLAGPeerConfig` - **extensions.yml** — Topology helpers: `InfraUnderlayLink`, `InfraFabric`, `InfraAutonomousSystem` ### Configuration - `.infrahub.yml` — Schema loading + menus - `menus/fabric-menu.yml` — UI navigation structure ### Documentation - `schemas/README.md` — Complete ER diagram, node inventory, and topology mapping ## Topology Coverage The schema can model the complete reference topology: - 2 spines (AS 65000) + 8 leafs (AS 65001-65004) - 4 MLAG pairs with peer-link, iBGP, and dual-active detection - Underlay eBGP (point-to-point) + overlay EVPN (loopback-to-loopback) - L2VXLAN (VLAN-to-VNI) + L3VXLAN (VRF-to-VNI) - Anycast gateway with virtual-router addresses ## Known Issues (tracked separately) Les issues suivantes ont été identifiées et seront traitées dans des PRs ultérieures : - #43 — `human_friendly_id` non-unique sur BGPPeerGroup/BGPSession (🔴 critique) - #44 — Duplication InterfaceVxlan vs VTEP (🔴 critique) - #45 — Contrainte unique manquante sur InfraVLAN.vlan_id (🔴 critique) - #46 — Anycast gateway + autostate manquants sur InterfaceVlan (🟠) - #47 — UnderlayLink avec IPs dupliquées (🟠) - #48 — router_id redondant + distances BGP manquantes (🟠) - #49 — trunk_groups + stp_enabled manquants sur InfraVLAN (🟡) - #50 — BGP sessions en contexte VRF (🟠) ## Next Step L'étape suivante est de créer les **object files** (`.yml`) pour charger les données de la topologie de référence via l'entrée `objects` du `.infrahub.yml`, en se basant sur les configs du repo [arista-evpn-vxlan-clab](https://gitea.arnodo.fr/Damien/arista-evpn-vxlan-clab). ## Refs - Closes #41 - Source: [overlaid.net EVPN Configuration Example](https://overlaid.net/2019/01/27/arista-bgp-evpn-configuration-example/) - Lab: https://gitea.arnodo.fr/Damien/arista-evpn-vxlan-clab
Damien added 58 commits 2026-02-13 19:25:37 +00:00
feat(schema): add base infrastructure schema 077917f011 
Add core infrastructure models for Device, Interface, IPAddress,
and Platform based on the arista-evpn-vxlan-clab topology.

Ref: #41
feat(schema): add VLAN and VXLAN schema 535f24a920 
Add models for VLAN, VNI, VTEP, VLAN-VNI mappings, and EVPN instances.
Supports L2VNI and L3VNI types for EVPN-VXLAN fabric.

Ref: #41
feat(schema): add VRF schema d87ffcaca6 
Add models for VRF, Route Target, and VRF-Device assignments.
Supports L3VNI association for symmetric IRB routing.

Ref: #41
feat(schema): add BGP schema 3e96b0ff1a 
Add models for Autonomous System, BGP Router Config, Peer Groups,
BGP Sessions, and Address Families. Supports underlay and EVPN overlay.

Ref: #41
feat(schema): add MLAG schema e3ef0b3763 
Add models for MLAG Domain, Peer Config, and MLAG Interfaces.
Supports dual-primary detection and heartbeat configuration.

Ref: #41
feat(schema): add extensions schema bd46d5f046 
Add Fabric, Underlay Link, and Host Connection models
for fabric-wide configuration and topology documentation.

Ref: #41
docs(schema): add schema documentation and ERD f03698dec5 
Document all schema files, entity relationships, and mapping
to the reference arista-evpn-vxlan-clab topology.

Ref: #41
docs: reformat README tables for better raw readability ea6b66d639 
Update Markdown tables including InfraHub comparison, Prefect benefits, and project progress phases to use consistent column padding. This improves the visual alignment and readability when viewing the raw source file.
fix(schema): rename rd to route_distinguisher (min 3 chars) 443642c2a1 
Infrahub requires attribute names to have at least 3 characters.

Ref: #41
fix(schema): rename rd to route_distinguisher in EVPNInstance c2a92c340d 
Infrahub requires attribute names to have at least 3 characters.

Ref: #41
fix(schema): add unique identifiers for UnderlayLink relationships afa268ad2d 
Infrahub requires unique identifiers when multiple relationships
point to the same peer type with the same direction.

Ref: #41
fix(schema): use direction outbound for UnderlayLink relationships 4f5fef7203 
Use outbound direction to avoid bidirectional relationship conflicts
when multiple relationships point to the same peer type.

Ref: #41
fix(schema): add unique identifiers for MlagDomain VLAN relationships 6d08b19b5f 
Add identifier and direction: outbound for peer_vlan and ibgp_vlan
to avoid bidirectional relationship conflicts.

Ref: #41
fix(schema): add unique identifiers for VRF RouteTarget relationships 8114b6d973 
Add identifier and direction: outbound for import/export targets
in VRF and VRFDeviceAssignment to avoid bidirectional conflicts.

Ref: #41
fix(schema): add direction outbound for self-referencing relationship eb809812af 
InterfaceEthernet.connected_interface is a self-reference that requires
direction: outbound to avoid bidirectional conflicts per Infrahub docs.

Ref: #41
fix(schema): replace deprecated default_filter with human_friendly_id in base.yml 4e9c2d3009
fix(schema): display_labels must only reference attributes, not relationships c22a5b6ab4
fix(schema): display_labels must only reference local attributes in extensions.yml 42d03699d9
fix(schema): display_labels must only reference local attributes in mlag.yml 95bd2ee6c8
fix(schema): display_labels must only reference local attributes in vlan_vxlan.yml 2ca08a4f41
fix(schema): display_labels must only reference local attributes in vrf.yml 52c335aeb0
fix(schema): add optional: false on device relationship for uniqueness_constraints 4aadf763a3
fix(schema): IPAddress.interface - replace Parent with Attribute kind ef6877551f 
Parent relationships cannot be optional in Infrahub. Since an IP address
can exist without being assigned to an interface (reserved, planned),
we use kind: Attribute instead of kind: Parent.

Also change InfraInterface.ip_addresses from Component to Generic
since Component requires a matching Parent on the other side.

Both sides now use explicit identifier: interface__ip_addresses
for proper bidirectional linking.
fix(schema): add explicit optional: false to all Parent relationships in bgp.yml adb02fc25c
fix(schema): add explicit optional: false to Parent relationships in mlag.yml 67a54e349d
fix(schema): add explicit optional: false to all Parent relationships in vlan_vxlan.yml a12e24d00c
fix(schema): add explicit optional: false to Parent relationships in vrf.yml 0c0ab1b214
fix(schema): add optional: false on UnderlayLink.fabric parent relationship d7e2d9f0e0
fix(schema): add explicit optional: false on VRFDeviceAssignment.vrf for human_friendly_id 0e96e8aca8
fix(schema): add unique: true on VRF.name for HFID peer traversal 99f34b9639
refactor(schema): replace deprecated display_labels with display_label across all nodes a917715a47
refactor(schema): replace deprecated display_labels with display_label bb76b93499
fix: migrate display_labels to display_label Jinja2 format in base schema 97080473f7 
Replaces deprecated display_labels list format and bare display_label
strings with the new Jinja2 template format as required by Infrahub.

Refs #41
fix: migrate display_labels to display_label Jinja2 format in BGP schema cda3804c2c 
Refs #41
fix: migrate display_labels to display_label Jinja2 format in extensions schema 498fa8505e 
Refs #41
fix: migrate display_labels to display_label Jinja2 format in MLAG schema d9b47461d3 
Refs #41
fix: migrate display_labels to display_label Jinja2 format in VLAN/VXLAN schema b9b15f3beb 
Refs #41
fix: migrate display_labels to display_label Jinja2 format in VRF schema 25550bb3c4 
Also enriched VRFDeviceAssignment display_label to show device + VRF.

Refs #41
feat(menu): add custom Infrahub menu for EVPN-VXLAN fabric #41 78263e8bf5 
Organize 22+ schema nodes into logical categories:
- Fabric Topology (Fabric, Site, Device, Platform, Underlay Links)
- Interfaces (Ethernet, Loopback, VLAN SVI, LAG, VXLAN)
- IP Addressing
- Layer 2 / VXLAN (VLAN, VNI, VTEP, Mappings, EVPN)
- Routing / BGP (AS, Router Config, Peer Groups, Sessions, AFI)
- VRF (VRF, Route Targets, Assignments)
- MLAG (Domain, Peer Config, Interface)
- Host Connectivity
feat(config): add menu reference to .infrahub.yml #41 40fdf504c9
feat(schema): add include_in_menu: false to all base nodes #41 69f003b798 
Menu is now controlled by custom menus/fabric-menu.yml
feat(schema): add include_in_menu: false to all BGP nodes #41 ffa1eff19a
feat(schema): add include_in_menu: false to all VLAN/VXLAN nodes #41 a05e997742
feat(schema): add include_in_menu: false to all VRF nodes #41 741132a176
feat(schema): add include_in_menu: false to all MLAG nodes #41 e31846b057
feat(schema): add include_in_menu: false to all extension nodes #41 d05c96915f
fix(menu): rename VRF/MLAG namespaces to match Infrahub regex aa9d0093fe 
Infrahub namespaces must match ^[A-Z][a-z0-9]+$
- VRF → Vrf
- MLAG → Mlag
Create CLAUDE.md f69bba2bf1
fix(schema): scope BGPPeerGroup and BGPSession human_friendly_id per device — refs #43 3654c2de9d
fix(schema): remove duplicate InterfaceVxlan, keep VTEP only — refs #44 719ecfafaa
fix(schema): add unique constraint on InfraVLAN.vlan_id for human_friendly_id — refs #45 82af2daafc
fix(schema): add virtual_router_address and autostate on InterfaceVlan — refs #46 ed820f3380
fix(schema): refactor UnderlayLink IPs from attributes to InfraIPAddress relations — refs #47 e527534820
fix(schema): remove redundant Device.router_id, add BGP distance attributes — refs #48 f623d12b8c
fix(schema): add trunk_groups and stp_enabled on InfraVLAN — refs #49 cf05a5d477
Update CLAUDE.md 4e2f5b5b0c
fix(schema): add optional VRF relation on BGPSession — refs #50 e32da46bd7
docs(schema): update README with complete relationships and topology mapping — refs #41 f484af442a
Damien merged commit 7fd83b8c3f into main 2026-02-13 19:36:27 +00:00
Damien deleted branch feature/41-infrahub-schema 2026-02-13 19:36:30 +00:00
Sign in to join this conversation.
Reviewers
No Reviewers
Labels
Clear labels
documentation
Documentation tasks
 phase-1-yang-discovery
Phase 1: YANG Path Discovery and Validation
 phase-2-minimal-reconciler
Phase 2: Minimal Reconciler (VLANs, VNIs)
 phase-3-full-fabric
Phase 3: Full Fabric Coverage (BGP, MLAG, VRFs)
 phase-4-event-driven
Phase 4: Event-Driven Automation and CLI
 research
Research and investigation tasks
No Label
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
Damien
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: Damien/fabric-orchestrator#51
Delete Branch "feature/41-infrahub-schema"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?