/usr/lib/python2.7/dist-packages/maasserver/preseed.py is in python-django-maas 1.5+bzr2252-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 | # Copyright 2012-2014 Canonical Ltd. This software is licensed under the
# GNU Affero General Public License version 3 (see the file LICENSE).
"""Preseed generation."""
from __future__ import (
absolute_import,
print_function,
unicode_literals,
)
str = None
__metaclass__ = type
__all__ = [
'compose_enlistment_preseed_url',
'compose_preseed_url',
'get_curtin_userdata',
'get_enlist_preseed',
'get_preseed',
'get_preseed_context',
]
from collections import namedtuple
from os.path import join
from pipes import quote
from urllib import urlencode
from urlparse import urlparse
from curtin.pack import pack_install
from django.conf import settings
from maasserver.compose_preseed import (
compose_cloud_init_preseed,
compose_preseed,
)
from maasserver.enum import (
NODE_STATUS,
NODEGROUPINTERFACE_MANAGEMENT,
PRESEED_TYPE,
USERDATA_TYPE,
)
from maasserver.exceptions import MAASAPIException
from maasserver.models import (
BootImage,
Config,
DHCPLease,
)
from maasserver.server_address import get_maas_facing_server_host
from maasserver.third_party_drivers import get_third_party_driver
from maasserver.utils import absolute_reverse
from metadataserver.commissioning.snippets import get_snippet_context
from metadataserver.models import NodeKey
from netaddr import IPAddress
import tempita
GENERIC_FILENAME = 'generic'
def get_enlist_preseed(nodegroup=None):
"""Return the enlistment preseed.
:param nodegroup: The nodegroup used to generate the preseed.
:return: The rendered preseed string.
:rtype: unicode.
"""
return render_enlistment_preseed(
PRESEED_TYPE.ENLIST, nodegroup=nodegroup)
def get_enlist_userdata(nodegroup=None):
"""Return the enlistment preseed.
:param nodegroup: The nodegroup used to generate the preseed.
:return: The rendered enlistment user-data string.
:rtype: unicode.
"""
return render_enlistment_preseed(
USERDATA_TYPE.ENLIST, nodegroup=nodegroup)
def get_curtin_userdata(node):
"""Return the curtin user-data.
:param node: The node for which to generate the user-data.
:return: The rendered user-data string.
:rtype: unicode.
"""
installer_url = get_curtin_installer_url(node)
config = get_curtin_config(node)
return pack_install(configs=[config], args=[installer_url])
def get_curtin_installer_url(node):
"""Return the URL where curtin on the node can download its installer."""
series = node.get_distro_series()
cluster_host = pick_cluster_controller_address(node)
# XXX rvb(?): The path shouldn't be hardcoded like this, but rather synced
# somehow with the content of contrib/maas-cluster-http.conf.
arch, subarch = node.architecture.split('/')
purpose = 'xinstall'
image = BootImage.objects.get_latest_image(
node.nodegroup, arch, subarch, series, purpose)
if image is None:
raise MAASAPIException(
"Error generating the URL of curtin's root-tgz file. "
"No image could be found for the given selection: "
"arch=%s, subarch=%s, series=%s, purpose=%s." % (
arch,
subarch,
series,
purpose
))
dyn_uri = '/'.join([
arch,
subarch,
series,
image.label,
'root-tgz'
])
return (
"http://" + cluster_host + "/MAAS/static/images/" + dyn_uri)
def get_curtin_config(node):
"""Return the curtin configuration to be used by curtin.pack_install.
:param node: The node for which to generate the configuration.
:rtype: unicode.
"""
series = node.get_distro_series()
context = get_preseed_context(series, node.nodegroup)
template = load_preseed_template(
node, USERDATA_TYPE.CURTIN, series)
context = get_preseed_context(series, nodegroup=node.nodegroup)
context.update(get_node_preseed_context(node, series))
context.update(get_curtin_context(node))
return template.substitute(**context)
def get_curtin_context(node):
"""Return the curtin-specific context dictionary to be used to render
user-data templates.
:param node: The node for which to generate the user-data.
:rtype: dict.
"""
token = NodeKey.objects.get_token_for_node(node)
base_url = node.nodegroup.maas_url
return {
'curtin_preseed': compose_cloud_init_preseed(token, base_url)
}
def get_preseed_type_for(node):
if node.should_use_traditional_installer():
return PRESEED_TYPE.DEFAULT
else:
return PRESEED_TYPE.CURTIN
def get_preseed(node):
"""Return the preseed for a given node. Depending on the node's status
this will be a commissioning preseed (if the node is commissioning) or an
install preseed (normal installation preseed or curtin preseed).
:param node: The node to return preseed for.
:type node: :class:`maasserver.models.Node`
:return: The rendered preseed string.
:rtype: unicode.
"""
if node.status == NODE_STATUS.COMMISSIONING:
return render_preseed(
node, PRESEED_TYPE.COMMISSIONING,
release=Config.objects.get_config('commissioning_distro_series'))
else:
return render_preseed(
node, get_preseed_type_for(node),
release=node.get_distro_series())
def get_preseed_filenames(node, prefix='', release='', default=False):
"""List possible preseed template filenames for the given node.
:param node: The node to return template preseed filenames for.
:type node: :class:`maasserver.models.Node`
:param prefix: At the top level, this is the preseed type (will be used as
a prefix in the template filenames). Usually one of {'', 'enlist',
'commissioning'}.
:type prefix: unicode
:param release: The Ubuntu release to be used.
:type release: unicode
:param default: Should we return the default ('generic') template as a
last resort template?
:type default: boolean
Returns a list of possible preseed template filenames using the following
lookup order:
{prefix}_{node_architecture}_{node_subarchitecture}_{release}_{node_name}
{prefix}_{node_architecture}_{node_subarchitecture}_{release}
{prefix}_{node_architecture}_{node_subarchitecture}
{prefix}_{node_architecture}
{prefix}
'generic'
"""
elements = []
# Add prefix.
if prefix != '':
elements.append(prefix)
# Add architecture/sub-architecture.
if node is not None:
arch = split_subarch(node.architecture)
elements.extend(arch)
# Add release.
elements.append(release)
# Add hostname.
if node is not None:
elements.append(node.hostname)
while elements:
yield compose_filename(elements)
elements.pop()
if default:
yield GENERIC_FILENAME
def split_subarch(architecture):
"""Split the architecture and the subarchitecture."""
return architecture.split('/')
def compose_filename(elements):
"""Create a preseed filename from a list of elements."""
return '_'.join(elements)
def get_preseed_template(filenames):
"""Get the path and content for the first template found.
:param filenames: An iterable of relative filenames.
"""
assert not isinstance(filenames, (bytes, unicode))
assert all(isinstance(filename, unicode) for filename in filenames)
for location in settings.PRESEED_TEMPLATE_LOCATIONS:
for filename in filenames:
filepath = join(location, filename)
try:
with open(filepath, "rb") as stream:
content = stream.read()
return filepath, content
except IOError:
pass # Ignore.
else:
return None, None
def get_escape_singleton():
"""Return a singleton containing methods to escape various formats used in
the preseed templates.
"""
Escape = namedtuple('Escape', 'shell')
return Escape(shell=quote)
class PreseedTemplate(tempita.Template):
"""A Tempita template specialised for preseed rendering.
It provides a filter named 'escape' which contains methods to escape
various formats used in the template."""
default_namespace = dict(
tempita.Template.default_namespace,
escape=get_escape_singleton())
class TemplateNotFoundError(Exception):
"""The template has not been found."""
def __init__(self, name):
super(TemplateNotFoundError, self).__init__(name)
self.name = name
def load_preseed_template(node, prefix, release=''):
"""Find and load a `PreseedTemplate` for the given node.
:param node: See `get_preseed_filenames`.
:param prefix: See `get_preseed_filenames`.
:param release: See `get_preseed_filenames`.
"""
def get_template(name, from_template, default=False):
"""A Tempita hook used to load the templates files.
It is defined to preserve the context (node, name, release, default)
since this will be called (by Tempita) called out of scope.
"""
filenames = list(get_preseed_filenames(node, name, release, default))
filepath, content = get_preseed_template(filenames)
if filepath is None:
raise TemplateNotFoundError(name)
# This is where the closure happens: pass `get_template` when
# instanciating PreseedTemplate.
return PreseedTemplate(
content, name=filepath, get_template=get_template)
return get_template(prefix, None, default=True)
def get_hostname_and_path(url):
"""Return a tuple of the hostname and the hierarchical path from a url."""
parsed_url = urlparse(url)
return parsed_url.hostname, parsed_url.path
def pick_cluster_controller_address(node):
"""Return an IP address for the cluster controller, to be used by `node`.
Curtin, running on the nodes, will download its installer image from here.
It will look for an address on a network to which `node` is connected, or
failing that, it will prefer a managed interface over an unmanaged one.
"""
# Sort interfaces by desirability, so we can pick the first one.
unmanaged = NODEGROUPINTERFACE_MANAGEMENT.UNMANAGED
sort_key = lambda interface: (
# Put unmanaged interfaces at the end as a last resort.
1 if interface.management == unmanaged else 0,
# Sort by ID as a tie-breaker, for consistency.
interface.id,
)
interfaces = sorted(
node.nodegroup.nodegroupinterface_set.all(), key=sort_key)
macs = [mac.mac_address for mac in node.macaddress_set.all()]
node_ips = [
IPAddress(ip)
for ip in DHCPLease.objects.filter(mac__in=macs).values_list(
'ip', flat=True)
]
# Search cluster controller's interfaces for a network that encompasses
# any of the node's IP addresses.
for interface in interfaces:
network = interface.network
for node_ip in node_ips:
if node_ip in network:
return interface.ip
# None found: pick the best guess, if available.
if interfaces == []:
return None
else:
return interfaces[0].ip
def get_preseed_context(release='', nodegroup=None):
"""Return the node-independent context dictionary to be used to render
preseed templates.
:param release: See `get_preseed_filenames`.
:param nodegroup: The nodegroup used to generate the preseed.
:return: The context dictionary.
:rtype: dict.
"""
server_host = get_maas_facing_server_host(nodegroup=nodegroup)
main_archive_hostname, main_archive_directory = get_hostname_and_path(
Config.objects.get_config('main_archive'))
ports_archive_hostname, ports_archive_directory = get_hostname_and_path(
Config.objects.get_config('ports_archive'))
if nodegroup is None:
base_url = None
else:
base_url = nodegroup.maas_url
return {
'main_archive_hostname': main_archive_hostname,
'main_archive_directory': main_archive_directory,
'ports_archive_hostname': ports_archive_hostname,
'ports_archive_directory': ports_archive_directory,
'release': release,
'server_host': server_host,
'server_url': absolute_reverse('nodes_handler', base_url=base_url),
'metadata_enlist_url': absolute_reverse('enlist', base_url=base_url),
'http_proxy': Config.objects.get_config('http_proxy'),
}
def get_node_preseed_context(node, release=''):
"""Return the node-dependent context dictionary to be used to render
preseed templates.
:param node: See `get_preseed_filenames`.
:param release: See `get_preseed_filenames`.
:return: The context dictionary.
:rtype: dict.
"""
# Create the url and the url-data (POST parameters) used to turn off
# PXE booting once the install of the node is finished.
node_disable_pxe_url = absolute_reverse(
'metadata-node-by-id', args=['latest', node.system_id],
base_url=node.nodegroup.maas_url)
node_disable_pxe_data = urlencode({'op': 'netboot_off'})
driver = get_third_party_driver(node)
return {
'third_party_drivers': (
Config.objects.get_config('enable_third_party_drivers')),
'driver': driver,
'driver_package': driver.get('package', ''),
'node': node,
'preseed_data': compose_preseed(node),
'node_disable_pxe_url': node_disable_pxe_url,
'node_disable_pxe_data': node_disable_pxe_data,
}
def render_enlistment_preseed(prefix, release='', nodegroup=None):
"""Return the enlistment preseed.
:param prefix: See `get_preseed_filenames`.
:param release: See `get_preseed_filenames`.
:param nodegroup: The nodegroup used to generate the preseed.
:return: The rendered preseed string.
:rtype: unicode.
"""
template = load_preseed_template(None, prefix, release)
context = get_preseed_context(release, nodegroup=nodegroup)
# Render the snippets in the main template.
snippets = get_snippet_context()
snippets.update(context)
return template.substitute(**snippets)
def render_preseed(node, prefix, release=''):
"""Return the preseed for the given node.
:param node: See `get_preseed_filenames`.
:param prefix: See `get_preseed_filenames`.
:param release: See `get_preseed_filenames`.
:return: The rendered preseed string.
:rtype: unicode.
"""
template = load_preseed_template(node, prefix, release)
nodegroup = node.nodegroup
context = get_preseed_context(release, nodegroup=nodegroup)
context.update(get_node_preseed_context(node, release))
return template.substitute(**context)
def compose_enlistment_preseed_url(nodegroup=None):
"""Compose enlistment preseed URL.
:param nodegroup: The nodegroup used to generate the preseed.
"""
# Always uses the latest version of the metadata API.
base_url = nodegroup.maas_url if nodegroup is not None else None
version = 'latest'
return absolute_reverse(
'metadata-enlist-preseed', args=[version],
query={'op': 'get_enlist_preseed'}, base_url=base_url)
def compose_preseed_url(node):
"""Compose a metadata URL for `node`'s preseed data."""
# Always uses the latest version of the metadata API.
version = 'latest'
base_url = node.nodegroup.maas_url
return absolute_reverse(
'metadata-node-by-id', args=[version, node.system_id],
query={'op': 'get_preseed'}, base_url=base_url)
|