Vlan subinterfaces (#20)

iljarotar · web-flow · commit 7403b8baa393 · 2025-05-23T14:03:47.000+02:00
diff --git a/README.md b/README.md
@@ -532,6 +532,32 @@ Result:
 }
 ```
 
+### vlan_subinterfaces
+
+Example:
+
+```yaml
+vlan_subinterfaces:
+  - cidr: 1.2.3.0/24
+    port: Ethernet0
+    vlan: 1000
+    vrf: Vrf45
+```
+
+Result:
+
+```json
+{
+  "VLAN_SUB_INTERFACE": {
+    "Ethernet0.1000": {
+      "admin_status": "up",
+      "vrf_name": "Vrf45"
+    },
+    "Ethernet0.1000|1.2.3.0/24": {}
+  }
+}
+```
+
 ### vlans
 
 Example:
diff --git a/configdb/configdb.go b/configdb/configdb.go
@@ -12,34 +12,35 @@ import (
 )
 
 type ConfigDB struct {
-	ACLRules           map[string]ACLRule        `json:"ACL_RULE,omitempty"`
-	ACLTables          map[string]ACLTable       `json:"ACL_TABLE,omitempty"`
-	Breakouts          map[string]BreakoutConfig `json:"BREAKOUT_CFG,omitempty"`
-	DeviceMetadata     DeviceMetadata            `json:"DEVICE_METADATA"`
-	DNSNameservers     map[string]DNSNameserver  `json:"DNS_NAMESERVER,omitempty"`
-	Features           map[string]Feature        `json:"FEATURE,omitempty"`
-	Interfaces         map[string]Interface      `json:"INTERFACE,omitempty"`
-	LLDP               *LLDP                     `json:"LLDP,omitempty"`
-	LoopbackInterface  map[string]struct{}       `json:"LOOPBACK_INTERFACE,omitempty"`
-	MCLAGDomains       map[string]MCLAGDomain    `json:"MCLAG_DOMAIN,omitempty"`
-	MCLAGInterfaces    map[string]MCLAGInterface `json:"MCLAG_INTERFACE,omitempty"`
-	MCLAGUniqueIPs     map[string]MCLAGUniqueIP  `json:"MCLAG_UNIQUE_IP,omitempty"`
-	MgmtInterfaces     map[string]MgmtInterface  `json:"MGMT_INTERFACE,omitempty"`
-	MgmtPorts          map[string]MgmtPort       `json:"MGMT_PORT,omitempty"`
-	MgmtVRFConfig      MgmtVRFConfig             `json:"MGMT_VRF_CONFIG"`
-	NTP                NTP                       `json:"NTP"`
-	NTPServers         map[string]struct{}       `json:"NTP_SERVER,omitempty"`
-	Ports              map[string]Port           `json:"PORT,omitempty"`
-	PortChannels       map[string]PortChannel    `json:"PORTCHANNEL,omitempty"`
-	PortChannelMembers map[string]struct{}       `json:"PORTCHANNEL_MEMBER,omitempty"`
-	SAG                *SAG                      `json:"SAG,omitempty"`
-	VLANs              map[string]VLAN           `json:"VLAN,omitempty"`
-	VLANInterfaces     map[string]VLANInterface  `json:"VLAN_INTERFACE,omitempty"`
-	VLANMembers        map[string]VLANMember     `json:"VLAN_MEMBER,omitempty"`
-	VRFs               map[string]VRF            `json:"VRF,omitempty"`
-	VXLANEVPN          *VXLANEVPN                `json:"VXLAN_EVPN_NVO,omitempty"`
-	VXLANTunnels       map[string]VXLANTunnel    `json:"VXLAN_TUNNEL,omitempty"`
-	VXLANTunnelMap     VXLANTunnelMap            `json:"VXLAN_TUNNEL_MAP,omitempty"`
+	ACLRules           map[string]ACLRule          `json:"ACL_RULE,omitempty"`
+	ACLTables          map[string]ACLTable         `json:"ACL_TABLE,omitempty"`
+	Breakouts          map[string]BreakoutConfig   `json:"BREAKOUT_CFG,omitempty"`
+	DeviceMetadata     DeviceMetadata              `json:"DEVICE_METADATA"`
+	DNSNameservers     map[string]DNSNameserver    `json:"DNS_NAMESERVER,omitempty"`
+	Features           map[string]Feature          `json:"FEATURE,omitempty"`
+	Interfaces         map[string]Interface        `json:"INTERFACE,omitempty"`
+	LLDP               *LLDP                       `json:"LLDP,omitempty"`
+	LoopbackInterface  map[string]struct{}         `json:"LOOPBACK_INTERFACE,omitempty"`
+	MCLAGDomains       map[string]MCLAGDomain      `json:"MCLAG_DOMAIN,omitempty"`
+	MCLAGInterfaces    map[string]MCLAGInterface   `json:"MCLAG_INTERFACE,omitempty"`
+	MCLAGUniqueIPs     map[string]MCLAGUniqueIP    `json:"MCLAG_UNIQUE_IP,omitempty"`
+	MgmtInterfaces     map[string]MgmtInterface    `json:"MGMT_INTERFACE,omitempty"`
+	MgmtPorts          map[string]MgmtPort         `json:"MGMT_PORT,omitempty"`
+	MgmtVRFConfig      MgmtVRFConfig               `json:"MGMT_VRF_CONFIG"`
+	NTP                NTP                         `json:"NTP"`
+	NTPServers         map[string]struct{}         `json:"NTP_SERVER,omitempty"`
+	Ports              map[string]Port             `json:"PORT,omitempty"`
+	PortChannels       map[string]PortChannel      `json:"PORTCHANNEL,omitempty"`
+	PortChannelMembers map[string]struct{}         `json:"PORTCHANNEL_MEMBER,omitempty"`
+	SAG                *SAG                        `json:"SAG,omitempty"`
+	VLANs              map[string]VLAN             `json:"VLAN,omitempty"`
+	VLANInterfaces     map[string]VLANInterface    `json:"VLAN_INTERFACE,omitempty"`
+	VLANMembers        map[string]VLANMember       `json:"VLAN_MEMBER,omitempty"`
+	VLANSubinterfaces  map[string]VLANSubinterface `json:"VLAN_SUB_INTERFACE,omitempty"`
+	VRFs               map[string]VRF              `json:"VRF,omitempty"`
+	VXLANEVPN          *VXLANEVPN                  `json:"VXLAN_EVPN_NVO,omitempty"`
+	VXLANTunnels       map[string]VXLANTunnel      `json:"VXLAN_TUNNEL,omitempty"`
+	VXLANTunnelMap     VXLANTunnelMap              `json:"VXLAN_TUNNEL_MAP,omitempty"`
 }
 
 func GenerateConfigDB(input *values.Values, platform *p.Platform, currentDeviceMetadata DeviceMetadata) (*ConfigDB, error) {
@@ -99,6 +100,7 @@ func GenerateConfigDB(input *values.Values, platform *p.Platform, currentDeviceM
 		VLANs:              getVLANs(input.VLANs),
 		VLANInterfaces:     getVLANInterfaces(input.VLANs),
 		VLANMembers:        getVLANMembers(input.VLANs),
+		VLANSubinterfaces:  getVLANSubinterfaces(input.VLANSubinterfaces),
 		VRFs:               getVRFs(input.Interconnects, input.Ports, input.VLANs),
 		VXLANEVPN:          vxlanevpn,
 		VXLANTunnels:       vxlanTunnel,
@@ -530,6 +532,25 @@ func getVLANMembers(vlans []values.VLAN) map[string]VLANMember {
 	return vlanMembers
 }
 
+func getVLANSubinterfaces(subinterfaces []values.VLANSubinterface) map[string]VLANSubinterface {
+	vlanSubinterfaces := make(map[string]VLANSubinterface)
+
+	for _, sub := range subinterfaces {
+		newSubinterface := VLANSubinterface{
+			AdminStatus: AdminStatusUp,
+		}
+
+		if sub.VRF != "" {
+			newSubinterface.VRFName = sub.VRF
+		}
+
+		vlanSubinterfaces[fmt.Sprintf("%s.%s", sub.Port, sub.VLAN)] = newSubinterface
+		vlanSubinterfaces[fmt.Sprintf("%s.%s|%s", sub.Port, sub.VLAN, sub.CIDR)] = VLANSubinterface{}
+	}
+
+	return vlanSubinterfaces
+}
+
 func getVRFs(interconnects map[string]values.Interconnect, ports values.Ports, vlans []values.VLAN) map[string]VRF {
 	vrfs := make(map[string]VRF)
 
diff --git a/configdb/fields.go b/configdb/fields.go
@@ -211,6 +211,11 @@ type VLANMember struct {
 	TaggingMode TaggingMode `json:"tagging_mode,omitempty"`
 }
 
+type VLANSubinterface struct {
+	AdminStatus AdminStatus `json:"admin_status,omitempty"`
+	VRFName     string      `json:"vrf_name,omitempty"`
+}
+
 type VRF struct {
 	VNI string `json:"vni,omitempty"`
 }
diff --git a/tests/4/expected.json b/tests/4/expected.json
@@ -704,5 +704,12 @@
   "VLAN_INTERFACE": {
     "Vlan4000": {},
     "Vlan4000|10.255.1.1/24": {}
+  },
+  "VLAN_SUB_INTERFACE": {
+    "Ethernet0.1000": {
+      "admin_status": "up",
+      "vrf_name": "Vrf45"
+    },
+    "Ethernet0.1000|1.2.3.0/24": {}
   }
 }
diff --git a/tests/4/sonic-config.yaml b/tests/4/sonic-config.yaml
@@ -15,6 +15,12 @@ ntp:
     - 162.159.200.1
     - 162.159.200.123
 
+vlan_subinterfaces:
+  - cidr: 1.2.3.0/24
+    port: Ethernet0
+    vlan: 1000
+    vrf: Vrf45
+
 vlans:
   - id: 4000
     ip: 10.255.1.1/24
diff --git a/values/values.go b/values/values.go
@@ -109,9 +109,17 @@ type Values struct {
 	SAG                     SAG                     `yaml:"sag"`
 	SSHSourceranges         []string                `yaml:"ssh_sourceranges"`
 	VLANs                   []VLAN                  `yaml:"vlans"`
+	VLANSubinterfaces       []VLANSubinterface      `yaml:"vlan_subinterfaces"`
 	VTEP                    VTEP                    `yaml:"vtep"`
 }
 
+type VLANSubinterface struct {
+	CIDR string `yaml:"cidr"`
+	Port string `yaml:"port"`
+	VLAN string `yaml:"vlan"`
+	VRF  string `yaml:"vrf"`
+}
+
 type VLAN struct {
 	DHCPServers   []string `yaml:"dhcp_servers"`
 	ID            string   `yaml:"id"`

Original file line number	Diff line number	Diff line change
`@@ -211,6 +211,11 @@ type VLANMember struct {`
`211`	`211`	TaggingMode TaggingMode `json:"tagging_mode,omitempty"`
`212`	`212`	`}`
`213`	`213`
	`214`	`+type VLANSubinterface struct {`
	`215`	+ AdminStatus AdminStatus `json:"admin_status,omitempty"`
	`216`	+ VRFName string `json:"vrf_name,omitempty"`
	`217`	`+}`
	`218`	`+`
`214`	`219`	`type VRF struct {`
`215`	`220`	VNI string `json:"vni,omitempty"`
`216`	`221`	`}`
Original file line number	Diff line number	Diff line change
`@@ -704,5 +704,12 @@`
`704`	`704`	`"VLAN_INTERFACE": {`
`705`	`705`	`"Vlan4000": {},`
`706`	`706`	`"Vlan4000\|10.255.1.1/24": {}`
	`707`	`+ },`
	`708`	`+ "VLAN_SUB_INTERFACE": {`
	`709`	`+ "Ethernet0.1000": {`
	`710`	`+ "admin_status": "up",`
	`711`	`+ "vrf_name": "Vrf45"`
	`712`	`+ },`
	`713`	`+ "Ethernet0.1000\|1.2.3.0/24": {}`
`707`	`714`	`}`
`708`	`715`	`}`