feat: Add Infrahub Jinja2 transforms for VLANs, interfaces, and VXLAN (#20)
Add three GraphQL queries, Jinja2 templates, and integration tests for generating YANG-style JSON configuration payloads from Infrahub intent data, suitable for gNMI Set operations on Arista EOS devices. Queries (transforms/queries/): - vlan_intent.gql: Fetches VLANs for a device via VTEP mappings and SVI interfaces, including VNI associations. - interface_intent.gql: Fetches all interface types (loopback, ethernet, vlan, lag) with IP addresses and type-specific attributes. - vxlan_intent.gql: Fetches VTEP config, VLAN-to-VNI mappings, and VRF-to-VNI mappings (L3VNI) via VRF device assignments. Templates (transforms/templates/): - vlan_yang.j2: Merges VLANs from both VTEP and SVI sources, deduplicates by vlan_id, and emits a sorted JSON array. - interface_yang.j2: Emits a JSON array of interfaces sorted by name, with a "type" discriminator field for each interface kind. - vxlan_yang.j2: Emits a JSON object with vtep config, vlan_vni_mappings, and vrf_vni_mappings sections. Integration tests (transforms/tests/): - One test directory per transform with input.json (sample GraphQL response for leaf1), output.json (expected result), and test.yml config. - Test data reflects the lab topology: leaf1 VTEP 10.0.255.11, VLAN 40 / VNI 110040, MLAG VLANs 4090/4091, underlay Ethernet11/12. .infrahub.yml updated with queries and jinja2_transforms sections. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
Damien
101
transforms/templates/interface_yang.j2
Normal file
101
transforms/templates/interface_yang.j2
Normal file
@@ -0,0 +1,101 @@
|
||||
{#
|
||||
interface_yang.j2 — Produce a JSON array of interface configuration objects.
|
||||
|
||||
Input: GraphQL response from interface_intent query.
|
||||
Returns all interface types (loopback, ethernet, vlan, lag) for the device,
|
||||
each with a "type" discriminator and type-specific attributes.
|
||||
#}
|
||||
{%- set interfaces = [] -%}
|
||||
|
||||
{#— Loopback interfaces —#}
|
||||
{%- for edge in data.InfraInterfaceLoopback.edges -%}
|
||||
{%- set iface = edge.node -%}
|
||||
{%- set ip_list = [] -%}
|
||||
{%- for ip_edge in iface.ip_addresses.edges -%}
|
||||
{%- set _ = ip_list.append(ip_edge.node.address.value) -%}
|
||||
{%- endfor -%}
|
||||
{%- set _ = interfaces.append({
|
||||
"type": "loopback",
|
||||
"name": iface.name.value,
|
||||
"description": iface.description.value,
|
||||
"enabled": iface.enabled.value,
|
||||
"mtu": iface.mtu.value,
|
||||
"ip_addresses": ip_list
|
||||
}) -%}
|
||||
{%- endfor -%}
|
||||
|
||||
{#— Ethernet interfaces —#}
|
||||
{%- for edge in data.InfraInterfaceEthernet.edges -%}
|
||||
{%- set iface = edge.node -%}
|
||||
{%- set ip_list = [] -%}
|
||||
{%- for ip_edge in iface.ip_addresses.edges -%}
|
||||
{%- set _ = ip_list.append(ip_edge.node.address.value) -%}
|
||||
{%- endfor -%}
|
||||
{%- set lag_name = null -%}
|
||||
{%- if iface.lag and iface.lag.node -%}
|
||||
{%- set lag_name = iface.lag.node.name.value -%}
|
||||
{%- endif -%}
|
||||
{%- set _ = interfaces.append({
|
||||
"type": "ethernet",
|
||||
"name": iface.name.value,
|
||||
"description": iface.description.value,
|
||||
"enabled": iface.enabled.value,
|
||||
"mtu": iface.mtu.value,
|
||||
"speed": iface.speed.value,
|
||||
"mode": iface.mode.value,
|
||||
"lag": lag_name,
|
||||
"ip_addresses": ip_list
|
||||
}) -%}
|
||||
{%- endfor -%}
|
||||
|
||||
{#— VLAN SVI interfaces —#}
|
||||
{%- for edge in data.InfraInterfaceVlan.edges -%}
|
||||
{%- set iface = edge.node -%}
|
||||
{%- set ip_list = [] -%}
|
||||
{%- for ip_edge in iface.ip_addresses.edges -%}
|
||||
{%- set _ = ip_list.append(ip_edge.node.address.value) -%}
|
||||
{%- endfor -%}
|
||||
{%- set vlan_id = null -%}
|
||||
{%- if iface.vlan and iface.vlan.node -%}
|
||||
{%- set vlan_id = iface.vlan.node.vlan_id.value -%}
|
||||
{%- endif -%}
|
||||
{%- set _ = interfaces.append({
|
||||
"type": "vlan",
|
||||
"name": iface.name.value,
|
||||
"description": iface.description.value,
|
||||
"enabled": iface.enabled.value,
|
||||
"mtu": iface.mtu.value,
|
||||
"vlan_id": vlan_id,
|
||||
"virtual_router_address": iface.virtual_router_address.value,
|
||||
"autostate": iface.autostate.value,
|
||||
"ip_addresses": ip_list
|
||||
}) -%}
|
||||
{%- endfor -%}
|
||||
|
||||
{#— LAG / Port-Channel interfaces —#}
|
||||
{%- for edge in data.InfraInterfaceLag.edges -%}
|
||||
{%- set iface = edge.node -%}
|
||||
{%- set ip_list = [] -%}
|
||||
{%- for ip_edge in iface.ip_addresses.edges -%}
|
||||
{%- set _ = ip_list.append(ip_edge.node.address.value) -%}
|
||||
{%- endfor -%}
|
||||
{%- set member_list = [] -%}
|
||||
{%- for member_edge in iface.members.edges -%}
|
||||
{%- set _ = member_list.append(member_edge.node.name.value) -%}
|
||||
{%- endfor -%}
|
||||
{%- set _ = interfaces.append({
|
||||
"type": "lag",
|
||||
"name": iface.name.value,
|
||||
"description": iface.description.value,
|
||||
"enabled": iface.enabled.value,
|
||||
"mtu": iface.mtu.value,
|
||||
"lacp_mode": iface.lacp_mode.value,
|
||||
"mlag_id": iface.mlag_id.value,
|
||||
"members": member_list,
|
||||
"ip_addresses": ip_list
|
||||
}) -%}
|
||||
{%- endfor -%}
|
||||
|
||||
{#— Sort by name and emit JSON array —#}
|
||||
{%- set sorted_ifaces = interfaces | sort(attribute='name') -%}
|
||||
{{ sorted_ifaces | tojson(indent=2) }}
|
||||
67
transforms/templates/vlan_yang.j2
Normal file
67
transforms/templates/vlan_yang.j2
Normal file
@@ -0,0 +1,67 @@
|
||||
{#
|
||||
vlan_yang.j2 — Produce a JSON array of VLAN configuration objects.
|
||||
|
||||
Input: GraphQL response from vlan_intent query.
|
||||
The query returns VLANs from two sources:
|
||||
1. data.InfraVTEP[].vlan_vni_mappings[].vlan (L2/VXLAN VLANs)
|
||||
2. data.InfraInterfaceVlan[].vlan (SVI/routing/MLAG VLANs)
|
||||
|
||||
We merge both sources, deduplicate by vlan_id, and emit one object per VLAN.
|
||||
#}
|
||||
{%- set vlans = {} -%}
|
||||
|
||||
{#— Collect VLANs from VTEP VLAN-VNI mappings —#}
|
||||
{%- for vtep_edge in data.InfraVTEP.edges -%}
|
||||
{%- for mapping_edge in vtep_edge.node.vlan_vni_mappings.edges -%}
|
||||
{%- set vlan_node = mapping_edge.node.vlan.node -%}
|
||||
{%- set vid = vlan_node.vlan_id.value | string -%}
|
||||
{%- if vid not in vlans -%}
|
||||
{%- set vni_val = null -%}
|
||||
{%- set vni_type_val = null -%}
|
||||
{%- if vlan_node.vni and vlan_node.vni.node -%}
|
||||
{%- set vni_val = vlan_node.vni.node.vni.value -%}
|
||||
{%- set vni_type_val = vlan_node.vni.node.vni_type.value -%}
|
||||
{%- endif -%}
|
||||
{%- set _ = vlans.update({vid: {
|
||||
"vlan_id": vlan_node.vlan_id.value,
|
||||
"name": vlan_node.name.value,
|
||||
"status": vlan_node.status.value | upper,
|
||||
"vlan_type": vlan_node.vlan_type.value,
|
||||
"trunk_groups": vlan_node.trunk_groups.value if vlan_node.trunk_groups.value else [],
|
||||
"stp_enabled": vlan_node.stp_enabled.value,
|
||||
"vni": vni_val,
|
||||
"vni_type": vni_type_val
|
||||
}}) -%}
|
||||
{%- endif -%}
|
||||
{%- endfor -%}
|
||||
{%- endfor -%}
|
||||
|
||||
{#— Collect VLANs from SVI interfaces —#}
|
||||
{%- for svi_edge in data.InfraInterfaceVlan.edges -%}
|
||||
{%- if svi_edge.node.vlan and svi_edge.node.vlan.node -%}
|
||||
{%- set vlan_node = svi_edge.node.vlan.node -%}
|
||||
{%- set vid = vlan_node.vlan_id.value | string -%}
|
||||
{%- if vid not in vlans -%}
|
||||
{%- set vni_val = null -%}
|
||||
{%- set vni_type_val = null -%}
|
||||
{%- if vlan_node.vni and vlan_node.vni.node -%}
|
||||
{%- set vni_val = vlan_node.vni.node.vni.value -%}
|
||||
{%- set vni_type_val = vlan_node.vni.node.vni_type.value -%}
|
||||
{%- endif -%}
|
||||
{%- set _ = vlans.update({vid: {
|
||||
"vlan_id": vlan_node.vlan_id.value,
|
||||
"name": vlan_node.name.value,
|
||||
"status": vlan_node.status.value | upper,
|
||||
"vlan_type": vlan_node.vlan_type.value,
|
||||
"trunk_groups": vlan_node.trunk_groups.value if vlan_node.trunk_groups.value else [],
|
||||
"stp_enabled": vlan_node.stp_enabled.value,
|
||||
"vni": vni_val,
|
||||
"vni_type": vni_type_val
|
||||
}}) -%}
|
||||
{%- endif -%}
|
||||
{%- endif -%}
|
||||
{%- endfor -%}
|
||||
|
||||
{#— Sort by vlan_id and emit JSON array —#}
|
||||
{%- set sorted_vlans = vlans.values() | sort(attribute='vlan_id') -%}
|
||||
{{ sorted_vlans | tojson(indent=2) }}
|
||||
88
transforms/templates/vxlan_yang.j2
Normal file
88
transforms/templates/vxlan_yang.j2
Normal file
@@ -0,0 +1,88 @@
|
||||
{#
|
||||
vxlan_yang.j2 — Produce a JSON object representing the VXLAN/VTEP configuration
|
||||
for the device, including VLAN-to-VNI mappings and VRF-to-VNI mappings.
|
||||
|
||||
Input: GraphQL response from vxlan_intent query.
|
||||
#}
|
||||
{%- set vtep_edges = data.InfraVTEP.edges -%}
|
||||
{%- set vrf_edges = data.InfraVRFDeviceAssignment.edges -%}
|
||||
|
||||
{#— Build VTEP section (there is one VTEP per device) —#}
|
||||
{%- if vtep_edges | length > 0 -%}
|
||||
{%- set vtep = vtep_edges[0].node -%}
|
||||
{%- set source_iface = null -%}
|
||||
{%- if vtep.source_interface and vtep.source_interface.node -%}
|
||||
{%- set source_iface = vtep.source_interface.node.name.value -%}
|
||||
{%- endif -%}
|
||||
|
||||
{#— Build VLAN-to-VNI mapping list —#}
|
||||
{%- set vlan_vni_list = [] -%}
|
||||
{%- for mapping_edge in vtep.vlan_vni_mappings.edges -%}
|
||||
{%- set m = mapping_edge.node -%}
|
||||
{%- set vlan_id = null -%}
|
||||
{%- set vlan_name = null -%}
|
||||
{%- if m.vlan and m.vlan.node -%}
|
||||
{%- set vlan_id = m.vlan.node.vlan_id.value -%}
|
||||
{%- set vlan_name = m.vlan.node.name.value -%}
|
||||
{%- endif -%}
|
||||
{%- set vni_val = null -%}
|
||||
{%- set vni_type_val = null -%}
|
||||
{%- if m.vni and m.vni.node -%}
|
||||
{%- set vni_val = m.vni.node.vni.value -%}
|
||||
{%- set vni_type_val = m.vni.node.vni_type.value -%}
|
||||
{%- endif -%}
|
||||
{%- set _ = vlan_vni_list.append({
|
||||
"vlan_id": vlan_id,
|
||||
"vlan_name": vlan_name,
|
||||
"vni": vni_val,
|
||||
"vni_type": vni_type_val
|
||||
}) -%}
|
||||
{%- endfor -%}
|
||||
|
||||
{#— Build VRF-to-VNI mapping list —#}
|
||||
{%- set vrf_vni_list = [] -%}
|
||||
{%- for vrf_edge in vrf_edges -%}
|
||||
{%- set assignment = vrf_edge.node -%}
|
||||
{%- set vrf_name = null -%}
|
||||
{%- set l3vni = null -%}
|
||||
{%- set import_rts = [] -%}
|
||||
{%- set export_rts = [] -%}
|
||||
{%- if assignment.vrf and assignment.vrf.node -%}
|
||||
{%- set vrf_node = assignment.vrf.node -%}
|
||||
{%- set vrf_name = vrf_node.name.value -%}
|
||||
{%- if vrf_node.l3vni and vrf_node.l3vni.node -%}
|
||||
{%- set l3vni = vrf_node.l3vni.node.vni.value -%}
|
||||
{%- endif -%}
|
||||
{%- for rt_edge in vrf_node.import_targets.edges -%}
|
||||
{%- set _ = import_rts.append(rt_edge.node.target.value) -%}
|
||||
{%- endfor -%}
|
||||
{%- for rt_edge in vrf_node.export_targets.edges -%}
|
||||
{%- set _ = export_rts.append(rt_edge.node.target.value) -%}
|
||||
{%- endfor -%}
|
||||
{%- endif -%}
|
||||
{%- set _ = vrf_vni_list.append({
|
||||
"vrf": vrf_name,
|
||||
"l3vni": l3vni,
|
||||
"route_distinguisher": assignment.route_distinguisher.value,
|
||||
"import_targets": import_rts,
|
||||
"export_targets": export_rts
|
||||
}) -%}
|
||||
{%- endfor -%}
|
||||
|
||||
{%- set result = {
|
||||
"vtep": {
|
||||
"source_address": vtep.source_address.value,
|
||||
"source_interface": source_iface,
|
||||
"udp_port": vtep.udp_port.value,
|
||||
"learn_restrict": vtep.learn_restrict.value,
|
||||
"vlan_vni_mappings": vlan_vni_list | sort(attribute='vlan_id'),
|
||||
"vrf_vni_mappings": vrf_vni_list
|
||||
}
|
||||
} -%}
|
||||
{%- else -%}
|
||||
{%- set result = {
|
||||
"vtep": null,
|
||||
"vrf_vni_mappings": []
|
||||
} -%}
|
||||
{%- endif -%}
|
||||
{{ result | tojson(indent=2) }}
|
||||
Reference in New Issue
Block a user