Merge lp:~maas-maintainers/maas/backup into lp:~maas-committers/maas/trunk

[Raphaël Badin]

WIP

[lp:~maas-maintainers/maas/backup]

1780. By Raphaël Badin on 2013-12-02

Couple of obvious fixes.

1781. By Raphaël Badin on 2013-12-02

One obvious fix.

1782. By Raphaël Badin on 2013-12-02

Define config variables.

1783. By Raphaël Badin on 2013-12-02

Fixes from actual testing.

1784. By Gavin Panella on 2013-12-02

No need for empty modules.

1785. By Gavin Panella on 2013-12-02

Extract code to name the database backup directory.

1786. By Gavin Panella on 2013-12-02

Fix typo.

1787. By Gavin Panella on 2013-12-02

Restore databases.

1788. By Gavin Panella on 2013-12-02

Fix mistake when deriving db dump dir.

1789. By Gavin Panella on 2013-12-02

Fix pg_restore command-line options.

1790. By Raphaël Badin on 2013-12-06

Fix pgdump/restore thanks jtv.

[MAAS Lander (maas-lander)]

Transitioned to Git.

lp:maas has now moved from Bzr to Git.
Please propose your branches with Launchpad using Git.

git clone https://git.launchpad.net/maas

Unmerged revisions

1790. By Raphaël Badin on 2013-12-06

Fix pgdump/restore thanks jtv.

1789. By Gavin Panella on 2013-12-02

Fix pg_restore command-line options.

1788. By Gavin Panella on 2013-12-02

Fix mistake when deriving db dump dir.

1787. By Gavin Panella on 2013-12-02

Restore databases.

1786. By Gavin Panella on 2013-12-02

Fix typo.

1785. By Gavin Panella on 2013-12-02

Extract code to name the database backup directory.

1784. By Gavin Panella on 2013-12-02

No need for empty modules.

1783. By Raphaël Badin on 2013-12-02

Fixes from actual testing.

1782. By Raphaël Badin on 2013-12-02

Define config variables.

1781. By Raphaël Badin on 2013-12-02

One obvious fix.

=== added directory 'backup'
=== added file 'backup/common.py'
--- backup/common.py	1970-01-01 00:00:00 +0000
+++ backup/common.py	2013-12-06 10:37:36 +0000
@@ -0,0 +1,142 @@
+#!/usr/bin/env python2.7
+# -*- mode: python -*-
+# Copyright 2013 Canonical Ltd.  This software is licensed under the
+# GNU Affero General Public License version 3 (see the file LICENSE).
+
+"""Common utilities."""
+
+from __future__ import (
+    absolute_import,
+    print_function,
+    unicode_literals,
+    )
+
+str = None
+
+__metaclass__ = type
+__all__ = [
+    "get_database_backup_directory",
+    "import_settings",
+    "logger",
+    "MAAS_CONFIG_DIR",
+    "MAAS_CONFIG_TARBALL",
+    "makedirs",
+    "run_command",
+    "System",
+]
+
+import errno
+import logging
+import os
+from os import path
+from pipes import quote
+from subprocess import (
+    PIPE,
+    Popen,
+    )
+import sys
+
+import apt
+
+
+logging.basicConfig(
+    level=logging.DEBUG,
+    format='%(asctime)s %(levelname)s %(message)s')
+
+logger = logging.getLogger("maas-backup")
+
+# MAAS variables.
+MAAS_CONFIG_DIR = '/etc/maas'
+MAAS_CONFIG_TARBALL = 'etc-maas.tgz'
+
+# Do *NOT* "from ... import ..." these names; they are modified by
+# import_settings().
+django_settings = None
+celery_settings = None
+
+
+def import_settings(test=False):
+    if test:
+        config_dir = path.join(path.dirname(__file__), 'tests')
+        sys.path[:0] = [config_dir]
+        os.environ['DJANGO_SETTINGS_MODULE'] = 'maas_local_settings'
+        os.environ['CELERY_CONFIG_MODULE'] = 'maas_local_celeryconfig'
+    else:
+        sys.path[:0] = [MAAS_CONFIG_DIR, '/usr/share/maas/']
+        os.environ['DJANGO_SETTINGS_MODULE'] = 'maas.settings'
+        os.environ['CELERY_CONFIG_MODULE'] = 'celeryconfig_cluster'
+    # Import Django settings.
+    from django.conf import settings
+    global django_settings
+    django_settings = settings
+    # Import Celery settings.
+    from celery.app import app_or_default
+    global celery_settings
+    celery_settings = app_or_default().conf
+
+
+def run_command(args, input=None, check_call=True, dry_run=False, env=None):
+    """A wrapper to Popen to run commands in the command-line."""
+    if dry_run:
+        cmd = " ".join(quote(arg) for arg in args)
+        logger.info("Running command: %s" % cmd)
+        return
+    process = Popen(
+        args, stdout=PIPE, stderr=PIPE, stdin=PIPE,
+        shell=False, env=env)
+    stdout, stderr = process.communicate(input)
+    retcode = process.returncode
+    if check_call and retcode != 0:
+        cmd = " ".join(quote(arg) for arg in args)
+        raise Exception(
+            "Command '%s' failed (%d):\n%s\n%s" % (
+                cmd, retcode,
+                stdout.decode('ascii'),
+                stderr.decode('ascii')))
+    return retcode, stdout, stderr
+
+
+def makedirs(path):
+    """Similar to os.makedirs but does not error if the directory exists."""
+    try:
+        os.makedirs(path)
+    except OSError as error:
+        if error.errno != errno.EEXIST:
+            raise
+        # Directory already exists.
+
+
+def get_database_backup_directory(database):
+    """Return a relative directory in which a db will or has been backed up.
+
+    :param database: A Django `DATABASES` entry.
+    :type database: `dict`
+    """
+    return "db.%(NAME)s.user=%(USER)s" % database
+
+
+class System:
+    """Encapsulates information about the system.
+
+    For example, what packages are installed, what is the purpose of
+    this system.
+
+    """
+
+    def __init__(self):
+        super(System, self).__init__()
+        self.cache = apt.Cache()
+
+    def is_package_installed(self, package_name):
+        try:
+            package = self.cache[package_name]
+        except KeyError:
+            return False
+        else:
+            return package.is_installed
+
+    def is_region_controller(self):
+        return self.is_package_installed("maas-region-controller")
+
+    def is_cluster_controller(self):
+        return self.is_package_installed("maas-cluster-controller")
 
=== added file 'backup/maas-backup'
--- backup/maas-backup	1970-01-01 00:00:00 +0000
+++ backup/maas-backup	2013-12-06 10:37:36 +0000
@@ -0,0 +1,134 @@
+#!/usr/bin/env python2.7
+# -*- mode: python -*-
+# Copyright 2013 Canonical Ltd.  This software is licensed under the
+# GNU Affero General Public License version 3 (see the file LICENSE).
+
+"""Backup MAAS."""
+
+from __future__ import (
+    absolute_import,
+    print_function,
+    unicode_literals,
+    )
+
+str = None
+
+__metaclass__ = type
+
+import argparse
+import os
+from os import path
+import sys
+
+import common
+from common import (
+    get_database_backup_directory,
+    logger,
+    System,
+    MAAS_CONFIG_TARBALL,
+    MAAS_CONFIG_DIR,
+    run_command,
+    makedirs,
+    )
+from six import text_type
+
+# For development, add the script's directory to sys.path.
+sys.path[:0] = [path.dirname(__file__)]
+
+
+def backup_config_files(target_directory, dry_run=False):
+    dest_file = path.join(target_directory, MAAS_CONFIG_TARBALL)
+    run_command(
+        ['tar', 'zcpf', dest_file, '-C', MAAS_CONFIG_DIR, '.'],
+        dry_run=dry_run)
+
+
+def backup_databases(target_directory, dry_run=False):
+    databases = [
+        database
+        for database in common.django_settings.DATABASES.values()
+        if database["ENGINE"] == "django.db.backends.postgresql_psycopg2"
+    ]
+    for database in databases:
+        backup_to = path.join(
+            target_directory, get_database_backup_directory(database))
+        command = (
+            "pg_dump",
+            "--file", backup_to,
+            "--host", database["HOST"],
+            "--username", database["USER"],
+            database["NAME"],
+        )
+        # The password cannot be passed on the command-line, bit libpq
+        # recognises PGPASSWORD in the environment.
+        env = dict(os.environ, PGPASSWORD=database["PASSWORD"])
+        run_command(command, env=env, dry_run=dry_run)
+
+
+def backup_region(target_directory, dry_run=False):
+    """Backup region controller to `target_directory`."""
+    logger.info("Backing-up region controller to %s.", target_directory)
+    if dry_run:
+        logger.info("Dry-run.")
+    backup_config_files(target_directory, dry_run=dry_run)
+    backup_databases(target_directory, dry_run=dry_run)
+
+
+def backup_leases_file(target_directory, dry_run=False):
+    leases_file = common.celery_settings.DHCP_LEASES_FILE
+    run_command(
+        ['cp', '-p', '--', leases_file, target_directory],
+        check_call=False,
+        dry_run=dry_run)
+
+
+def backup_cluster(target_directory, dry_run=False):
+    """Backup cluster controller to `target_directory`."""
+    logger.info("Backing-up cluster controller to %s.", target_directory)
+    if dry_run:
+        logger.info("Dry-run.")
+    backup_config_files(target_directory, dry_run=dry_run)
+    backup_leases_file(target_directory, dry_run=dry_run)
+
+
+def backup(target_directory, dry_run=False, test=False):
+    """Backup cluster and/or region controller to `target_directory`."""
+    system = System()
+    if test or system.is_region_controller():
+        target_dir = path.join(target_directory, "region")
+        makedirs(target_dir)
+        backup_region(target_dir, dry_run or test)
+    if test or system.is_cluster_controller():
+        target_dir = path.join(target_directory, "cluster")
+        makedirs(target_dir)
+        backup_cluster(target_dir, dry_run or test)
+
+
+# See http://docs.python.org/release/2.7/library/argparse.html.
+argument_parser = argparse.ArgumentParser(description=__doc__)
+argument_parser.add_argument(
+    'target_directory', metavar="target-directory", type=text_type,
+    help="The directory where the files will be put.")
+argument_parser.add_argument(
+    '--dry-run', action='store_true', default=False, help=(
+        "No action; perform a simulation of events that would occur but do "
+        "not actually do anything."))
+argument_parser.add_argument(
+    '--test', action='store_true', default=False, help=(
+        "Run a test run.  Equivalent to --dry-run plus skipping all the "
+        "checks."))
+
+
+def main():
+    args = argument_parser.parse_args()
+    if not args.test and os.geteuid() != 0:
+        logger.error(
+            "This script must be run with root privileges ("
+            "i.e. use 'sudo').")
+        return
+    common.import_settings(args.test)
+    backup(args.target_directory, args.dry_run, args.test)
+
+
+if __name__ == "__main__":
+    main()
 
=== added file 'backup/maas-restore'
--- backup/maas-restore	1970-01-01 00:00:00 +0000
+++ backup/maas-restore	2013-12-06 10:37:36 +0000
@@ -0,0 +1,186 @@
+#!/usr/bin/env python2.7
+# -*- mode: python -*-
+# Copyright 2013 Canonical Ltd.  This software is licensed under the
+# GNU Affero General Public License version 3 (see the file LICENSE).
+
+"""Restore MAAS from a backup."""
+
+from __future__ import (
+    absolute_import,
+    print_function,
+    unicode_literals,
+    )
+
+str = None
+
+__metaclass__ = type
+
+import argparse
+import os
+from os import path
+import sys
+from urlparse import urlparse
+
+import common
+from common import (
+    get_database_backup_directory,
+    logger,
+    System,
+    MAAS_CONFIG_TARBALL,
+    MAAS_CONFIG_DIR,
+    run_command,
+    )
+from six import text_type
+
+# For development, add the script's directory to sys.path.
+sys.path[:0] = [path.dirname(__file__)]
+
+
+def restore_config_files(source_directory, dry_run=False):
+    src_file = path.join(source_directory, MAAS_CONFIG_TARBALL)
+    run_command(
+        ['tar', 'zxpf', src_file, '-C', MAAS_CONFIG_DIR],
+        dry_run=dry_run)
+
+
+def restore_databases(source_directory, dry_run=False):
+    databases = [
+        database
+        for database in common.django_settings.DATABASES.values()
+        if database["ENGINE"] == "django.db.backends.postgresql_psycopg2"
+    ]
+    for database in databases:
+        restore_from = path.join(
+            source_directory, get_database_backup_directory(database))
+        command = (
+            "psql",
+            "--host", database["HOST"],
+            "--dbname", database["NAME"],
+            "--username", database["USER"],
+            "--single-transaction",
+	    "--file", restore_from,
+        )
+        # The password cannot be passed on the command-line, bit libpq
+        # recognises PGPASSWORD in the environment.
+        env = dict(os.environ, PGPASSWORD=database["PASSWORD"])
+        run_command(command, env=env, dry_run=dry_run)
+
+
+def update_rabbitmq_passwords(dry_run=False, test=False):
+    # Update password for maas_longpoll.
+    run_command(
+        ['rabbitmqctl', 'change_password',
+         common.django_settings.RABBITMQ_USERID,
+         common.django_settings.RABBITMQ_PASSWORD],
+        dry_run=dry_run)
+    # Update password for maas_workers.
+    broker_url = common.celery_settings.BROKER_URL
+    parsed_url = urlparse(broker_url)
+    run_command(
+        ['rabbitmqctl', 'change_password',
+         parsed_url.username, parsed_url.password],
+        dry_run=dry_run)
+
+
+def run_db_migrations(dry_run=False):
+    run_command(
+        ['maas', 'migrate', 'maasserver', '--noinput'],
+        dry_run=dry_run)
+    run_command(
+        ['maas', 'migrate', 'metadataserver', '--noinput'],
+        dry_run=dry_run)
+
+
+def restart_region_services(dry_run=False):
+    run_command(['service', 'apache2', 'restart'], dry_run=dry_run)
+    run_command(['service', 'maas-pserv', 'restart'], dry_run=dry_run)
+    run_command(
+        ['service', 'maas-region-celery', 'restart'], dry_run=dry_run)
+    run_command(['service', 'maas-txlongpoll', 'restart'], dry_run=dry_run)
+    # Do not error if this fails because this MAAS instance might not be
+    # using maas-dns.
+    run_command(
+        ['service', 'bind9', 'restart'], check_call=False, dry_run=dry_run)
+
+
+def restore_region(source_directory, dry_run=False):
+    """Restore region controller from `source_directory`."""
+    logger.info("Restoring region controller from %s.", source_directory)
+    if dry_run:
+        logger.info("Dry-run.")
+    restore_config_files(source_directory, dry_run=dry_run)
+    restore_databases(source_directory, dry_run=dry_run)
+    update_rabbitmq_passwords(dry_run=dry_run)
+    restart_region_services(dry_run=dry_run)
+    run_db_migrations(dry_run=dry_run)
+
+
+def restore_leases_file(source_directory, dry_run=False):
+    leases_file = common.celery_settings.DHCP_LEASES_FILE
+    source_file = path.join(
+        source_directory, path.basename(leases_file))
+    run_command(
+        ['cp', '-p', '--', source_file, leases_file],
+        check_call=False,
+        dry_run=dry_run)
+
+
+def restart_cluser_services(dry_run=False):
+    run_command(
+        ['service', 'maas-cluster-celery', 'restart'], dry_run=dry_run)
+    # Do not error if this fails because this MAAS instance might not be
+    # using maas-dhcp.
+    run_command(
+        ['service', 'maas-dhcp-server', 'restart'], check_call=False,
+        dry_run=dry_run)
+
+
+def restore_cluster(source_directory, dry_run=False):
+    """Restore cluster controller from `source_directory`."""
+    logger.info("Restoring cluster controller from %s.", source_directory)
+    if dry_run:
+        logger.info("Dry-run.")
+    restore_config_files(source_directory, dry_run=dry_run)
+    restore_leases_file(source_directory, dry_run=dry_run)
+    restart_cluser_services(dry_run=dry_run)
+
+
+def restore(source_directory, dry_run=False, test=False):
+    """Restore cluster and/or region controller from `source_directory`."""
+    system = System()
+    if test or system.is_region_controller():
+        source_dir = path.join(source_directory, "region")
+        restore_region(source_dir, dry_run or test)
+    if test or system.is_cluster_controller():
+        source_dir = path.join(source_directory, "cluster")
+        restore_cluster(source_dir, dry_run or test)
+
+
+# See http://docs.python.org/release/2.7/library/argparse.html.
+argument_parser = argparse.ArgumentParser(description=__doc__)
+argument_parser.add_argument(
+    'source_directory', metavar="source-directory", type=text_type,
+    help="The directory where the files from a backup can be found.")
+argument_parser.add_argument(
+    '--dry-run', action='store_true', default=False, help=(
+        "No action; perform a simulation of events that would occur but do "
+        "not actually do anything."))
+argument_parser.add_argument(
+    '--test', action='store_true', default=False, help=(
+        "Run a test run.  Equivalent to --dry-run plus skipping all the "
+        "checks."))
+
+
+def main():
+    args = argument_parser.parse_args()
+    if not args.test and os.geteuid() != 0:
+        logger.error(
+            "This script must be run with root privileges ("
+            "i.e. use 'sudo').")
+        return
+    common.import_settings(args.test)
+    restore(args.source_directory, args.dry_run, args.test)
+
+
+if __name__ == "__main__":
+    main()
 
=== added directory 'backup/tests'
=== added file 'backup/tests/maas_local_celeryconfig.py'
--- backup/tests/maas_local_celeryconfig.py	1970-01-01 00:00:00 +0000
+++ backup/tests/maas_local_celeryconfig.py	2013-12-06 10:37:36 +0000
@@ -0,0 +1,3 @@
+BROKER_URL = 'amqp://maas_workers:TqgnPD6jXe7GT2nVFDJc@10.55.61.76:5672//maas_workers'
+
+DHCP_LEASES_FILE = '/var/lib/maas/dhcp/dhcpd.leases'
 
=== added file 'backup/tests/maas_local_settings.py'
--- backup/tests/maas_local_settings.py	1970-01-01 00:00:00 +0000
+++ backup/tests/maas_local_settings.py	2013-12-06 10:37:36 +0000
@@ -0,0 +1,8 @@
+# RabbitMQ settings.
+RABBITMQ_HOST = 'localhost'
+RABBITMQ_USERID = 'maas_longpoll'
+RABBITMQ_PASSWORD = 'gQaFNcMkzoSloOxHY7ZN'
+RABBITMQ_VIRTUAL_HOST = '/maas_longpoll'
+
+# Settings set so that Django accepts this file as a valid config file.
+SECRET_KEY = '546908346890'