Damien/infra-clab-pipeline
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat: update datacenter generator documentation to reflect accurate schema and object names

Browse Source
This commit is contained in:
darnodo
2025-11-12 18:38:54 +01:00
parent 2a99d48cdd
commit edc40dede6
1 changed files with 341 additions and 158 deletions
Download Patch File Download Diff File Expand all files Collapse all files

499
infrahub/generator.md
View File

@@ -1,34 +1,37 @@
# Datacenter Generator - Visual Diagrams # Datacenter Generator - Visual Diagrams
**Schema-Accurate Version - Corrected to match actual Infrahub schemas**
---
## 1. Generator Concept - High Level ## 1. Generator Concept - High Level
```mermaid ```mermaid
graph TB graph TB
subgraph Input["📥 INPUT"] subgraph Input["📥 INPUT"]
DC1[Datacenter: DC1<br/>---<br/>dc_id: 1<br/>bays: 2<br/>dci_enabled: false] DC1[InfraDatacenter: DC1<br/>---<br/>dc_id: 1<br/>number_of_bays: 2<br/>dci_enabled: false]
DC2[Datacenter: DC2<br/>---<br/>dc_id: 2<br/>bays: 2<br/>dci_enabled: false] DC2[InfraDatacenter: DC2<br/>---<br/>dc_id: 2<br/>number_of_bays: 2<br/>dci_enabled: false]
DCI_Config[DCI Configuration<br/>---<br/>Manual/External<br/>IP: 10.253.254.x] DCI_Config[NetworkDCISwitch<br/>---<br/>Manual/External<br/>Loopback0: 10.253.0.1]
end end
subgraph Logic["⚙️ DATACENTER GENERATOR"] subgraph Logic["⚙️ DATACENTER GENERATOR"]
Gen1[DC1 Generator:<br/>Create 11 devices<br/>Border eth12: shutdown] Gen1[DC1 Generator:<br/>Create 11 NetworkDevice objects<br/>Border eth12: shutdown]
Gen2[DC2 Generator:<br/>Create 11 devices<br/>Border eth12: shutdown] Gen2[DC2 Generator:<br/>Create 11 NetworkDevice objects<br/>Border eth12: shutdown]
end end
subgraph Output1["📤 DC1 OUTPUT"] subgraph Output1["📤 DC1 OUTPUT"]
Dev1[11 Device Objects] Dev1[11 NetworkDevice Objects]
Int1[~50 Interface Objects] Int1[~50 NetworkInterface Objects]
IP1[~30 IP Addresses] IP1[~30 IpamIPAddress Objects]
end end
subgraph Output2["📤 DC2 OUTPUT"] subgraph Output2["📤 DC2 OUTPUT"]
Dev2[11 Device Objects] Dev2[11 NetworkDevice Objects]
Int2[~50 Interface Objects] Int2[~50 NetworkInterface Objects]
IP2[~30 IP Addresses] IP2[~30 IpamIPAddress Objects]
end end
subgraph Manual["🔧 MANUAL DCI SETUP"] subgraph Manual["🔧 MANUAL DCI SETUP"]
DCIDevice[DCI Device<br/>Loopback: 10.253.0.1<br/>ASN: 65000] DCIDevice[NetworkDCISwitch<br/>Loopback0: 10.253.0.1<br/>ASN: 65000]
UpdateDC1[Update DC1:<br/>dci_enabled: true<br/>dci_remote_dc_id: 2] UpdateDC1[Update DC1:<br/>dci_enabled: true<br/>dci_remote_dc_id: 2]
UpdateDC2[Update DC2:<br/>dci_enabled: true<br/>dci_remote_dc_id: 1] UpdateDC2[Update DC2:<br/>dci_enabled: true<br/>dci_remote_dc_id: 1]
end end
@@ -56,13 +59,15 @@ graph TB
style DCIDevice fill:#ffccbc style DCIDevice fill:#ffccbc
``` ```
---
## 2. Datacenter Hierarchy ## 2. Datacenter Hierarchy
```mermaid ```mermaid
graph TB graph TB
Org[Organization] Org[OrganizationOrganization]
Site[Site: Paris-DC1<br/>Location: Paris, France] Site[LocationSite: Paris-DC1<br/>Location: Paris, France]
DC[Datacenter: DC1<br/>dc_id: 1<br/>bays: 2<br/>spines: 3] DC[InfraDatacenter: DC1<br/>dc_id: 1<br/>number_of_bays: 2<br/>spine_count: 3]
Org --> Site Org --> Site
Site --> DC Site --> DC
@@ -73,32 +78,32 @@ graph TB
DC --> BayLayer[Bay Layer] DC --> BayLayer[Bay Layer]
DC --> Subnets[IP Subnets] DC --> Subnets[IP Subnets]
SpineLayer --> S1[spine1-DC1<br/>ASN: 65100] SpineLayer --> S1[spine1-DC1<br/>NetworkDevice<br/>ASN: 65100]
SpineLayer --> S2[spine2-DC1<br/>ASN: 65100] SpineLayer --> S2[spine2-DC1<br/>NetworkDevice<br/>ASN: 65100]
SpineLayer --> S3[spine3-DC1<br/>ASN: 65100] SpineLayer --> S3[spine3-DC1<br/>NetworkDevice<br/>ASN: 65100]
LeafLayer --> LP1[Leaf Pair 1<br/>ASN: 65101] LeafLayer --> LP1[NetworkMLAGDomain: Pair 1<br/>ASN: 65101]
LeafLayer --> LP2[Leaf Pair 2<br/>ASN: 65102] LeafLayer --> LP2[NetworkMLAGDomain: Pair 2<br/>ASN: 65102]
LP1 --> L1[leaf1-DC1<br/>10.1.0.21] LP1 --> L1[leaf1-DC1<br/>Loopback0: 10.1.0.21]
LP1 --> L2[leaf2-DC1<br/>10.1.0.22] LP1 --> L2[leaf2-DC1<br/>Loopback0: 10.1.0.22]
LP2 --> L3[leaf3-DC1<br/>10.1.0.23] LP2 --> L3[leaf3-DC1<br/>Loopback0: 10.1.0.23]
LP2 --> L4[leaf4-DC1<br/>10.1.0.24] LP2 --> L4[leaf4-DC1<br/>Loopback0: 10.1.0.24]
BorderLayer --> BP[Border Pair<br/>ASN: 65103] BorderLayer --> BP[NetworkMLAGDomain: Border<br/>ASN: 65103]
BP --> B1[borderleaf1-DC1] BP --> B1[borderleaf1-DC1]
BP --> B2[borderleaf2-DC1] BP --> B2[borderleaf2-DC1]
BayLayer --> Bay1[Bay 1] BayLayer --> Bay1[InfraBay 1]
BayLayer --> Bay2[Bay 2] BayLayer --> Bay2[InfraBay 2]
Bay1 --> A1[access1-DC1] Bay1 --> A1[access1-DC1]
Bay2 --> A2[access2-DC1] Bay2 --> A2[access2-DC1]
Subnets --> Sub1[10.1.0.0/24<br/>Loopback0] Subnets --> Sub1[10.1.0.0/24<br/>IpamIPPrefix<br/>type: loopback]
Subnets --> Sub2[10.1.1.0/24<br/>Loopback1] Subnets --> Sub2[10.1.1.0/24<br/>IpamIPPrefix<br/>type: vtep]
Subnets --> Sub3[10.1.10.0/24<br/>Spine-Leaf P2P] Subnets --> Sub3[10.1.10.0/24<br/>IpamIPPrefix<br/>type: p2p]
Subnets --> Sub4[10.1.20.0/24<br/>Leaf-Access P2P] Subnets --> Sub4[10.1.20.0/24<br/>IpamIPPrefix<br/>type: p2p]
style DC fill:#ffecb3 style DC fill:#ffecb3
style LP1 fill:#b3e5fc style LP1 fill:#b3e5fc
@@ -107,18 +112,20 @@ graph TB
style Bay2 fill:#c8e6c9 style Bay2 fill:#c8e6c9
``` ```
---
## 3. Bay-to-Leaf Assignment Logic ## 3. Bay-to-Leaf Assignment Logic
```mermaid ```mermaid
graph LR graph LR
subgraph Bays["🏢 Bays"] subgraph Bays["🏢 InfraBay"]
Bay1[Bay 1<br/>access1-DC1] Bay1[Bay 1<br/>access1-DC1]
Bay2[Bay 2<br/>access2-DC1] Bay2[Bay 2<br/>access2-DC1]
Bay3[Bay 3<br/>access3-DC1] Bay3[Bay 3<br/>access3-DC1]
Bay4[Bay 4<br/>access4-DC1] Bay4[Bay 4<br/>access4-DC1]
end end
subgraph LeafPairs["🔀 Leaf Pairs - MLAG"] subgraph LeafPairs["🔀 NetworkMLAGDomain - Leaf Pairs"]
LP1[Leaf Pair 1<br/>leaf1-DC1 ↔ leaf2-DC1<br/>ASN: 65101] LP1[Leaf Pair 1<br/>leaf1-DC1 ↔ leaf2-DC1<br/>ASN: 65101]
LP2[Leaf Pair 2<br/>leaf3-DC1 ↔ leaf4-DC1<br/>ASN: 65102] LP2[Leaf Pair 2<br/>leaf3-DC1 ↔ leaf4-DC1<br/>ASN: 65102]
end end
@@ -149,50 +156,52 @@ graph LR
style LP2 fill:#b3e5fc style LP2 fill:#b3e5fc
``` ```
---
## 4. Complete DC1 Physical Topology ## 4. Complete DC1 Physical Topology
```mermaid ```mermaid
graph TB graph TB
subgraph DCI["DCI LAYER - Inter-DC"] subgraph DCI["DCI LAYER - Inter-DC"]
DCID[DCI Switch<br/>10.253.0.1<br/>ASN: 65000] DCID[NetworkDCISwitch<br/>Loopback0: 10.253.0.1<br/>ASN: 65000]
end end
subgraph Border["BORDER LEAF - DCI Gateway"] subgraph Border["BORDER LEAF - DCI Gateway"]
B1[borderleaf1-DC1<br/>10.1.0.31<br/>eth12: shutdown or active] B1[borderleaf1-DC1<br/>NetworkDevice<br/>Loopback0: 10.1.0.31<br/>eth12: shutdown or active]
B2[borderleaf2-DC1<br/>10.1.0.32<br/>eth12: shutdown or active] B2[borderleaf2-DC1<br/>NetworkDevice<br/>Loopback0: 10.1.0.32<br/>eth12: shutdown or active]
end end
subgraph Spine["SPINE LAYER - L3 Core"] subgraph Spine["SPINE LAYER - L3 Core"]
S1[spine1-DC1<br/>10.1.0.11<br/>ASN: 65100] S1[spine1-DC1<br/>NetworkDevice<br/>Loopback0: 10.1.0.11<br/>ASN: 65100]
S2[spine2-DC1<br/>10.1.0.12<br/>ASN: 65100] S2[spine2-DC1<br/>NetworkDevice<br/>Loopback0: 10.1.0.12<br/>ASN: 65100]
S3[spine3-DC1<br/>10.1.0.13<br/>ASN: 65100] S3[spine3-DC1<br/>NetworkDevice<br/>Loopback0: 10.1.0.13<br/>ASN: 65100]
end end
subgraph Leaf["LEAF LAYER - Aggregation + VXLAN"] subgraph Leaf["LEAF LAYER - Aggregation + VXLAN"]
subgraph Pair1["MLAG Pair 1 - ASN: 65101"] subgraph Pair1["NetworkMLAGDomain - Pair 1 - ASN: 65101"]
L1[leaf1-DC1<br/>10.1.0.21<br/>VTEP: 10.1.1.21] L1[leaf1-DC1<br/>Loopback0: 10.1.0.21<br/>VTEP: 10.1.1.21]
L2[leaf2-DC1<br/>10.1.0.22<br/>VTEP: 10.1.1.21] L2[leaf2-DC1<br/>Loopback0: 10.1.0.22<br/>VTEP: 10.1.1.21]
end end
subgraph Pair2["MLAG Pair 2 - ASN: 65102"] subgraph Pair2["NetworkMLAGDomain - Pair 2 - ASN: 65102"]
L3[leaf3-DC1<br/>10.1.0.23<br/>VTEP: 10.1.1.23] L3[leaf3-DC1<br/>Loopback0: 10.1.0.23<br/>VTEP: 10.1.1.23]
L4[leaf4-DC1<br/>10.1.0.24<br/>VTEP: 10.1.1.23] L4[leaf4-DC1<br/>Loopback0: 10.1.0.24<br/>VTEP: 10.1.1.23]
end end
end end
subgraph Access["ACCESS LAYER - Rack/Bay ToR"] subgraph Access["ACCESS LAYER - Rack/Bay ToR"]
A1[access1-DC1<br/>Bay 1<br/>L2 Switch] A1[access1-DC1<br/>NetworkDevice<br/>InfraBay 1<br/>L2 Switch]
A2[access2-DC1<br/>Bay 2<br/>L2 Switch] A2[access2-DC1<br/>NetworkDevice<br/>InfraBay 2<br/>L2 Switch]
end end
subgraph Hosts["HOST LAYER"] subgraph Hosts["HOST LAYER"]
H1[host1-DC1<br/>172.16.100.10] H1[host1-DC1<br/>NetworkDevice<br/>172.16.100.10]
H2[host2-DC1<br/>172.16.200.10] H2[host2-DC1<br/>NetworkDevice<br/>172.16.200.10]
end end
DCID -.Optional DCI.- B1 DCID -.Optional NetworkDCIConnection.- B1
DCID -.Optional DCI.- B2 DCID -.Optional NetworkDCIConnection.- B2
S1 -.eBGP.- L1 S1 -.eBGP - NetworkBGPNeighbor.- L1
S1 -.eBGP.- L2 S1 -.eBGP.- L2
S1 -.eBGP.- L3 S1 -.eBGP.- L3
S1 -.eBGP.- L4 S1 -.eBGP.- L4
@@ -213,14 +222,14 @@ graph TB
S3 -.eBGP.- B1 S3 -.eBGP.- B1
S3 -.eBGP.- B2 S3 -.eBGP.- B2
L1 ---|MLAG| L2 L1 ---|MLAG - Vlan4094| L2
L3 ---|MLAG| L4 L3 ---|MLAG - Vlan4094| L4
B1 ---|MLAG| B2 B1 ---|MLAG - Vlan4094| B2
L1 -->|eth7| A1 L1 -->|eth7 - NetworkInterface| A1
L2 -->|eth7| A1 L2 -->|eth7 - NetworkInterface| A1
L3 -->|eth7| A2 L3 -->|eth7 - NetworkInterface| A2
L4 -->|eth7| A2 L4 -->|eth7 - NetworkInterface| A2
A1 -->|eth10| H1 A1 -->|eth10| H1
A2 -->|eth10| H2 A2 -->|eth10| H2
@@ -239,40 +248,42 @@ graph TB
style B2 fill:#f8bbd0 style B2 fill:#f8bbd0
``` ```
---
## 5. IP Address Generation Flow ## 5. IP Address Generation Flow
```mermaid ```mermaid
graph TB graph TB
Start[Datacenter Object<br/>dc_id: 1, bays: 2] Start[InfraDatacenter Object<br/>dc_id: 1, number_of_bays: 2]
Start --> GenSubnets[Generate Subnets<br/>from dc_id] Start --> GenSubnets[Generate IpamIPPrefix<br/>from dc_id]
GenSubnets --> Sub1[10.1.0.0/24<br/>Loopback0] GenSubnets --> Sub1[10.1.0.0/24<br/>prefix_type: loopback<br/>Loopback0 addresses]
GenSubnets --> Sub2[10.1.1.0/24<br/>Loopback1] GenSubnets --> Sub2[10.1.1.0/24<br/>prefix_type: vtep<br/>Loopback1 VTEP addresses]
GenSubnets --> Sub3[10.1.10.0/24<br/>Spine-Leaf P2P] GenSubnets --> Sub3[10.1.10.0/24<br/>prefix_type: p2p<br/>Spine-Leaf links]
GenSubnets --> Sub4[10.1.20.0/24<br/>Leaf-Access P2P] GenSubnets --> Sub4[10.1.20.0/24<br/>prefix_type: p2p<br/>Leaf-Access links]
GenSubnets --> Sub5[10.1.255.0/24<br/>MLAG Peer] GenSubnets --> Sub5[10.1.255.0/24<br/>prefix_type: mlag<br/>MLAG Peer links]
GenSubnets --> Sub6[10.255.0.0/24<br/>Management] GenSubnets --> Sub6[10.255.0.0/24<br/>prefix_type: management<br/>Management IPs]
Sub1 --> AllocLo0[Allocate Loopback0<br/>to Spines & Leafs] Sub1 --> AllocLo0[Allocate IpamIPAddress<br/>Loopback0 to Spines & Leafs]
Sub2 --> AllocLo1[Allocate Loopback1<br/>to Leafs - shared in pairs] Sub2 --> AllocLo1[Allocate IpamIPAddress<br/>Loopback1 to Leafs - shared in pairs]
Sub3 --> AllocP2P1[Allocate /31s<br/>for Spine-Leaf links] Sub3 --> AllocP2P1[Allocate /31s<br/>for Spine-Leaf links]
Sub4 --> AllocP2P2[Allocate /31s<br/>for Leaf-Access links] Sub4 --> AllocP2P2[Allocate /31s<br/>for Leaf-Access links]
Sub5 --> AllocMLAG[Allocate /30s<br/>for MLAG peers] Sub5 --> AllocMLAG[Allocate /30s<br/>for MLAG peer links]
Sub6 --> AllocMgmt[Allocate Management IPs<br/>to all devices] Sub6 --> AllocMgmt[Allocate Management IPs<br/>to all devices via template]
AllocLo0 --> Spine1IP[spine1: 10.1.0.11/32] AllocLo0 --> Spine1IP[spine1: 10.1.0.11/32]
AllocLo0 --> Leaf1IP[leaf1: 10.1.0.21/32] AllocLo0 --> Leaf1IP[leaf1: 10.1.0.21/32]
AllocLo1 --> Leaf1VTEP[leaf1-2: 10.1.1.21/32 - shared] AllocLo1 --> Leaf1VTEP[leaf1-2 shared: 10.1.1.21/32]
AllocP2P1 --> Link1[spine1-leaf1: 10.1.10.0/31] AllocP2P1 --> Link1[spine1-leaf1: 10.1.10.0/31]
AllocP2P2 --> Link2[leaf1-access1: 10.1.20.0/31] AllocP2P2 --> Link2[leaf1-access1: 10.1.20.0/31]
AllocMLAG --> MLAG1[leaf1-2 peer: 10.1.255.1-2/30] AllocMLAG --> MLAG1[leaf1-2 peer: 10.1.255.1-2/30<br/>via Vlan4094]
AllocMgmt --> Mgmt1[spine1: 10.255.0.11] AllocMgmt --> Mgmt1[spine1: 10.255.0.11<br/>computed from template]
style Start fill:#ffecb3 style Start fill:#ffecb3
style Sub1 fill:#e1f5ff style Sub1 fill:#e1f5ff
@@ -283,41 +294,43 @@ graph TB
style Sub6 fill:#e1f5ff style Sub6 fill:#e1f5ff
``` ```
---
## 6. Device Generation Flow ## 6. Device Generation Flow
```mermaid ```mermaid
graph TB graph TB
DC[Datacenter: DC1<br/>bays: 2] DC[InfraDatacenter: DC1<br/>number_of_bays: 2]
DC --> CalcLeafs[Calculate:<br/>leaf_pairs = ceil - bays / 2 - = 1<br/>total_leafs = 1 * 2 = 2] DC --> CalcLeafs[Calculate:<br/>leaf_pair_count = ceil number_of_bays / 2 = 1<br/>total_leaf_count = 1 * 2 = 2<br/>total_access_count = 2]
CalcLeafs --> GenSpines[Generate Spines<br/>count: 3 - fixed] CalcLeafs --> GenSpines[Generate Spines<br/>count: spine_count = 3]
CalcLeafs --> GenLeafs[Generate Leafs<br/>count: 4 - computed] CalcLeafs --> GenLeafs[Generate Leafs<br/>count: total_leaf_count = 4]
CalcLeafs --> GenBorders[Generate Border Leafs<br/>count: 2 - fixed] CalcLeafs --> GenBorders[Generate Border Leafs<br/>count: border_leaf_count = 2<br/>if has_border_leafs: true]
CalcLeafs --> GenAccess[Generate Access<br/>count: 2 - from bays] CalcLeafs --> GenAccess[Generate Access<br/>count: total_access_count = 2]
GenSpines --> S1[spine1-DC1] GenSpines --> S1[spine1-DC1<br/>NetworkDevice<br/>role: spine]
GenSpines --> S2[spine2-DC1] GenSpines --> S2[spine2-DC1<br/>NetworkDevice<br/>role: spine]
GenSpines --> S3[spine3-DC1] GenSpines --> S3[spine3-DC1<br/>NetworkDevice<br/>role: spine]
GenLeafs --> LP1[Create MLAG Pair 1] GenLeafs --> LP1[Create NetworkMLAGDomain<br/>MLAG-leaf1-2-DC1]
GenLeafs --> LP2[Create MLAG Pair 2] GenLeafs --> LP2[Create NetworkMLAGDomain<br/>MLAG-leaf3-4-DC1]
LP1 --> L1[leaf1-DC1] LP1 --> L1[leaf1-DC1<br/>role: leaf<br/>mlag_side: left]
LP1 --> L2[leaf2-DC1] LP1 --> L2[leaf2-DC1<br/>role: leaf<br/>mlag_side: right]
LP2 --> L3[leaf3-DC1] LP2 --> L3[leaf3-DC1<br/>role: leaf<br/>mlag_side: left]
LP2 --> L4[leaf4-DC1] LP2 --> L4[leaf4-DC1<br/>role: leaf<br/>mlag_side: right]
GenBorders --> BP[Create Border Pair] GenBorders --> BP[Create NetworkMLAGDomain<br/>MLAG-border-DC1]
BP --> B1[borderleaf1-DC1] BP --> B1[borderleaf1-DC1<br/>role: borderleaf<br/>mlag_side: left]
BP --> B2[borderleaf2-DC1] BP --> B2[borderleaf2-DC1<br/>role: borderleaf<br/>mlag_side: right]
GenAccess --> AssignBays[Assign Bays to Leaf Pairs] GenAccess --> AssignBays[Assign InfraBay to Leaf Pairs]
AssignBays --> A1Config[Bay 1 → Leaf Pair 1<br/>access1-DC1] AssignBays --> A1Config[Bay 1 → Leaf Pair 1<br/>access1-DC1]
AssignBays --> A2Config[Bay 2 → Leaf Pair 1<br/>access2-DC1] AssignBays --> A2Config[Bay 2 → Leaf Pair 1<br/>access2-DC1]
A1Config --> A1[access1-DC1] A1Config --> A1[access1-DC1<br/>NetworkDevice<br/>role: access]
A2Config --> A2[access2-DC1] A2Config --> A2[access2-DC1<br/>NetworkDevice<br/>role: access]
style DC fill:#ffecb3 style DC fill:#ffecb3
style LP1 fill:#b3e5fc style LP1 fill:#b3e5fc
@@ -325,15 +338,17 @@ graph TB
style BP fill:#f8bbd0 style BP fill:#f8bbd0
``` ```
---
## 7. Scaling Scenario - Adding Bay 3 ## 7. Scaling Scenario - Adding Bay 3
```mermaid ```mermaid
graph LR graph LR
subgraph Current["📦 Current State - 2 Bays"] subgraph Current["📦 Current State - 2 Bays"]
CurDC[Datacenter: DC1<br/>bays: 2<br/>leaf_pairs: 1] CurDC[InfraDatacenter: DC1<br/>number_of_bays: 2<br/>leaf_pair_count: 1]
CurLP1[Leaf Pair 1<br/>leaf1-2] CurLP1[NetworkMLAGDomain: Pair 1<br/>leaf1-2]
CurBay1[Bay 1 → access1] CurBay1[InfraBay 1 → access1]
CurBay2[Bay 2 → access2] CurBay2[InfraBay 2 → access2]
CurDC --> CurLP1 CurDC --> CurLP1
CurLP1 --> CurBay1 CurLP1 --> CurBay1
@@ -345,22 +360,22 @@ graph LR
end end
subgraph Generator["🔄 Generator Logic"] subgraph Generator["🔄 Generator Logic"]
Check[Check:<br/>bays=3 > pairs*2=2?<br/>YES → Need new pair] Check[Check:<br/>number_of_bays=3 > pairs*2=2?<br/>YES → Need new pair]
CreatePair[Create Leaf Pair 2<br/>leaf3-DC1, leaf4-DC1] CreatePair[Create NetworkMLAGDomain<br/>Leaf Pair 2<br/>leaf3-DC1, leaf4-DC1]
CreateAccess[Create access3-DC1] CreateAccess[Create NetworkDevice<br/>access3-DC1<br/>role: access]
AssignBay[Assign Bay 3 → Pair 2] AssignBay[Assign InfraBay 3 → Pair 2]
AllocIPs[Allocate IPs] AllocIPs[Allocate IpamIPAddress]
CreateLinks[Create Interfaces] CreateLinks[Create NetworkInterface]
ConfigBGP[Configure BGP<br/>ASN: 65102] ConfigBGP[Configure NetworkBGPConfig<br/>ASN: 65102]
end end
subgraph Result["✅ New State - 3 Bays"] subgraph Result["✅ New State - 3 Bays"]
NewDC[Datacenter: DC1<br/>bays: 3<br/>leaf_pairs: 2] NewDC[InfraDatacenter: DC1<br/>number_of_bays: 3<br/>leaf_pair_count: 2]
NewLP1[Leaf Pair 1<br/>leaf1-2<br/>ASN: 65101] NewLP1[NetworkMLAGDomain: Pair 1<br/>leaf1-2<br/>ASN: 65101]
NewLP2[Leaf Pair 2<br/>leaf3-4<br/>ASN: 65102] NewLP2[NetworkMLAGDomain: Pair 2<br/>leaf3-4<br/>ASN: 65102]
NewBay1[Bay 1 → access1] NewBay1[InfraBay 1 → access1]
NewBay2[Bay 2 → access2] NewBay2[InfraBay 2 → access2]
NewBay3[Bay 3 → access3] NewBay3[InfraBay 3 → access3]
NewDC --> NewLP1 NewDC --> NewLP1
NewDC --> NewLP2 NewDC --> NewLP2
@@ -384,6 +399,8 @@ graph LR
style Result fill:#c8e6c9 style Result fill:#c8e6c9
``` ```
---
## 8. Infrahub Generator Workflow ## 8. Infrahub Generator Workflow
```mermaid ```mermaid
@@ -393,26 +410,27 @@ sequenceDiagram
participant Generator participant Generator
participant Validator participant Validator
participant GraphQL participant GraphQL
participant Devices participant Objects
User->>Infrahub: Create Datacenter Object<br/>(name, dc_id, bays, etc.) User->>Infrahub: Create InfraDatacenter Object<br/>(name, dc_id, number_of_bays, etc.)
Infrahub->>Validator: Pre-Generation Validation Infrahub->>Validator: Pre-Generation Validation
Validator-->>Infrahub: ✅ Valid Input Validator-->>Infrahub: ✅ Valid Input
Infrahub->>Generator: Trigger Generator Infrahub->>Generator: Trigger Generator
Generator->>Generator: Compute Derived Values<br/>(leaf_pairs, subnets, etc.) Generator->>Generator: Compute Derived Values<br/>(leaf_pair_count, total_leaf_count, etc.)
loop For Each Layer loop For Each Layer
Generator->>Devices: Create Spine Devices Generator->>Objects: Create NetworkDevice - Spines
Generator->>Devices: Create Leaf Devices Generator->>Objects: Create NetworkDevice - Leafs
Generator->>Devices: Create Access Devices Generator->>Objects: Create NetworkDevice - Access
Generator->>Objects: Create NetworkMLAGDomain
end end
loop For Each Device loop For Each Device
Generator->>Devices: Create Interfaces Generator->>Objects: Create NetworkInterface
Generator->>Devices: Allocate IP Addresses Generator->>Objects: Allocate IpamIPAddress
Generator->>Devices: Generate BGP Config Generator->>Objects: Generate NetworkBGPConfig
end end
Generator->>Validator: Post-Generation Validation Generator->>Validator: Post-Generation Validation
@@ -421,15 +439,17 @@ sequenceDiagram
Generator->>GraphQL: Commit All Objects Generator->>GraphQL: Commit All Objects
GraphQL-->>Infrahub: Objects Created GraphQL-->>Infrahub: Objects Created
Infrahub-->>User: ✅ Datacenter Generated<br/>27 devices, 150 interfaces, 90 IPs Infrahub-->>User: ✅ Datacenter Generated<br/>11 devices, 50+ interfaces, 30+ IPs
``` ```
---
## 9. Configuration Generation Flow ## 9. Configuration Generation Flow
```mermaid ```mermaid
graph TB graph TB
subgraph Infrahub["📊 Infrahub - Source of Truth"] subgraph Infrahub["📊 Infrahub - Source of Truth"]
DeviceDB[(Device Objects<br/>Interfaces<br/>IPs<br/>BGP Sessions)] DeviceDB[(NetworkDevice Objects<br/>NetworkInterface<br/>IpamIPAddress<br/>NetworkBGPConfig)]
end end
subgraph Generator["⚙️ Config Generator"] subgraph Generator["⚙️ Config Generator"]
@@ -469,70 +489,233 @@ graph TB
style Deployment fill:#ffccbc style Deployment fill:#ffccbc
``` ```
---
## 10. Complete Data Model Relationships ## 10. Complete Data Model Relationships
```mermaid ```mermaid
erDiagram erDiagram
ORGANIZATION ||--o{ SITE : contains OrganizationOrganization ||--o{ LocationSite : "contains (Generic)"
SITE ||--o{ DATACENTER : contains LocationSite ||--o{ InfraDatacenter : "contains (Generic)"
SITE ||--o{ IP_PREFIX : manages LocationSite ||--o{ IpamIPPrefix : "manages (Attribute)"
DATACENTER ||--|{ SUBNET : generates InfraDatacenter ||--|{ IpamIPPrefix : "generates (Generic)"
DATACENTER ||--|{ DEVICE : generates InfraDatacenter ||--|{ NetworkDevice : "generates (Component)"
DATACENTER ||--|{ MLAG_PAIR : generates InfraDatacenter ||--|{ NetworkMLAGDomain : "generates (Generic)"
InfraDatacenter ||--|{ InfraBay : "contains (Generic)"
DEVICE ||--|{ INTERFACE : has NetworkDevice ||--|{ NetworkInterface : "has (Component)"
INTERFACE ||--o| IP_ADDRESS : assigned NetworkInterface ||--o| IpamIPAddress : "assigned (Generic)"
INTERFACE ||--o| BGP_SESSION : endpoint NetworkInterface ||--o| NetworkBGPNeighbor : "endpoint (Generic)"
DEVICE }|--|| ROLE : has NetworkDevice }|--|| DeviceRole : "has (Attribute)"
DEVICE }o--o| MLAG_PAIR : member_of NetworkDevice }o--o| NetworkMLAGDomain : "member_of (Attribute)"
MLAG_PAIR ||--|| DEVICE : primary NetworkMLAGDomain ||--o{ NetworkDevice : "devices (Generic)"
MLAG_PAIR ||--|| DEVICE : secondary NetworkMLAGDomain ||--|{ NetworkMLAGInterface : "interfaces (Component)"
BGP_SESSION }o--|| INTERFACE : local NetworkBGPConfig }o--|| NetworkDevice : "device (Parent)"
BGP_SESSION }o--|| INTERFACE : remote NetworkBGPConfig ||--|{ NetworkBGPPeerGroup : "peer_groups (Component)"
NetworkBGPConfig ||--|{ NetworkBGPNeighbor : "neighbors (Component)"
SUBNET ||--|{ IP_ADDRESS : contains IpamIPPrefix ||--|{ IpamIPAddress : "contains (Generic)"
IP_PREFIX ||--|{ SUBNET : parent IpamIPPrefix ||--o| IpamIPPrefix : "parent (Attribute)"
ORGANIZATION { NetworkDCISwitch ||--|{ NetworkDCIConnection : "connections (Component)"
NetworkDCIConnection }o--|| NetworkDevice : "border_leaf (Attribute)"
OrganizationOrganization {
string name string name
number asn_base
} }
SITE { LocationSite {
string name string name
string location string location
string status
} }
DATACENTER { InfraDatacenter {
string name string name
int dc_id number dc_id
int number_of_bays number number_of_bays
int spine_count number spine_count
string parent_subnet number border_leaf_count
IPNetwork parent_subnet
number bgp_base_asn
boolean dci_enabled
number leaf_pair_count_COMPUTED
number total_leaf_count_COMPUTED
number total_access_count_COMPUTED
} }
DEVICE { NetworkDevice {
string hostname string hostname
string role string role
string mgmt_ip IPHost management_ip_COMPUTED
string platform
number spine_id
number leaf_id
} }
INTERFACE { NetworkInterface {
string name string name
string type string interface_type
int mtu boolean enabled
number mtu
string switchport_mode
number channel_id
} }
IP_ADDRESS { IpamIPAddress {
string address IPHost address
int prefix_length string status
} }
BGP_SESSION { NetworkBGPConfig {
int local_asn number asn
int remote_asn IPHost router_id
number maximum_paths
number distance_external
number distance_internal
number ebgp_admin_distance
} }
NetworkMLAGDomain {
string domain_id
IPHost peer_address
string status
}
NetworkDCISwitch {
string hostname
IPHost loopback0_ip
IPHost management_ip
}
NetworkDCIConnection {
string connection_name
string status
IPHost dci_ip
IPHost border_ip
IPNetwork subnet
}
```
---
## 11. DCI Architecture - NetworkDCISwitch & NetworkDCIConnection
```mermaid
graph TB
subgraph DCILayer["🌐 DCI Layer - Separate Schema"]
DCI[NetworkDCISwitch<br/>hostname: DCI<br/>loopback0_ip: 10.253.0.1/32<br/>management_ip: 10.255.0.253]
end
subgraph DC1Border["DC1 Border Leafs"]
B1_DC1[borderleaf1-DC1<br/>NetworkDevice<br/>eth12 interface]
B2_DC1[borderleaf2-DC1<br/>NetworkDevice<br/>eth12 interface]
end
subgraph DC2Border["DC2 Border Leafs"]
B1_DC2[borderleaf1-DC2<br/>NetworkDevice<br/>eth12 interface]
B2_DC2[borderleaf2-DC2<br/>NetworkDevice<br/>eth12 interface]
end
subgraph Connections["NetworkDCIConnection Objects"]
Conn1[DCI-to-borderleaf1-DC1<br/>dci_interface: Ethernet1<br/>border_interface: Ethernet12<br/>dci_ip: 10.254.0.1/31<br/>border_ip: 10.254.0.0/31<br/>status: shutdown]
Conn2[DCI-to-borderleaf2-DC1<br/>dci_interface: Ethernet2<br/>border_interface: Ethernet12<br/>dci_ip: 10.254.0.3/31<br/>border_ip: 10.254.0.2/31<br/>status: shutdown]
Conn3[DCI-to-borderleaf1-DC2<br/>dci_interface: Ethernet3<br/>border_interface: Ethernet12<br/>dci_ip: 10.254.0.5/31<br/>border_ip: 10.254.0.4/31<br/>status: shutdown]
Conn4[DCI-to-borderleaf2-DC2<br/>dci_interface: Ethernet4<br/>border_interface: Ethernet12<br/>dci_ip: 10.254.0.7/31<br/>border_ip: 10.254.0.6/31<br/>status: shutdown]
end
DCI --> Conn1
DCI --> Conn2
DCI --> Conn3
DCI --> Conn4
Conn1 -.-> B1_DC1
Conn2 -.-> B2_DC1
Conn3 -.-> B1_DC2
Conn4 -.-> B2_DC2
style DCI fill:#ffccbc
style Conn1 fill:#fff9c4
style Conn2 fill:#fff9c4
style Conn3 fill:#fff9c4
style Conn4 fill:#fff9c4
```
**Key DCI Concepts:**
- **NetworkDCISwitch**: Separate schema object (NOT NetworkDevice)
- **NetworkDCIConnection**: Tracks P2P links with dedicated attributes
- **status**: Default is `shutdown`, changes to `active` when `dci_enabled: true`
- **border_interface**: Always Ethernet12 on border leafs
- **Relationship**: `NetworkDCIConnection` → `border_leaf` (Attribute) → `NetworkDevice`
---
## 12. Key Schema Attributes Summary
### InfraDatacenter Attributes
```yaml
# User Input (Required)
name: string # "DC1"
dc_id: number # 1
number_of_bays: number # 2 (default)
parent_subnet: IPNetwork # "10.0.0.0/8"
# Configuration (With Defaults)
spine_count: number # 3 (default)
border_leaf_count: number # 2 (default)
bgp_base_asn: number # 65000 (default)
spine_asn: number # Auto: bgp_base_asn + (dc_id * 100)
mlag_domain_id: string # "MLAG" (default)
mtu: number # 9214 (default)
has_border_leafs: boolean # true (default)
dci_enabled: boolean # false (default)
dci_remote_dc_id: number # Optional
# Computed (Read-Only)
leaf_pair_count: number # ceil(number_of_bays / 2)
total_leaf_count: number # leaf_pair_count * 2
total_access_count: number # number_of_bays
```
### NetworkDevice Attributes
```yaml
hostname: string # "spine1-DC1"
role: dropdown # spine, leaf, borderleaf, access, host
platform: string # "cEOS" (default)
management_ip_template: string # Template for IP generation
management_ip: IPHost # Computed from template
spine_id: number # For spines
leaf_id: number # For leafs
mlag_side: dropdown # left (odd), right (even)
```
### NetworkInterface Types
```yaml
interface_type: dropdown
- ethernet # Physical interfaces
- loopback # Loopback0, Loopback1
- port_channel # Note: underscore, not hyphen!
- vlan # SVIs
- vxlan # VXLAN tunnels
- management # Management interface
```
### IpamIPPrefix Types
```yaml
prefix_type: dropdown
- pool # General pool
- loopback # Loopback0 addresses
- vtep # Loopback1 VTEP addresses
- p2p # Point-to-point links
- management # Management network
- tenant # Tenant/VLAN networks
- mlag # MLAG peer links
``` ```