/usr/lib/python2.7/dist-packages/provisioningserver/tasks.py is in python-maas-provisioningserver 1.5.4+bzr2294-0ubuntu1.2.
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 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 | # Copyright 2012-2014 Canonical Ltd. This software is licensed under the
# GNU Affero General Public License version 3 (see the file LICENSE).
"""Provisioning server tasks that are run in Celery workers."""
from __future__ import (
absolute_import,
print_function,
unicode_literals,
)
str = None
__metaclass__ = type
__all__ = [
'power_off',
'power_on',
'refresh_secrets',
'report_boot_images',
'rndc_command',
'setup_rndc_configuration',
'restart_dhcp_server',
'stop_dhcp_server',
'write_dhcp_config',
'write_dns_config',
'write_dns_zone_config',
'write_full_dns_config',
]
from functools import wraps
from logging import getLogger
import os
from subprocess import CalledProcessError
from celery.app import app_or_default
from celery.task import task
from provisioningserver import (
boot_images,
tags,
)
from provisioningserver.auth import (
record_api_credentials,
record_nodegroup_uuid,
)
from provisioningserver.custom_hardware.seamicro import (
probe_seamicro15k_and_enlist,
)
from provisioningserver.custom_hardware.ucsm import probe_and_enlist_ucsm
from provisioningserver.custom_hardware.virsh import probe_virsh_and_enlist
from provisioningserver.dhcp import (
config,
detect,
)
from provisioningserver.dhcp.leases import upload_leases
from provisioningserver.dns.config import (
DNSConfig,
execute_rndc_command,
set_up_options_conf,
setup_rndc,
)
from provisioningserver.drivers.hardware.mscm import probe_and_enlist_mscm
from provisioningserver.omshell import Omshell
from provisioningserver.power.poweraction import (
PowerAction,
PowerActionFail,
)
from provisioningserver.utils import (
call_and_check,
find_ip_via_arp,
sudo_write_file,
)
# For each item passed to refresh_secrets, a refresh function to give it to.
refresh_functions = {
'api_credentials': record_api_credentials,
'nodegroup_uuid': record_nodegroup_uuid,
}
celery_config = app_or_default().conf
logger = getLogger(__name__)
# The tasks catch bare exceptions in an attempt to circumvent Celery's
# bizarre exception handling which prints a stack trace but not the
# error message contained in the exception itself! The message is
# printed and then the exception re-raised so that it marks the task as
# failed - in doing so it logs the stack trace, which is why the code
# does not do a simple logger.exception(exc).
def log_exception_text(func):
"""Wrap a function and log any exception text raised."""
@wraps(func)
def wrapper(*args, **kwargs):
try:
func(*args, **kwargs)
except Exception as e:
logger.error("%s: %s", func.__name__, unicode(e))
raise
return wrapper
@task
@log_exception_text
def refresh_secrets(**kwargs):
"""Update the worker's knowledge of various secrets it needs.
The worker shares some secrets with the MAAS server, such as its
omapi key for talking to the DHCP server, and its MAAS API credentials.
When the server sends tasks to the worker, the tasks will include these
secrets as needed. But not everything the worker does is initiated by
a server request, so it needs copies of these secrets at hand.
We don't store these secrets in the worker, but we hold copies in
memory. The worker won't perform jobs that require secrets it does
not have yet, waiting instead for the next chance to catch up.
To make sure that the worker does not have to wait too long, the server
can send periodic `refresh_secrets` messages with the required
information.
Tasks can also call `refresh_secrets` to record information they receive
from the server.
All refreshed items are passed as keyword arguments, to avoid confusion
and allow for easy reordering. All refreshed items are optional. An
item that is not passed will not be refreshed, so it's entirely valid to
call this for just a single item. However `None` is a value like any
other, so passing `foo=None` will cause item `foo` to be refreshed with
value `None`.
To help catch simple programming mistakes, passing an unknown argument
will result in an assertion failure.
:param api_credentials: A colon separated string containing this
worker's credentials for accessing the MAAS API: consumer key,
resource token, resource secret.
:param nodegroup_uuid: The uuid of the node group that this worker
manages.
"""
for key, value in kwargs.items():
assert key in refresh_functions, "Unknown refresh item: %s" % key
refresh_functions[key](value)
# =====================================================================
# Power-related tasks
# =====================================================================
def issue_power_action(power_type, power_change, **kwargs):
"""Issue a power action to a node.
:param power_type: The node's power type. Must have a corresponding
power template.
:param power_change: The change to request: 'on' or 'off'.
:param **kwargs: Keyword arguments are passed on to :class:`PowerAction`.
"""
assert power_change in ('on', 'off'), (
"Unknown power change keyword: %s" % power_change)
kwargs['power_change'] = power_change
if 'mac_address' in kwargs:
kwargs['ip_address'] = find_ip_via_arp(kwargs['mac_address'])
kwargs.setdefault('ip_address', None)
try:
pa = PowerAction(power_type)
pa.execute(**kwargs)
except PowerActionFail:
# TODO: signal to webapp that it failed
# Re-raise, so the job is marked as failed. Only currently
# useful for tests.
raise
# TODO: signal to webapp that it worked.
@task
@log_exception_text
def power_on(power_type, **kwargs):
"""Turn a node on."""
issue_power_action(power_type, 'on', **kwargs)
@task
@log_exception_text
def power_off(power_type, **kwargs):
"""Turn a node off."""
issue_power_action(power_type, 'off', **kwargs)
# =====================================================================
# DNS-related tasks
# =====================================================================
# How many times should a rndc task be retried?
RNDC_COMMAND_MAX_RETRY = 10
# How long to wait between rndc tasks retries (in seconds)?
RNDC_COMMAND_RETRY_DELAY = 2
@task(max_retries=RNDC_COMMAND_MAX_RETRY, queue=celery_config.WORKER_QUEUE_DNS)
@log_exception_text
def rndc_command(arguments, retry=False, callback=None):
"""Use rndc to execute a command.
:param arguments: Argument list passed down to the rndc command.
:type arguments : list
:param retry: Should this task be retried in case of failure?
:type retry: bool
:param callback: Callback subtask.
:type callback: callable
"""
try:
execute_rndc_command(arguments)
except CalledProcessError as exc:
if retry:
return rndc_command.retry(
exc=exc, countdown=RNDC_COMMAND_RETRY_DELAY)
else:
logger.error("rndc_command failed: %s", unicode(exc))
raise
if callback is not None:
callback.delay()
@task(queue=celery_config.WORKER_QUEUE_DNS)
@log_exception_text
def write_full_dns_config(zones=None, callback=None, **kwargs):
"""Write out the DNS configuration files: the main configuration
file and the zone files.
:param zones: List of zones to write.
:type zones: list of :class:`DNSZoneData`
:param callback: Callback subtask.
:type callback: callable
:param **kwargs: Keyword args passed to DNSConfig.write_config()
"""
if zones is not None:
for zone in zones:
zone.write_config()
# Write main config file.
dns_config = DNSConfig(zones=zones)
dns_config.write_config(**kwargs)
# Write the included options file.
set_up_options_conf(**kwargs)
if callback is not None:
callback.delay()
@task(queue=celery_config.WORKER_QUEUE_DNS)
@log_exception_text
def write_dns_config(zones=(), callback=None, **kwargs):
"""Write out the DNS configuration file.
:param zones: List of zones to include as part of the main
config.
:type zones: list of :class:`DNSZoneData`
:param callback: Callback subtask.
:type callback: callable
:param **kwargs: Keyword args passed to DNSConfig.write_config()
"""
dns_config = DNSConfig(zones=zones)
dns_config.write_config(**kwargs)
if callback is not None:
callback.delay()
@task(queue=celery_config.WORKER_QUEUE_DNS)
@log_exception_text
def write_dns_zone_config(zones, callback=None, **kwargs):
"""Write out DNS zones.
:param zone: The zone data to write the configuration for.
:type zone: :class:`DNSZoneData`
:param callback: Callback subtask.
:type callback: callable
:param **kwargs: Keyword args passed to DNSZoneConfig.write_config()
"""
for zone in zones:
zone.write_config()
if callback is not None:
callback.delay()
@task(queue=celery_config.WORKER_QUEUE_DNS)
@log_exception_text
def setup_rndc_configuration(callback=None):
"""Write out the two rndc configuration files (rndc.conf and
named.conf.rndc).
:param callback: Callback subtask.
:type callback: callable
"""
setup_rndc()
if callback is not None:
callback.delay()
# =====================================================================
# DHCP-related tasks
# =====================================================================
@task
@log_exception_text
def upload_dhcp_leases():
"""Upload DHCP leases.
Uploads leases to the MAAS API, using cached credentials -- the task
originates with celerybeat, not with a server request.
"""
upload_leases()
@task
@log_exception_text
def add_new_dhcp_host_map(mappings, server_address, shared_key):
"""Add address mappings to the DHCP server.
Do not invoke this when DHCP is set to be managed manually.
:param mappings: A dict of new IP addresses, and the MAC addresses they
translate to.
:param server_address: IP or hostname for the DHCP server
:param shared_key: The HMAC-MD5 key that the DHCP server uses for access
control.
"""
omshell = Omshell(server_address, shared_key)
try:
for ip_address, mac_address in mappings.items():
omshell.create(ip_address, mac_address)
except CalledProcessError as e:
# TODO signal to webapp that the job failed.
# Re-raise, so the job is marked as failed. Only currently
# useful for tests.
logger.error("add_new_dhcp_host_map failed: %s", unicode(e))
raise
@task
@log_exception_text
def remove_dhcp_host_map(ip_address, server_address, omapi_key):
"""Remove an IP to MAC mapping in the DHCP server.
Do not invoke this when DHCP is set to be managed manually.
:param ip_address: Dotted quad string
:param server_address: IP or hostname for the DHCP server
:param omapi_key: The HMAC-MD5 key that the DHCP server uses for access
control.
"""
omshell = Omshell(server_address, omapi_key)
try:
omshell.remove(ip_address)
except CalledProcessError as e:
# TODO signal to webapp that the job failed.
# Re-raise, so the job is marked as failed. Only currently
# useful for tests.
logger.error("remove_dhcp_host_map failed: %s", unicode(e))
raise
@task
@log_exception_text
def write_dhcp_config(callback=None, **kwargs):
"""Write out the DHCP configuration file and restart the DHCP server.
:param dhcp_interfaces: Space-separated list of interfaces that the
DHCP server should listen on.
:param **kwargs: Keyword args passed to dhcp.config.get_config()
"""
sudo_write_file(
celery_config.DHCP_CONFIG_FILE, config.get_config(**kwargs))
sudo_write_file(
celery_config.DHCP_INTERFACES_FILE, kwargs.get('dhcp_interfaces', ''))
if callback is not None:
callback.delay()
@task
@log_exception_text
def restart_dhcp_server():
"""Restart the DHCP server."""
call_and_check(['sudo', '-n', 'service', 'maas-dhcp-server', 'restart'])
# Message to put in the DHCP config file when the DHCP server gets stopped.
DISABLED_DHCP_SERVER = "# DHCP server stopped."
@task
@log_exception_text
def stop_dhcp_server():
"""Write a blank config file and stop a DHCP server."""
# Write an empty config file to avoid having an outdated config laying
# around.
sudo_write_file(
celery_config.DHCP_CONFIG_FILE, DISABLED_DHCP_SERVER)
call_and_check(['sudo', '-n', 'service', 'maas-dhcp-server', 'stop'])
@task
@log_exception_text
def periodic_probe_dhcp():
"""Probe for foreign DHCP servers."""
detect.periodic_probe_task()
# =====================================================================
# Boot images-related tasks
# =====================================================================
@task
@log_exception_text
def report_boot_images():
"""For master worker only: report available netboot images."""
boot_images.report_to_server()
# How many times should a update node tags task be retried?
UPDATE_NODE_TAGS_MAX_RETRY = 10
# How long to wait between update node tags task retries (in seconds)?
UPDATE_NODE_TAGS_RETRY_DELAY = 2
# =====================================================================
# Tags-related tasks
# =====================================================================
@task(max_retries=UPDATE_NODE_TAGS_MAX_RETRY)
@log_exception_text
def update_node_tags(tag_name, tag_definition, tag_nsmap, retry=True):
"""Update the nodes for a new/changed tag definition.
:param tag_name: Name of the tag to update nodes for
:param tag_definition: Tag definition
:param retry: Whether to retry on failure
"""
try:
tags.process_node_tags(tag_name, tag_definition, tag_nsmap)
except tags.MissingCredentials, exc:
if retry:
return update_node_tags.retry(
exc=exc, countdown=UPDATE_NODE_TAGS_RETRY_DELAY)
else:
raise
# =====================================================================
# Image importing-related tasks
# =====================================================================
@task
@log_exception_text
def import_boot_images(http_proxy=None, callback=None):
env = dict(os.environ)
if http_proxy is not None:
env['http_proxy'] = http_proxy
env['https_proxy'] = http_proxy
call_and_check(['sudo', '-n', '-E', 'maas-import-pxe-files'], env=env)
if callback is not None:
callback.delay()
# =====================================================================
# Custom hardware tasks
# =====================================================================
@task
@log_exception_text
def add_seamicro15k(mac, username, password, power_control=None):
""" See `maasserver.api.NodeGroup.add_seamicro15k`. """
ip = find_ip_via_arp(mac)
if ip is not None:
probe_seamicro15k_and_enlist(
ip, username, password,
power_control=power_control)
else:
logger.warning("Couldn't find IP address for MAC %s" % mac)
@task
@log_exception_text
def add_virsh(poweraddr, password=None):
""" See `maasserver.api.NodeGroup.add_virsh`. """
probe_virsh_and_enlist(poweraddr, password=password)
@task
@log_exception_text
def enlist_nodes_from_ucsm(url, username, password):
""" See `maasserver.api.NodeGroupHandler.enlist_nodes_from_ucsm`. """
probe_and_enlist_ucsm(url, username, password)
@task
@log_exception_text
def enlist_nodes_from_mscm(host, username, password):
""" See `maasserver.api.NodeGroupHandler.enlist_nodes_from_mscm`. """
probe_and_enlist_mscm(host, username, password)
|