Files
arista-evpn-vxlan-clab/infrahub/transforms/templates/interface_yang.j2
Damien Arnodo 668e9cbada feat: Add Infrahub Jinja2 transforms for VLANs, interfaces, and VXLAN (#20) (#24)
## Summary

Closes #20

Adds Infrahub Jinja2 transforms that query device intent from Infrahub via GraphQL and produce structured JSON payloads (YANG-style) suitable for gNMI Set operations on Arista EOS devices.

- **3 GraphQL queries** — `vlan_intent`, `interface_intent`, `vxlan_intent` — each parameterized by `$device_name`
- **3 Jinja2 templates** — `vlan_yang.j2`, `interface_yang.j2`, `vxlan_yang.j2` — producing JSON arrays/objects from the GraphQL response
- **Integration test fixtures** — one directory per transform with `input.json`, `output.json`, and `test.yml`, using leaf1 from the lab topology as sample device
- **`.infrahub.yml` updated** with `queries` and `jinja2_transforms` sections

## Files added

```
transforms/
├── queries/
│   ├── vlan_intent.gql       # VLANs via VTEP mappings + SVI interfaces
│   ├── interface_intent.gql  # All interface types with IPs
│   └── vxlan_intent.gql      # VTEP config + VLAN/VNI/VRF mappings
├── templates/
│   ├── vlan_yang.j2          # JSON array of VLANs (merged, deduplicated, sorted)
│   ├── interface_yang.j2     # JSON array of interfaces with type discriminator
│   └── vxlan_yang.j2         # JSON object: vtep + vlan_vni + vrf_vni mappings
└── tests/
    ├── vlan_yang/{input,output,test}.{json,yml}
    ├── interface_yang/{input,output,test}.{json,yml}
    └── vxlan_yang/{input,output,test}.{json,yml}
```

## Transform usage

```bash
# Render locally
infrahubctl render vlan_yang_transform device_name=leaf1
infrahubctl render interface_yang_transform device_name=leaf1
infrahubctl render vxlan_yang_transform device_name=leaf1

# Via API
GET /api/transform/jinja2/vlan_yang_transform?device_name=leaf1
GET /api/transform/jinja2/interface_yang_transform?device_name=leaf1
GET /api/transform/jinja2/vxlan_yang_transform?device_name=leaf1
```

## Test plan

- [x] Load branch into Infrahub (`infrahubctl schema load` + `infrahubctl object load`)
- [x] Run `infrahubctl render vlan_yang_transform device_name=leaf1` and verify JSON output matches expected VLANs (40, 4090, 4091)
- [x] Run `infrahubctl render interface_yang_transform device_name=leaf1` and verify all interface types are present with correct attributes
- [x] Run `infrahubctl render vxlan_yang_transform device_name=leaf1` and verify VTEP source address, UDP port, and VLAN-VNI mapping for VLAN 40 / VNI 110040
- [x] Run `infrahubctl render vxlan_yang_transform device_name=leaf3` and verify VRF gold / L3VNI 100001 appears in `vrf_vni_mappings`
- ~~[ ] Verify `infrahubctl test` passes for all three test fixtures~~

Reviewed-on: #24
2026-02-28 17:42:08 +00:00

102 lines
3.5 KiB
Django/Jinja

{#
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 | default(none),
"enabled": iface.enabled.value,
"mtu": iface.mtu.value | default(none),
"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 = none -%}
{%- if iface.lag is defined and iface.lag is not none and iface.lag.node is not none -%}
{%- set lag_name = iface.lag.node.name.value -%}
{%- endif -%}
{%- set _ = interfaces.append({
"type": "ethernet",
"name": iface.name.value,
"description": iface.description.value | default(none),
"enabled": iface.enabled.value,
"mtu": iface.mtu.value | default(none),
"speed": iface.speed.value | default(none),
"mode": iface.mode.value | default(none),
"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 = none -%}
{%- if iface.vlan is defined and iface.vlan is not none and iface.vlan.node is not none -%}
{%- set vlan_id = iface.vlan.node.vlan_id.value -%}
{%- endif -%}
{%- set _ = interfaces.append({
"type": "vlan",
"name": iface.name.value,
"description": iface.description.value | default(none),
"enabled": iface.enabled.value,
"mtu": iface.mtu.value | default(none),
"vlan_id": vlan_id,
"virtual_router_address": iface.virtual_router_address.value | default(none),
"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 | default(none),
"enabled": iface.enabled.value,
"mtu": iface.mtu.value | default(none),
"lacp_mode": iface.lacp_mode.value | default(none),
"mlag_id": iface.mlag_id.value | default(none),
"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) }}