Add switch to add VTEP with no VXLAN tunnel maps configured (#18)

Author: iljarotar

configdb/configdb.go

@@ -43,6 +43,13 @@ type ConfigDB struct {
 }
 
 func GenerateConfigDB(input *values.Values, platform *p.Platform, currentDeviceMetadata DeviceMetadata) (*ConfigDB, error) {
+	if input == nil {
+		return nil, fmt.Errorf("no input values provided")
+	}
+	if platform == nil {
+		return nil, fmt.Errorf("no platform information provided")
+	}
+
 	ports, breakouts, err := getPortsAndBreakouts(input.Ports, input.Breakouts, platform)
 	if err != nil {
 		return nil, err
@@ -55,25 +62,22 @@ func GenerateConfigDB(input *values.Values, platform *p.Platform, currentDeviceM
 
 	features := getFeatures(input.Features)
 	rules, tables := getACLRulesAndTables(input.SSHSourceranges)
-	vxlanevpn, vxlanTunnel, vxlanTunnelMap := getVXLAN(input.VTEPs, input.LoopbackAddress)
+	vxlanevpn, vxlanTunnel, vxlanTunnelMap := getVXLAN(input.VTEP, input.LoopbackAddress)
 
 	configdb := ConfigDB{
-		ACLRules:       rules,
-		ACLTables:      tables,
-		Breakouts:      breakouts,
-		DeviceMetadata: *deviceMetadata,
-		DNSNameservers: getDNSNameservers(input.Nameservers),
-		Features:       features,
-		Interfaces:     getInterfaces(input.Ports, input.BGPPorts, input.Interconnects),
-		LLDP:           getLLDP(input.LLDPHelloTime),
-		LoopbackInterface: map[string]struct{}{
-			"Loopback0": {},
-			"Loopback0|" + input.LoopbackAddress + "/32": {},
-		},
-		MCLAGDomains:    getMCLAGDomains(input.MCLAG),
-		MCLAGInterfaces: getMCLAGInterfaces(input.MCLAG),
-		MCLAGUniqueIPs:  getMCLAGUniqueIPs(input.MCLAG),
-		MgmtInterfaces:  getMgmtInterfaces(input.MgmtInterface),
+		ACLRules:          rules,
+		ACLTables:         tables,
+		Breakouts:         breakouts,
+		DeviceMetadata:    *deviceMetadata,
+		DNSNameservers:    getDNSNameservers(input.Nameservers),
+		Features:          features,
+		Interfaces:        getInterfaces(input.Ports, input.BGPPorts, input.Interconnects),
+		LLDP:              getLLDP(input.LLDPHelloTime),
+		LoopbackInterface: getLoopbackInterface(input.LoopbackAddress),
+		MCLAGDomains:      getMCLAGDomains(input.MCLAG),
+		MCLAGInterfaces:   getMCLAGInterfaces(input.MCLAG),
+		MCLAGUniqueIPs:    getMCLAGUniqueIPs(input.MCLAG),
+		MgmtInterfaces:    getMgmtInterfaces(input.MgmtInterface),
 		MgmtPorts: map[string]MgmtPort{
 			"eth0": {
 				AdminStatus: AdminStatusUp,
@@ -163,18 +167,16 @@ func getACLRulesAndTables(sourceRanges []string) (map[string]ACLRule, map[string
 }
 
 func getDeviceMetadata(input *values.Values, currentMetadata DeviceMetadata) (*DeviceMetadata, error) {
-	hint := "remove current config_db.json and run `config-setup factory` to generate an initial config_db.json with all the necessary information"
-
 	if currentMetadata.Localhost.Platform == "" {
-		return nil, fmt.Errorf("missing platform from current device metadata\nhint: %s", hint)
+		return nil, fmt.Errorf("missing platform from current device metadata")
 	}
 
 	if currentMetadata.Localhost.HWSKU == "" {
-		return nil, fmt.Errorf("missing hwsku from current device metadata\nhint: %s", hint)
+		return nil, fmt.Errorf("missing hwsku from current device metadata")
 	}
 
 	if currentMetadata.Localhost.MAC == "" {
-		return nil, fmt.Errorf("missing mac from current device metadata\nhint: %s", hint)
+		return nil, fmt.Errorf("missing mac from current device metadata")
 	}
 
 	return &DeviceMetadata{
@@ -265,6 +267,17 @@ func getLLDP(interval int) *LLDP {
 	}
 }
 
+func getLoopbackInterface(loopback string) map[string]struct{} {
+	if loopback == "" {
+		return nil
+	}
+
+	return map[string]struct{}{
+		"Loopback0":                              {},
+		fmt.Sprintf("Loopback0|%s/32", loopback): {},
+	}
+}
+
 func getMCLAGDomains(mclag values.MCLAG) map[string]MCLAGDomain {
 	if mclag.KeepaliveVLAN == "" {
 		return nil
@@ -549,8 +562,12 @@ func getVRFs(interconnects map[string]values.Interconnect, ports values.Ports, v
 	return vrfs
 }
 
-func getVXLAN(vteps []values.VTEP, loopback string) (*VXLANEVPN, map[string]VXLANTunnel, VXLANTunnelMap) {
-	if len(vteps) == 0 {
+func getVXLAN(vtep values.VTEP, loopback string) (*VXLANEVPN, map[string]VXLANTunnel, VXLANTunnelMap) {
+	if !vtep.Enabled && len(vtep.VXLANTunnelMaps) == 0 {
+		return nil, nil, nil
+	}
+
+	if loopback == "" {
 		return nil, nil, nil
 	}
 
@@ -568,7 +585,7 @@ func getVXLAN(vteps []values.VTEP, loopback string) (*VXLANEVPN, map[string]VXLA
 
 	vxlanTunnelMap := make(VXLANTunnelMap)
 
-	for _, vtep := range vteps {
+	for _, vtep := range vtep.VXLANTunnelMaps {
 		vxlanTunnelMap["vtep|map_"+vtep.VNI+"_"+vtep.VLAN] = VXLANTunnelMapEntry{
 			VLAN: vtep.VLAN,
 			VNI:  vtep.VNI,

tests/1/sonic-config.yaml

@@ -101,6 +101,7 @@ vlans:
     vrf: Vrf45
   - id: 4001
 
-vteps:
-  - vni: 103999
-    vlan: Vlan3999
+vtep:
+  vxlan_tunnel_maps:
+    - vni: 103999
+      vlan: Vlan3999

tests/2/expected.json

@@ -522,5 +522,15 @@
     "Vlan4000": {},
     "Vlan4000|10.9.7.0": {},
     "Vlan4001": {}
+  },
+  "VXLAN_EVPN_NVO": {
+    "nvo": {
+      "source_vtep": "vtep"
+    }
+  },
+  "VXLAN_TUNNEL": {
+    "vtep": {
+      "src_ip": "10.7.7.7"
+    }
   }
 }

tests/2/sonic-config.yaml

@@ -55,3 +55,6 @@ vlans:
       - 10.9.8.6
     ip: 10.9.7.0
   - id: 4001
+
+vtep:
+  enabled: true

tests/3/expected.json

@@ -187,10 +187,6 @@
       "vrf_name": "VrfInternet"
     }
   },
-  "LOOPBACK_INTERFACE": {
-    "Loopback0": {},
-    "Loopback0|10.0.0.2/32": {}
-  },
   "MGMT_PORT": {
     "eth0": {
       "admin_status": "up",
@@ -720,21 +716,5 @@
   },
   "VRF": {
     "VrfInternet": {}
-  },
-  "VXLAN_EVPN_NVO": {
-    "nvo": {
-      "source_vtep": "vtep"
-    }
-  },
-  "VXLAN_TUNNEL": {
-    "vtep": {
-      "src_ip": "10.0.0.2"
-    }
-  },
-  "VXLAN_TUNNEL_MAP": {
-    "vtep|map_104009_Vlan4009": {
-      "vlan": "Vlan4009",
-      "vni": "104009"
-    }
   }
 }

tests/3/sonic-config.yaml

@@ -1,12 +1,10 @@
----
 bgp_ports:
   - Ethernet0
   - Ethernet1
 
 docker_routing_config_mode: split
 frr_mgmt_framework_config: true
 hostname: mgmtspine
-loopback_address: 10.0.0.2
 mgmt_vrf: false
 
 ntp:
@@ -46,6 +44,5 @@ vlans:
       - Ethernet47
   - id: 4009
 
-vteps:
-  - vni: 104009
-    vlan: Vlan4009
+vtep:
+  enabled: true

values/values.go

@@ -51,15 +51,15 @@ type MgmtInterface struct {
 }
 
 type NTP struct {
-	SrcInterface string   `yaml:"src_interface"`
 	Servers      []string `yaml:"servers"`
+	SrcInterface string   `yaml:"src_interface"`
 	VRF          string   `yaml:"vrf"`
 }
 
 type Port struct {
 	Autoneg AutonegMode `yaml:"autoneg"`
-	IPs     []string    `yaml:"ips"`
 	FECMode FECMode     `yaml:"fec"`
+	IPs     []string    `yaml:"ips"`
 	MTU     int         `yaml:"mtu"`
 	Name    string      `yaml:"name"`
 	Speed   int         `yaml:"speed"`
@@ -109,7 +109,7 @@ type Values struct {
 	SAG                     SAG                     `yaml:"sag"`
 	SSHSourceranges         []string                `yaml:"ssh_sourceranges"`
 	VLANs                   []VLAN                  `yaml:"vlans"`
-	VTEPs                   []VTEP                  `yaml:"vteps"`
+	VTEP                    VTEP                    `yaml:"vtep"`
 }
 
 type VLAN struct {
@@ -123,6 +123,11 @@ type VLAN struct {
 }
 
 type VTEP struct {
+	Enabled         bool             `yaml:"enabled"`
+	VXLANTunnelMaps []VXLANTunnelMap `yaml:"vxlan_tunnel_maps"`
+}
+
+type VXLANTunnelMap struct {
 	VNI  string `yaml:"vni"`
 	VLAN string `yaml:"vlan"`
 }