Introduce origin to network interface info

In order to propagate network.Origin throughout we need to propagate the origin via the api server. To do this correctly means updating all the call sites to spit out the origin. That way we can then consume the interface info correctly for futher processing. This is a somewhat drastic change in that you have to touch all providers and container sites. I'm unclear as to what the origin type for the containers should be, but considering they act as providers in that sense and the machiner is the one checking for the observeable network interfaces that seemed to make sense. I've not put any tests up yet as I'm unsure if this is the way we actually want to go, but for me this is the cleaner design.
hatched · Apr 23, 2020 · 8544e6f · 8544e6f
1 parent c2d91cd
commit 8544e6f
Show file tree

Hide file tree

Showing 18 changed files with 63 additions and 6 deletions.
diff --git a/api/common/network.go b/api/common/network.go
@@ -108,7 +108,7 @@ func GetObservedNetworkConfig(source NetworkConfigSource) ([]params.NetworkConfi
 	sysClassNetPath := source.SysClassNetPath()
 	for _, nic := range interfaces {
 		nicType := network.ParseInterfaceType(sysClassNetPath, nic.Name)
-		nicConfig := interfaceToNetworkConfig(nic, nicType)
+		nicConfig := interfaceToNetworkConfig(nic, nicType, corenetwork.OriginMachine)
 		if nicConfig.InterfaceName == defaultRouteDevice {
 			nicConfig.IsDefaultGateway = true
 			nicConfig.GatewayAddress = defaultRoute.String()
@@ -168,7 +168,10 @@ func GetObservedNetworkConfig(source NetworkConfigSource) ([]params.NetworkConfi
 	return observedConfig, nil
 }
 
-func interfaceToNetworkConfig(nic net.Interface, nicType corenetwork.InterfaceType) params.NetworkConfig {
+func interfaceToNetworkConfig(nic net.Interface,
+	nicType corenetwork.InterfaceType,
+	networkOrigin corenetwork.Origin,
+) params.NetworkConfig {
 	configType := corenetwork.ConfigManual // assume manual initially, until we parse the address.
 	isUp := nic.Flags&net.FlagUp > 0
 	isLoopback := nic.Flags&net.FlagLoopback > 0
@@ -191,6 +194,7 @@ func interfaceToNetworkConfig(nic net.Interface, nicType corenetwork.InterfaceTy
 		InterfaceType: string(nicType),
 		NoAutoStart:   !isUp,
 		Disabled:      !isUp,
+		NetworkOrigin: params.NetworkOrigin(networkOrigin),
 	}
 }
 

diff --git a/api/common/network_test.go b/api/common/network_test.go
@@ -217,6 +217,7 @@ func (s *NetworkSuite) TestGetObservedNetworkConfigNoInterfaceAddresses(c *gc.C)
 		InterfaceName: "br-eth1",
 		InterfaceType: "bridge",
 		ConfigType:    "manual",
+		NetworkOrigin: params.NetworkOrigin("machine"),
 	}})
 
 	s.stubConfigSource.CheckCallNames(c, "Interfaces", "DefaultRoute", "SysClassNetPath", "InterfaceAddresses")
@@ -237,6 +238,7 @@ func (s *NetworkSuite) TestGetObservedNetworkConfigLoopbackInferred(c *gc.C) {
 		InterfaceName: "lo",
 		InterfaceType: "loopback", // inferred from the flags.
 		ConfigType:    "loopback", // since it is a loopback
+		NetworkOrigin: params.NetworkOrigin("machine"),
 	}, {
 		DeviceIndex:   1,
 		CIDR:          "::1/128",
@@ -245,6 +247,7 @@ func (s *NetworkSuite) TestGetObservedNetworkConfigLoopbackInferred(c *gc.C) {
 		InterfaceName: "lo",
 		InterfaceType: "loopback",
 		ConfigType:    "loopback",
+		NetworkOrigin: params.NetworkOrigin("machine"),
 	}})
 
 	s.stubConfigSource.CheckCallNames(c, "Interfaces", "DefaultRoute", "SysClassNetPath", "InterfaceAddresses")
@@ -270,6 +273,7 @@ func (s *NetworkSuite) TestGetObservedNetworkConfigVLANInferred(c *gc.C) {
 		InterfaceName: "eth0.100",
 		InterfaceType: "802.1q",
 		ConfigType:    "manual", // the IPv6 address treated as empty.
+		NetworkOrigin: params.NetworkOrigin("machine"),
 	}, {
 		DeviceIndex:   13,
 		CIDR:          "10.100.19.0/24",
@@ -279,6 +283,7 @@ func (s *NetworkSuite) TestGetObservedNetworkConfigVLANInferred(c *gc.C) {
 		InterfaceName: "eth0.100",
 		InterfaceType: "802.1q",
 		ConfigType:    "static",
+		NetworkOrigin: params.NetworkOrigin("machine"),
 	}})
 
 	s.stubConfigSource.CheckCallNames(c, "Interfaces", "DefaultRoute", "SysClassNetPath", "InterfaceAddresses")
@@ -298,6 +303,7 @@ func (s *NetworkSuite) TestGetObservedNetworkConfigEthernetInfrerred(c *gc.C) {
 		InterfaceName: "eth0",
 		InterfaceType: "ethernet",
 		ConfigType:    "manual", // the IPv6 address treated as empty.
+		NetworkOrigin: params.NetworkOrigin("machine"),
 	}})
 
 	s.stubConfigSource.CheckCallNames(c, "Interfaces", "DefaultRoute", "SysClassNetPath", "InterfaceAddresses")
@@ -323,6 +329,7 @@ func (s *NetworkSuite) TestGetObservedNetworkConfigBridgePortsHaveParentSet(c *g
 		InterfaceType:       "ethernet",
 		ParentInterfaceName: "br-eth0",
 		ConfigType:          "manual",
+		NetworkOrigin:       params.NetworkOrigin("machine"),
 	}, {
 		DeviceIndex:   10,
 		CIDR:          "10.20.19.0/24",
@@ -332,6 +339,7 @@ func (s *NetworkSuite) TestGetObservedNetworkConfigBridgePortsHaveParentSet(c *g
 		InterfaceName: "br-eth0",
 		InterfaceType: "bridge",
 		ConfigType:    "static",
+		NetworkOrigin: params.NetworkOrigin("machine"),
 	}, {
 		DeviceIndex:   10,
 		CIDR:          "10.20.19.0/24",
@@ -341,13 +349,15 @@ func (s *NetworkSuite) TestGetObservedNetworkConfigBridgePortsHaveParentSet(c *g
 		InterfaceName: "br-eth0",
 		InterfaceType: "bridge",
 		ConfigType:    "static",
+		NetworkOrigin: params.NetworkOrigin("machine"),
 	}, {
 		DeviceIndex:   10,
 		MACAddress:    "aa:bb:cc:dd:ee:f0",
 		MTU:           1500,
 		InterfaceName: "br-eth0",
 		InterfaceType: "bridge",
 		ConfigType:    "manual",
+		NetworkOrigin: params.NetworkOrigin("machine"),
 	}, {
 		DeviceIndex:   11,
 		CIDR:          "10.20.19.0/24",
@@ -357,13 +367,15 @@ func (s *NetworkSuite) TestGetObservedNetworkConfigBridgePortsHaveParentSet(c *g
 		InterfaceName: "br-eth1",
 		InterfaceType: "bridge",
 		ConfigType:    "static",
+		NetworkOrigin: params.NetworkOrigin("machine"),
 	}, {
 		DeviceIndex:   11,
 		MACAddress:    "aa:bb:cc:dd:ee:f1",
 		MTU:           1500,
 		InterfaceName: "br-eth1",
 		InterfaceType: "bridge",
 		ConfigType:    "manual",
+		NetworkOrigin: params.NetworkOrigin("machine"),
 	}, {
 		DeviceIndex:         3,
 		MACAddress:          "aa:bb:cc:dd:ee:f1",
@@ -374,6 +386,7 @@ func (s *NetworkSuite) TestGetObservedNetworkConfigBridgePortsHaveParentSet(c *g
 		ConfigType:          "manual",
 		GatewayAddress:      "1.2.3.4",
 		IsDefaultGateway:    true,
+		NetworkOrigin:       params.NetworkOrigin("machine"),
 	}})
 
 	s.stubConfigSource.CheckCallNames(c,
@@ -410,6 +423,7 @@ func (s *NetworkSuite) TestGetObservedNetworkConfigAddressNotInCIDRFormat(c *gc.
 		InterfaceName: "eth0",
 		InterfaceType: "ethernet",
 		ConfigType:    "static",
+		NetworkOrigin: params.NetworkOrigin("machine"),
 	}})
 
 	s.stubConfigSource.CheckCallNames(c, "Interfaces", "DefaultRoute", "SysClassNetPath", "InterfaceAddresses")
@@ -432,6 +446,7 @@ func (s *NetworkSuite) TestGetObservedNetworkConfigEmptyAddressValue(c *gc.C) {
 		InterfaceName: "eth0",
 		InterfaceType: "ethernet",
 		ConfigType:    "manual",
+		NetworkOrigin: params.NetworkOrigin("machine"),
 	}})
 
 	s.stubConfigSource.CheckCallNames(c, "Interfaces", "DefaultRoute", "SysClassNetPath", "InterfaceAddresses")

diff --git a/api/provisioner/provisioner.go b/api/provisioner/provisioner.go
@@ -263,8 +263,9 @@ func (st *State) GetContainerInterfaceInfo(containerTag names.MachineTag) ([]cor
 // the method and the network.InterfaceInfo type to be called
 // InterfaceConfig.
 func (st *State) prepareOrGetContainerInterfaceInfo(
-	containerTag names.MachineTag, allocateNewAddress bool) (
-	[]corenetwork.InterfaceInfo, error) {
+	containerTag names.MachineTag,
+	allocateNewAddress bool,
+) ([]corenetwork.InterfaceInfo, error) {
 	var result params.MachineNetworkConfigResults
 	args := params.Entities{
 		Entities: []params.Entity{{Tag: containerTag.String()}},

diff --git a/apiserver/common/networkingcommon/networkconfigapi.go b/apiserver/common/networkingcommon/networkconfigapi.go
@@ -224,9 +224,9 @@ func (api *NetworkConfigAPI) getOneMachineProviderNetworkConfig(m *state.Machine
 }
 
 func (api *NetworkConfigAPI) setLinkLayerDevicesAndAddresses(
-	m *state.Machine, ifaces []network.InterfaceInfo,
+	m *state.Machine, interfaceInfos []network.InterfaceInfo,
 ) error {
-	devicesArgs, devicesAddrs := NetworkInterfacesToStateArgs(ifaces)
+	devicesArgs, devicesAddrs := NetworkInterfacesToStateArgs(interfaceInfos)
 
 	logger.Debugf("setting devices: %+v", devicesArgs)
 	if err := m.SetParentLinkLayerDevicesBeforeTheirChildren(devicesArgs); err != nil {

diff --git a/apiserver/params/network.go b/apiserver/params/network.go
@@ -69,6 +69,10 @@ type NetworkRoute struct {
 	Metric int `json:"metric"`
 }
 
+// NetworkOrigin specifies where an address comes from, whether it was reported
+// by a provider or by a machine.
+type NetworkOrigin string
+
 // NetworkConfig describes the necessary information to configure
 // a single network interface on a machine. This mostly duplicates
 // network.InterfaceInfo type and it's defined here so it can be kept
@@ -185,6 +189,13 @@ type NetworkConfig struct {
 
 	// IsDefaultGateway marks an interface that is a default gateway for a machine.
 	IsDefaultGateway bool `json:"is-default-gateway,omitempty"`
+
+	// NetworkOrigin represents the authoritative source of the NetworkConfig.
+	// It is expected that either the provider gave us this info or the
+	// machine gave us this info.
+	// Giving us this information allows us to reason about when a InterfaceInfo
+	// is in use.
+	NetworkOrigin NetworkOrigin `json:"origin,omitempty"`
 }
 
 // NetworkConfigFromInterfaceInfo converts a slice of network.InterfaceInfo into
@@ -234,6 +245,7 @@ func NetworkConfigFromInterfaceInfo(interfaceInfos []network.InterfaceInfo) []Ne
 			GatewayAddress:   v.GatewayAddress.Value,
 			Routes:           routes,
 			IsDefaultGateway: v.IsDefaultGateway,
+			NetworkOrigin:    NetworkOrigin(v.Origin),
 		}
 	}
 	return result
@@ -278,6 +290,7 @@ func InterfaceInfoFromNetworkConfig(configs []NetworkConfig) []network.Interface
 			GatewayAddress:      network.NewProviderAddress(v.GatewayAddress),
 			Routes:              routes,
 			IsDefaultGateway:    v.IsDefaultGateway,
+			Origin:              network.Origin(v.NetworkOrigin),
 		}
 
 		// Compatibility layer for older clients that do not populate

diff --git a/container/lxd/network.go b/container/lxd/network.go
@@ -433,6 +433,7 @@ func InterfaceInfoFromDevices(nics map[string]device) ([]corenetwork.InterfaceIn
 			ParentInterfaceName: device["parent"],
 			MACAddress:          device["hwaddr"],
 			ConfigType:          corenetwork.ConfigDHCP,
+			Origin:              corenetwork.OriginProvider,
 		}
 		if device["mtu"] != "" {
 			mtu, err := strconv.Atoi(device["mtu"])

diff --git a/core/network/nic.go b/core/network/nic.go
@@ -182,6 +182,13 @@ type InterfaceInfo struct {
 
 	// IsDefaultGateway is set if this device is a default gw on a machine.
 	IsDefaultGateway bool
+
+	// Origin represents the authoritative source of the InterfaceInfo.
+	// It is expected that either the provider gave us this info or the
+	// machine gave us this info.
+	// Giving us this information allows us to reason about when a InterfaceInfo
+	// is in use.
+	Origin Origin
 }
 
 type interfaceInfoSlice []InterfaceInfo

diff --git a/provider/dummy/environs.go b/provider/dummy/environs.go
@@ -1473,6 +1473,7 @@ func (env *environ) NetworkInterfaces(ctx context.ProviderCallContext, ids []ins
 				GatewayAddress: corenetwork.NewProviderAddress(
 					fmt.Sprintf("0.%d.0.1", (i+1)*10+idIndex),
 				),
+				Origin: corenetwork.OriginProvider,
 			}
 		}
 

diff --git a/provider/dummy/environs_test.go b/provider/dummy/environs_test.go
@@ -253,6 +253,7 @@ func (s *suite) TestNetworkInterfaces(c *gc.C) {
 		Addresses:        corenetwork.ProviderAddresses{corenetwork.NewProviderAddress("0.10.0.2")},
 		DNSServers:       corenetwork.NewProviderAddresses("ns1.dummy", "ns2.dummy"),
 		GatewayAddress:   corenetwork.NewProviderAddress("0.10.0.1"),
+		Origin:           corenetwork.OriginProvider,
 	}, {
 		ProviderId:       "dummy-eth1",
 		ProviderSubnetId: "dummy-public",
@@ -268,6 +269,7 @@ func (s *suite) TestNetworkInterfaces(c *gc.C) {
 		Addresses:        corenetwork.ProviderAddresses{corenetwork.NewProviderAddress("0.20.0.2")},
 		DNSServers:       corenetwork.NewProviderAddresses("ns1.dummy", "ns2.dummy"),
 		GatewayAddress:   corenetwork.NewProviderAddress("0.20.0.1"),
+		Origin:           corenetwork.OriginProvider,
 	}, {
 		ProviderId:       "dummy-eth2",
 		ProviderSubnetId: "dummy-disabled",
@@ -283,6 +285,7 @@ func (s *suite) TestNetworkInterfaces(c *gc.C) {
 		Addresses:        corenetwork.ProviderAddresses{corenetwork.NewProviderAddress("0.30.0.2")},
 		DNSServers:       corenetwork.NewProviderAddresses("ns1.dummy", "ns2.dummy"),
 		GatewayAddress:   corenetwork.NewProviderAddress("0.30.0.1"),
+		Origin:           corenetwork.OriginProvider,
 	}}
 	infoList, err := e.NetworkInterfaces(s.callCtx, []instance.Id{instance.Id("i-42")})
 	c.Assert(err, jc.ErrorIsNil)

diff --git a/provider/ec2/environ.go b/provider/ec2/environ.go
@@ -1192,6 +1192,7 @@ func mapNetworkInterface(iface ec2.NetworkInterface, subnet ec2.Subnet) corenetw
 		Addresses: corenetwork.ProviderAddresses{
 			corenetwork.NewScopedProviderAddress(iface.PrivateIPAddress, corenetwork.ScopeCloudLocal),
 		},
+		Origin: corenetwork.OriginProvider,
 	}
 
 	for _, privAddr := range iface.PrivateIPs {

diff --git a/provider/ec2/local_test.go b/provider/ec2/local_test.go
@@ -1719,6 +1719,7 @@ func (t *localServerSuite) assertInterfaceLooksValid(c *gc.C, expIfaceID, expDev
 			),
 		},
 		AvailabilityZones: zones,
+		Origin:            corenetwork.OriginProvider,
 	}
 	c.Assert(iface, gc.DeepEquals, expectedInterface)
 }

diff --git a/provider/gce/environ_network.go b/provider/gce/environ_network.go
@@ -223,6 +223,7 @@ func (e *environ) NetworkInterfaces(ctx context.ProviderCallContext, ids []insta
 				Disabled:        false,
 				NoAutoStart:     false,
 				ConfigType:      corenetwork.ConfigDHCP,
+				Origin:          corenetwork.OriginProvider,
 			})
 		}
 	}

diff --git a/provider/maas/devices.go b/provider/maas/devices.go
@@ -205,6 +205,7 @@ func (env *maasEnviron) deviceInterfaceInfo(deviceID instance.Id, nameToParentNa
 			Disabled:            !nic.Enabled,
 			NoAutoStart:         !nic.Enabled,
 			ParentInterfaceName: nameToParentName[nic.Name],
+			Origin:              corenetwork.OriginProvider,
 		}
 
 		if len(nic.Links) == 0 {
@@ -282,6 +283,7 @@ func (env *maasEnviron) deviceInterfaceInfo2(
 			Disabled:            !nic.Enabled(),
 			NoAutoStart:         !nic.Enabled(),
 			ParentInterfaceName: nameToParentName[nic.Name()],
+			Origin:              corenetwork.OriginProvider,
 		}
 		for _, link := range nic.Links() {
 			subnet := link.Subnet()

diff --git a/provider/maas/interfaces.go b/provider/maas/interfaces.go
@@ -236,6 +236,7 @@ func maasObjectNetworkInterfaces(
 			ParentInterfaceName: parentName,
 			Disabled:            !iface.Enabled,
 			NoAutoStart:         !iface.Enabled,
+			Origin:              corenetwork.OriginProvider,
 		}
 
 		if len(iface.Links) == 0 {
@@ -357,6 +358,7 @@ func maas2NetworkInterfaces(
 			ParentInterfaceName: parentName,
 			Disabled:            !iface.Enabled(),
 			NoAutoStart:         !iface.Enabled(),
+			Origin:              corenetwork.OriginProvider,
 		}
 
 		if len(iface.Links()) == 0 {

diff --git a/provider/oci/networking.go b/provider/oci/networking.go
@@ -1102,6 +1102,7 @@ func (e *Environ) networkInterfacesForInstance(ctx envcontext.ProviderCallContex
 			InterfaceType:    corenetwork.EthernetInterface,
 			ProviderSubnetId: corenetwork.Id(*iface.Vnic.SubnetId),
 			CIDR:             *subnet.CidrBlock,
+			Origin:           corenetwork.OriginProvider,
 		}
 		if iface.Vnic.PublicIp != nil {
 			nic.ShadowAddresses = append(nic.ShadowAddresses,

diff --git a/provider/openstack/provider.go b/provider/openstack/provider.go
@@ -1442,6 +1442,7 @@ func (e *Environ) networksForInstance(
 			MACAddress:    port.MACAddress,
 			Addresses:     corenetwork.NewProviderAddresses(ips...),
 			ConfigType:    corenetwork.ConfigDHCP,
+			Origin:        corenetwork.OriginProvider,
 		}
 	}
 

diff --git a/provider/oracle/network/environ.go b/provider/oracle/network/environ.go
@@ -227,6 +227,7 @@ func (e Environ) networkInterfacesForInstance(ctx context.ProviderCallContext, i
 				corenetwork.NewScopedProviderAddress(ip, corenetwork.ScopeCloudLocal),
 			},
 			InterfaceType: corenetwork.EthernetInterface,
+			Origin:        corenetwork.OriginProvider,
 		}
 
 		for _, ipAssocName := range deviceAttributes.Ipassociations {

diff --git a/provider/vsphere/environ_broker.go b/provider/vsphere/environ_broker.go
@@ -155,6 +155,7 @@ func (env *sessionEnviron) newRawInstance(
 		MACAddress:    internalMac,
 		InterfaceType: corenetwork.EthernetInterface,
 		ConfigType:    corenetwork.ConfigDHCP,
+		Origin:        corenetwork.OriginProvider,
 	}}
 	networkDevices := []vsphereclient.NetworkDevice{{MAC: internalMac, Network: env.ecfg.primaryNetwork()}}
 
@@ -171,6 +172,7 @@ func (env *sessionEnviron) newRawInstance(
 			MACAddress:    externalMac,
 			InterfaceType: corenetwork.EthernetInterface,
 			ConfigType:    corenetwork.ConfigDHCP,
+			Origin:        corenetwork.OriginProvider,
 		})
 		networkDevices = append(networkDevices, vsphereclient.NetworkDevice{MAC: externalMac, Network: externalNetwork})
 	}
-Original file line number
+Diff line change
@@ Expand Up @@
     				GatewayAddress: corenetwork.NewProviderAddress(
     					fmt.Sprintf("0.%d.0.1", (i+1)*10+idIndex),
     				),
+    				Origin: corenetwork.OriginProvider,
     			}
     		}
@@ Expand Down @@