1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286
|
# Author: Eric Benner <ebenner@vultr.com>
#
# This file is part of cloud-init. See LICENSE file for license information.
import json
import logging
import os
from functools import lru_cache
from requests import exceptions
from cloudinit import dmi, net, subp, url_helper, util
from cloudinit.net.dhcp import NoDHCPLeaseError
from cloudinit.net.ephemeral import EphemeralDHCPv4
# Get LOG
LOG = logging.getLogger(__name__)
@lru_cache()
def get_metadata(
distro, url, timeout, retries, sec_between, agent, tmp_dir=None
):
# Bring up interface (and try until one works)
exception = RuntimeError("Failed to DHCP")
# Seek iface with DHCP
for iface in get_interface_list():
try:
with EphemeralDHCPv4(
distro,
iface=iface,
connectivity_urls_data=[{"url": url}],
):
# Fetch the metadata
v1 = read_metadata(url, timeout, retries, sec_between, agent)
metadata = json.loads(v1)
refactor_metadata(metadata)
return metadata
except (
NoDHCPLeaseError,
subp.ProcessExecutionError,
RuntimeError,
exceptions.RequestException,
) as exc:
LOG.error("DHCP Exception: %s", exc)
exception = exc
raise exception
# Refactor metadata into acceptable format
def refactor_metadata(metadata):
metadata["instance-id"] = metadata["instance-v2-id"]
metadata["local-hostname"] = metadata["hostname"]
region = metadata["region"]["regioncode"]
if "countrycode" in metadata["region"]:
region = metadata["region"]["countrycode"]
metadata["region"] = region.lower()
# Get interface list, sort, and clean
def get_interface_list():
# Check for the presence of a "find_candidate_nics.sh" shell script on the
# running guest image. Use that as an optional source of truth before
# falling back to "net.find_candidate_nics()". This allows the Vultr team
# to provision machines with niche hardware configurations at the same
# cadence as image rollouts.
ifaces = []
try:
nic_script = "/opt/vultr/find_candidate_nics.sh"
if os.path.exists(nic_script):
out = subp.subp(nic_script, capture=True, shell=True)
for line in out.stdout.splitlines():
iface = line.strip()
if len(iface) > 0:
ifaces.append(iface)
except Exception as e:
LOG.error("find_candidate_nics script exception: %s", e)
if not ifaces:
for iface in net.find_candidate_nics():
# Skip dummy
if "dummy" in iface:
continue
ifaces.append(iface)
return ifaces
# Read the system information from SMBIOS
def get_sysinfo():
return {
"manufacturer": dmi.read_dmi_data("system-manufacturer"),
"subid": dmi.read_dmi_data("system-serial-number"),
}
# Assumes is Vultr is already checked
def is_baremetal():
if get_sysinfo()["manufacturer"] != "Vultr":
return True
return False
# Confirm is Vultr
def is_vultr():
# VC2, VDC, and HFC use DMI
sysinfo = get_sysinfo()
if sysinfo["manufacturer"] == "Vultr":
return True
# Baremetal requires a kernel parameter
if "vultr" in util.get_cmdline().split():
return True
return False
# Read Metadata endpoint
def read_metadata(url, timeout, retries, sec_between, agent):
url = "%s/v1.json" % url
# Announce os details so we can handle non Vultr origin
# images and provide correct vendordata generation.
headers = {"Metadata-Token": "cloudinit", "User-Agent": agent}
response = url_helper.readurl(
url,
timeout=timeout,
retries=retries,
headers=headers,
sec_between=sec_between,
)
if not response.ok():
raise RuntimeError(
"Failed to connect to %s: Code: %s" % url, response.code
)
return response.contents.decode()
# Wrapped for caching
@lru_cache()
def get_interface_map():
return net.get_interfaces_by_mac()
# Convert macs to nics
def get_interface_name(mac):
macs_to_nic = get_interface_map()
if mac not in macs_to_nic:
return None
return macs_to_nic.get(mac)
# Generate network configs
def generate_network_config(interfaces):
network = {
"version": 1,
"config": [
{
"type": "nameserver",
"address": ["108.61.10.10", "2001:19f0:300:1704::6"],
}
],
}
# Prepare interface 0, public
if len(interfaces) > 0:
public = generate_interface(interfaces[0], primary=True)
network["config"].append(public)
# Prepare additional interfaces, private
for i in range(1, len(interfaces)):
interface = interfaces[i]
# Skip interfaces set not to be configured
if interface.get("unconfigured"):
continue
private = generate_interface(interface)
network["config"].append(private)
return network
def generate_interface(interface, primary=False):
interface_name = get_interface_name(interface["mac"])
if not interface_name:
raise RuntimeError(
"Interface: %s could not be found on the system" % interface["mac"]
)
netcfg = {
"name": interface_name,
"type": "physical",
"mac_address": interface["mac"],
}
if primary:
netcfg["accept-ra"] = 1
netcfg["subnets"] = [
{"type": "dhcp", "control": "auto"},
{"type": "ipv6_slaac", "control": "auto"},
]
if not primary:
netcfg["subnets"] = [
{
"type": "static",
"control": "auto",
"address": interface["ipv4"]["address"],
"netmask": interface["ipv4"]["netmask"],
}
]
generate_interface_routes(interface, netcfg)
generate_interface_additional_addresses(interface, netcfg)
# Add config to template
return netcfg
def generate_interface_routes(interface, netcfg):
# Options that may or may not be used
if "mtu" in interface:
netcfg["mtu"] = interface["mtu"]
if "accept-ra" in interface:
netcfg["accept-ra"] = interface["accept-ra"]
if "routes" in interface:
netcfg["subnets"][0]["routes"] = interface["routes"]
def generate_interface_additional_addresses(interface, netcfg):
# Check for additional IP's
additional_count = len(interface["ipv4"]["additional"])
if "ipv4" in interface and additional_count > 0:
for additional in interface["ipv4"]["additional"]:
add = {
"type": "static",
"control": "auto",
"address": additional["address"],
"netmask": additional["netmask"],
}
if "routes" in additional:
add["routes"] = additional["routes"]
netcfg["subnets"].append(add)
# Check for additional IPv6's
additional_count = len(interface["ipv6"]["additional"])
if "ipv6" in interface and additional_count > 0:
for additional in interface["ipv6"]["additional"]:
add = {
"type": "static6",
"control": "auto",
"address": "%s/%s"
% (additional["network"], additional["prefix"]),
}
if "routes" in additional:
add["routes"] = additional["routes"]
netcfg["subnets"].append(add)
# Make required adjustments to the network configs provided
def add_interface_names(netcfg):
for interface in netcfg["config"]:
if interface["type"] != "physical":
continue
interface_name = get_interface_name(interface["mac_address"])
if not interface_name:
raise RuntimeError(
"Interface: %s could not be found on the system"
% interface["mac_address"]
)
interface["name"] = interface_name
|