feat(vmware): Convert imc network config to Networking config Version 2 #5937
+354
−403
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,38 +1,31 @@ | ||
| # Copyright (C) 2015 Canonical Ltd. | ||
| # Copyright (C) 2006-2024 Broadcom. All Rights Reserved. | ||
| # Broadcom Confidential. The term "Broadcom" refers to Broadcom Inc. | ||
| # and/or its subsidiaries. | ||
| # | ||
| # Author: Sankar Tanguturi <stanguturi@vmware.com> | ||
| # Pengpeng Sun <pengpeng.sun@broadcom.com> | ||
| # | ||
| # This file is part of cloud-init. See LICENSE file for license information. | ||
|
|
||
| import ipaddress | ||
| import logging | ||
| import os | ||
| import re | ||
|
|
||
| from cloudinit import net, subp, util | ||
| from cloudinit.net.network_state import ( | ||
| ipv4_mask_to_net_prefix, | ||
| ipv6_mask_to_net_prefix, | ||
| ) | ||
|
|
||
| logger = logging.getLogger(__name__) | ||
|
|
||
|
|
||
| class NicConfigurator: | ||
| def __init__( | ||
| self, nics, name_servers, dns_suffixes, use_system_devices=True | ||
| ): | ||
| """ | ||
| Initialize the Nic Configurator | ||
| @param nics (list) an array of nics to configure | ||
|
|
@@ -41,9 +34,9 @@ def __init__(self, nics, use_system_devices=True): | |
| the specified nics. | ||
| """ | ||
| self.nics = nics | ||
| self.name_servers = name_servers | ||
| self.dns_suffixes = dns_suffixes | ||
| self.mac2Name = {} | ||
|
|
||
| if use_system_devices: | ||
| self.find_devices() | ||
|
|
@@ -87,161 +80,163 @@ def find_devices(self): | |
| name = section.split(":", 1)[0] | ||
| self.mac2Name[mac] = name | ||
|
|
||
| def gen_one_nic_v2(self, nic): | ||
| """ | ||
| Return the config dict needed to configure a nic | ||
| @return (dict): the config dict to configure the nic | ||
| @param nic (NicBase): the nic to configure | ||
| """ | ||
| mac = nic.mac.lower() | ||
| name = self.mac2Name.get(mac) | ||
| if not name: | ||
| raise ValueError("No known device has MACADDR: %s" % nic.mac) | ||
|
|
||
| nic_config_dict = {} | ||
| generators = [ | ||
| self.gen_match(mac), | ||
| self.gen_set_name(name), | ||
| self.gen_wakeonlan(nic), | ||
| self.gen_dhcp4(nic), | ||
| self.gen_dhcp6(nic), | ||
| self.gen_addresses(nic), | ||
| self.gen_routes(nic), | ||
| self.gen_nameservers(), | ||
| ] | ||
| for value in generators: | ||
| if value: | ||
| nic_config_dict.update(value) | ||
|
|
||
| return {name: nic_config_dict} | ||
|
|
||
| def gen_match(self, mac): | ||
| return {"match": {"macaddress": mac}} | ||
|
|
||
| def gen_set_name(self, name): | ||
| return {"set-name": name} | ||
|
|
||
| def gen_wakeonlan(self, nic): | ||
| return {"wakeonlan": nic.onboot} | ||
|
|
||
| def gen_dhcp4(self, nic): | ||
|
There was a problem hiding this comment. Nit: for the rest of these methods, do you think it makes more sense to return There was a problem hiding this comment. Yes, return |
||
| dhcp4 = {} | ||
| bootproto = nic.bootProto.lower() | ||
| if nic.ipv4_mode.lower() == "disabled": | ||
| bootproto = "manual" | ||
| if bootproto != "static": | ||
| dhcp4.update({"dhcp4": True}) | ||
| # dhcp4-overrides | ||
| if self.name_servers or self.dns_suffixes: | ||
| dhcp4.update({"dhcp4-overrides": {"use-dns": False}}) | ||
| else: | ||
| dhcp4.update({"dhcp4": False}) | ||
| return dhcp4 | ||
|
|
||
| def gen_dhcp6(self, nic): | ||
| dhcp6 = {} | ||
| if nic.staticIpv6: | ||
| dhcp6.update({"dhcp6": False}) | ||
| # TODO: nic shall explicitly tell it's DHCP6 | ||
| # TODO: set dhcp6-overrides | ||
| return dhcp6 | ||
|
|
||
| def gen_addresses(self, nic): | ||
| address_list = [] | ||
| v4_cidr = 32 | ||
|
|
||
| # Static Ipv4 | ||
| v4_addrs = nic.staticIpv4 | ||
| if v4_addrs: | ||
| v4 = v4_addrs[0] | ||
| if v4.netmask: | ||
|
There was a problem hiding this comment. Is specifying netmask is optional during static ip setting? please correct me if I'm wrong here. I think netmask should be a mandatory field during static ip setting, also please add a test for the same. There was a problem hiding this comment. Per our API definition, netmask is optional for ipv4, if no netmask given,
but it's mandatory if static ipv6 address included.
I added 2 tests for both ipv4 and ipv6 cases. |
||
| v4_cidr = ipv4_mask_to_net_prefix(v4.netmask) | ||
| if v4.ip: | ||
| address_list.append(f"{v4.ip}/{v4_cidr}") | ||
| # Static Ipv6 | ||
| v6_addrs = nic.staticIpv6 | ||
| if v6_addrs: | ||
| for v6 in v6_addrs: | ||
| v6_cidr = ipv6_mask_to_net_prefix(v6.netmask) | ||
| address_list.append(f"{v6.ip}/{v6_cidr}") | ||
|
|
||
| if address_list: | ||
| return {"addresses": address_list} | ||
| else: | ||
| return {} | ||
|
|
||
| def gen_routes(self, nic): | ||
| route_list = [] | ||
| v4_cidr = 32 | ||
|
|
||
| # Ipv4 routes | ||
| v4_addrs = nic.staticIpv4 | ||
| if v4_addrs: | ||
| v4 = v4_addrs[0] | ||
| # Add the ipv4 default route | ||
| if nic.primary and v4.gateways: | ||
| route_list.append({"to": "0.0.0.0/0", "via": v4.gateways[0]}) | ||
| # Add ipv4 static routes if there is no primary nic | ||
| if not self._primaryNic and v4.gateways: | ||
| if v4.netmask: | ||
| v4_cidr = ipv4_mask_to_net_prefix(v4.netmask) | ||
| for gateway in v4.gateways: | ||
| v4_subnet = ipaddress.IPv4Network( | ||
| f"{gateway}/{v4_cidr}", strict=False | ||
| ) | ||
| route_list.append({"to": f"{v4_subnet}", "via": gateway}) | ||
| # Ipv6 routes | ||
| v6_addrs = nic.staticIpv6 | ||
| if v6_addrs: | ||
| for v6 in v6_addrs: | ||
| v6_cidr = ipv6_mask_to_net_prefix(v6.netmask) | ||
| # Add the ipv6 default route | ||
| if nic.primary and v6.gateway: | ||
| route_list.append({"to": "::/0", "via": v6.gateway}) | ||
| # Add ipv6 static routes if there is no primary nic | ||
| if not self._primaryNic and v6.gateway: | ||
| v6_subnet = ipaddress.IPv6Network( | ||
| f"{v6.gateway}/{v6_cidr}", strict=False | ||
| ) | ||
| route_list.append( | ||
| {"to": f"{v6_subnet}", "via": v6.gateway} | ||
| ) | ||
|
|
||
| if route_list: | ||
| return {"routes": route_list} | ||
| else: | ||
| return {} | ||
|
|
||
| def gen_nameservers(self): | ||
| nameservers_dict = {} | ||
| search_list = [] | ||
| addresses_list = [] | ||
| if self.dns_suffixes: | ||
| for dns_suffix in self.dns_suffixes: | ||
| search_list.append(dns_suffix) | ||
| if self.name_servers: | ||
| for name_server in self.name_servers: | ||
| addresses_list.append(name_server) | ||
| if search_list: | ||
| nameservers_dict.update({"search": search_list}) | ||
| if addresses_list: | ||
| nameservers_dict.update({"addresses": addresses_list}) | ||
|
|
||
| if nameservers_dict: | ||
| return {"nameservers": nameservers_dict} | ||
| else: | ||
| return {} | ||
|
|
||
| def generate(self, configure=False, osfamily=None): | ||
| """Return the config elements that are needed to configure the nics""" | ||
| if configure: | ||
| logger.info("Configuring the interfaces file") | ||
| self.configure(osfamily) | ||
|
|
||
| ethernets_dict = {} | ||
|
|
||
| for nic in self.nics: | ||
| ethernets_dict.update(self.gen_one_nic_v2(nic)) | ||
|
|
||
| return ethernets_dict | ||
|
|
||
| def clear_dhcp(self): | ||
| logger.info("Clearing DHCP leases") | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated, thanks.