[xianghui, r=gnuoy] To support quantum-gateway HA in Icehouse before Juno native HA deployed.

It works by using pacemaker to monitor a daemon, which will detect neutron agents status and cleanup local resource when failover etc.

BP:
https://blueprints.launchpad.net/cts-engineering/+spec/neutron-gateway-services-need-ha-support

config.yaml

@@ -130,4 +130,28 @@ options:
     default:
     description: |
       YAML-formatted associative array of sysctl key/value pairs to be set
-      persistently e.g. '{ kernel.pid_max : 4194303 }'.
+      persistently e.g. '{ kernel.pid_max : 4194303 }'.
+  # Legacy (Icehouse) HA
+  ha-legacy-mode:
+    type: boolean
+    default: False
+    description: |
+      If True will enable Pacemaker to monitor the neutron-ha-monitor daemon
+      on every neutron-gateway unit, which detects neutron agents status and
+      reschedule resources hosting on failed agents, detects local errors and
+      release resources when network is unreachable or do neccessary recover
+      tasks. This feature targets to < Juno which doesn't natively support HA
+      in Neutron itself.
+  ha-bindiface:
+    type: string
+    default: eth0
+    description: |
+      Default network interface on which HA cluster will bind to communicate
+      with the other members of the HA Cluster.
+  ha-mcastport:
+    type: int
+    default: 5409
+    description: |
+      Default multicast port number that will be used to communicate between
+      HA Cluster nodes.
+

files/NeutronAgentMon

@@ -0,0 +1,155 @@
+#!/bin/sh
+#
+#
+#	NeutronAgentMon OCF RA.
+#	Starts crm_mon in background which logs cluster status as
+#	html to the specified file.
+#
+#       Copyright 2014 Canonical Ltd.
+#
+#       Authors: Hui Xiang <hui.xiang@canonical.com>
+#                Edward Hope-Morley <edward.hope-morley@canonical.com>
+#
+# OCF instance parameters:
+#	OCF_RESKEY_file
+
+#######################################################################
+# Initialization:
+: ${OCF_FUNCTIONS=${OCF_ROOT}/resource.d/heartbeat/.ocf-shellfuncs}
+. ${OCF_FUNCTIONS}
+: ${__OCF_ACTION=$1}
+
+#######################################################################
+
+meta_data() {
+	cat <<END
+<?xml version="1.0"?>
+<!DOCTYPE resource-agent SYSTEM "ra-api-1.dtd">
+<resource-agent name="NeutronAgentMon">
+<version>1.0</version>
+
+<longdesc lang="en">
+This is a NeutronAgentMon Resource Agent.
+It monitors the 'neutron-ha-monitor daemon' status.
+</longdesc>
+<shortdesc lang="en">Monitor '/usr/local/bin/neutron-ha-monitor.py' in the background.</shortdesc>
+
+<parameters>
+
+<parameter name="file" unique="0">
+<longdesc lang="en">
+The file we want to run as a daemon.
+</longdesc>
+<shortdesc lang="en">The file we want to run as a daemon.</shortdesc>
+<content type="string" default="/usr/local/bin/neutron-ha-monitor.py" />
+</parameter>
+
+</parameters>
+
+<actions>
+<action name="start"   timeout="20" />
+<action name="stop"    timeout="20" />
+<action name="monitor" depth="0"  timeout="20" interval="60" />
+<action name="meta-data"  timeout="5" />
+<action name="validate-all"  timeout="30" />
+</actions>
+</resource-agent>
+END
+}
+
+#######################################################################
+
+NeutronAgentMon_usage() {
+	cat <<END
+usage: $0 {start|stop|monitor|validate-all|meta-data}
+
+Expects to have a fully populated OCF RA-compliant environment set.
+END
+}
+
+NeutronAgentMon_exit() {
+    if [ $1 != 0 ]; then
+        exit $OCF_ERR_GENERIC
+    else
+        exit $OCF_SUCCESS
+    fi
+}
+
+NeutronAgentMon_start() {
+    pid=`sudo ps -aux | grep neutron-ha-m\[o\]nitor.py | awk -F' ' '{print $2}'`
+    if [ -z $pid ]; then
+        ocf_log info "[NeutronAgentMon_start] Start Monitor daemon."
+        sudo mkdir -p /var/log/neutron-ha
+        sudo python /usr/local/bin/neutron-ha-monitor.py \
+        --config-file /var/lib/juju-neutron-ha/neutron-ha-monitor.conf \
+        --log-file /var/log/neutron-ha/monitor.log >> /dev/null 2>&1 & echo $!
+        sleep 5
+    else
+        ocf_log warn "[NeutronAgentMon_start] Monitor daemon already running."
+    fi
+    NeutronAgentMon_exit $?
+}
+
+NeutronAgentMon_stop() {
+    pid=`sudo ps -aux | grep neutron-ha-m\[o\]nitor.py | awk -F' ' '{print $2}'`
+    if [ ! -z $pid ]; then
+        sudo kill -s 9 $pid
+        ocf_log info "[NeutronAgentMon_stop] Pid $pid is killed."
+    else
+        ocf_log warn "[NeutronAgentMon_stop] Monitor daemon already stopped."
+    fi
+    NeutronAgentMon_exit 0
+}
+
+NeutronAgentMon_monitor() {
+    pid=`sudo ps -aux | grep neutron-ha-m\[o\]nitor.py | awk -F' ' '{print $2}'`
+    if [ ! -z $pid ]; then
+        ocf_log info "[NeutronAgentMon_monitor] success."
+        exit $OCF_SUCCESS
+    fi
+    exit $OCF_NOT_RUNNING
+}
+
+NeutronAgentMon_validate() {
+# Existence of the user
+    if [ -f $OCF_RESKEY_file ]; then
+        echo "Validate OK"
+        return $OCF_SUCCESS
+    else
+        ocf_log err "The file $OCF_RESKEY_file does not exist!"
+	exit $OCF_ERR_ARGS
+    fi
+}
+
+if [ $# -ne 1 ]; then
+    NeutronAgentMon_usage
+    exit $OCF_ERR_ARGS
+fi
+
+: ${OCF_RESKEY_update:="15000"}
+: ${OCF_RESKEY_pidfile:="/tmp/NeutronAgentMon_${OCF_RESOURCE_INSTANCE}.pid"}
+: ${OCF_RESKEY_htmlfile:="/tmp/NeutronAgentMon_${OCF_RESOURCE_INSTANCE}.html"}
+
+OCF_RESKEY_update=`expr $OCF_RESKEY_update / 1000`
+
+case $__OCF_ACTION in
+meta-data)	meta_data
+		exit $OCF_SUCCESS
+		;;
+start)		NeutronAgentMon_start
+		;;
+stop)		NeutronAgentMon_stop
+		;;
+monitor)	NeutronAgentMon_monitor
+		;;
+validate-all)	NeutronAgentMon_validate
+		;;
+usage|help)	NeutronAgentMon_usage
+		exit $OCF_SUCCESS
+		;;
+*)		NeutronAgentMon_usage
+		exit $OCF_ERR_UNIMPLEMENTED
+		;;
+esac
+
+exit $?

files/neutron-ha-monitor.conf

@@ -0,0 +1,4 @@
+[DEFAULT]
+verbose=True
+#debug=True
+check_interval=8

files/neutron-ha-monitor.py

@@ -0,0 +1,436 @@
+# Copyright 2014 Canonical Ltd.
+#
+# Authors: Hui Xiang <hui.xiang@canonical.com>
+#          Joshua Zhang <joshua.zhang@canonical.com>
+#          Edward Hope-Morley <edward.hope-morley@canonical.com>
+#
+
+"""
+Helpers for monitoring Neutron agents, reschedule failed agents,
+cleaned resources on failed nodes.
+"""
+
+import os
+import re
+import sys
+import signal
+import socket
+import subprocess
+import time
+
+from oslo.config import cfg
+from neutron.agent.linux import ovs_lib
+from neutron.agent.linux import ip_lib
+from neutron.common import exceptions
+from neutron.openstack.common import log as logging
+
+LOG = logging.getLogger(__name__)
+
+
+class Daemon(object):
+    """A generic daemon class.
+
+    Usage: subclass the Daemon class and override the run() method
+    """
+    def __init__(self, stdin='/dev/null', stdout='/dev/null',
+                 stderr='/dev/null', procname='python'):
+        self.stdin = stdin
+        self.stdout = stdout
+        self.stderr = stderr
+        self.procname = procname
+
+    def _fork(self):
+        try:
+            pid = os.fork()
+            if pid > 0:
+                sys.exit(0)
+        except OSError:
+            LOG.exception('Fork failed')
+            sys.exit(1)
+
+    def daemonize(self):
+        """Daemonize process by doing Stevens double fork."""
+        # fork first time
+        self._fork()
+
+        # decouple from parent environment
+        os.chdir("/")
+        os.setsid()
+        os.umask(0)
+        # fork second time
+        self._fork()
+
+        # redirect standard file descriptors
+        sys.stdout.flush()
+        sys.stderr.flush()
+        stdin = open(self.stdin, 'r')
+        stdout = open(self.stdout, 'a+')
+        stderr = open(self.stderr, 'a+', 0)
+        os.dup2(stdin.fileno(), sys.stdin.fileno())
+        os.dup2(stdout.fileno(), sys.stdout.fileno())
+        os.dup2(stderr.fileno(), sys.stderr.fileno())
+
+        signal.signal(signal.SIGTERM, self.handle_sigterm)
+
+    def handle_sigterm(self, signum, frame):
+        sys.exit(0)
+
+    def start(self):
+        """Start the daemon."""
+        self.daemonize()
+        self.run()
+
+    def run(self):
+        """Override this method when subclassing Daemon.
+
+        start() will call this method after the process has daemonized.
+        """
+        pass
+
+
+class MonitorNeutronAgentsDaemon(Daemon):
+    def __init__(self):
+        super(MonitorNeutronAgentsDaemon, self).__init__()
+        logging.setup('Neuron-HA-Monitor')
+        LOG.info('Monitor Neutron Agent Loop Init')
+        self.hostname = None
+        self.env = {}
+
+    def get_env(self):
+        envrc_f = '/etc/legacy_ha_envrc'
+        envrc_f_m = False
+        if os.path.isfile(envrc_f):
+            ctime = time.ctime(os.stat(envrc_f).st_ctime)
+            mtime = time.ctime(os.stat(envrc_f).st_mtime)
+            if ctime != mtime:
+                envrc_f_m = True
+
+            if not self.env or envrc_f_m:
+                with open(envrc_f, 'r') as f:
+                    for line in f:
+                        data = line.strip().split('=')
+                        if data and data[0] and data[1]:
+                            self.env[data[0]] = data[1]
+                        else:
+                            raise Exception("OpenStack env data uncomplete.")
+        return self.env
+
+    def get_hostname(self):
+        if not self.hostname:
+            self.hostname = socket.gethostname()
+        return self.hostname
+
+    def get_root_helper(self):
+        return 'sudo'
+
+    def list_monitor_res(self):
+        # List crm resource 'cl_monitor' running node
+        nodes = []
+        cmd = ['crm', 'resource', 'show', 'cl_monitor']
+        output = subprocess.check_output(cmd)
+        pattern = re.compile('resource cl_monitor is running on: (.*) ')
+        nodes = pattern.findall(output)
+        return nodes
+
+    def get_crm_res_lead_node(self):
+        nodes = self.list_monitor_res()
+        if nodes:
+            return nodes[0].strip()
+        else:
+            LOG.error('Failed to get crm resource.')
+            return None
+
+    def unplug_device(self, device):
+        try:
+            device.link.delete()
+        except RuntimeError:
+            root_helper = self.get_root_helper()
+            # Maybe the device is OVS port, so try to delete
+            bridge_name = ovs_lib.get_bridge_for_iface(root_helper,
+                                                       device.name)
+            if bridge_name:
+                bridge = ovs_lib.OVSBridge(bridge_name, root_helper)
+                bridge.delete_port(device.name)
+            else:
+                LOG.debug('Unable to find bridge for device: %s', device.name)
+
+    def get_pattern(self, key, text):
+        if not key or not text:
+            LOG.debug('Invalid key(%s) or text(%s)' % (key, text))
+            return None
+
+        pattern = re.compile('%s' % key)
+        result = pattern.findall(text)
+        return result
+
+    def _cleanup(self, key1, key2):
+        namespaces = []
+        if key1:
+            for k in key1.iterkeys():
+                namespaces.append(key2 + '-' + k)
+        else:
+            try:
+                cmd = ['sudo', 'ip', 'netns']
+                ns = subprocess.check_output(cmd)
+                namespaces = self.get_pattern('(%s.*)' % key2, ns)
+            except RuntimeError as e:
+                LOG.error('Failed to list namespace, (%s)' % e)
+
+        if namespaces:
+            LOG.info('Namespaces: %s is going to be deleted.' % namespaces)
+            self.destroy_namespaces(namespaces)
+
+    def cleanup_dhcp(self, networks):
+        self._cleanup(networks, 'qdhcp')
+
+    def cleanup_router(self, routers):
+        self._cleanup(routers, 'qrouter')
+
+    def destroy_namespaces(self, namespaces):
+        try:
+            root_helper = self.get_root_helper()
+            for namespace in namespaces:
+                ip = ip_lib.IPWrapper(root_helper, namespace)
+                if ip.netns.exists(namespace):
+                    for device in ip.get_devices(exclude_loopback=True):
+                        self.unplug_device(device)
+
+            ip.garbage_collect_namespace()
+        except Exception:
+            LOG.exception('Error unable to destroy namespace: %s', namespace)
+
+    def is_same_host(self, host):
+        return str(host).strip() == self.get_hostname()
+
+    def validate_reschedule(self):
+        crm_no_1_node = self.get_crm_res_lead_node()
+        if not crm_no_1_node:
+            LOG.error('No crm first node could be found.')
+            return False
+
+        if not self.is_same_host(crm_no_1_node):
+            LOG.warn('Only the first crm node %s could reschedule. '
+                     % crm_no_1_node)
+            return False
+        return True
+
+    def l3_agents_reschedule(self, l3_agents, routers, quantum):
+        if not self.validate_reschedule():
+            return
+
+        index = 0
+        for router_id in routers:
+            agent = index % len(l3_agents)
+            LOG.info('Moving router %s from %s to %s' %
+                     (router_id, routers[router_id], l3_agents[agent]))
+            try:
+                quantum.remove_router_from_l3_agent(l3_agent=routers[router_id],
+                                                    router_id=router_id)
+            except exceptions.NeutronException as e:
+                LOG.error('Remove router raised exception: %s' % e)
+            try:
+                quantum.add_router_to_l3_agent(l3_agent=l3_agents[agent],
+                                               body={'router_id': router_id})
+            except exceptions.NeutronException as e:
+                LOG.error('Add router raised exception: %s' % e)
+            index += 1
+
+    def dhcp_agents_reschedule(self, dhcp_agents, networks, quantum):
+        if not self.validate_reschedule():
+            return
+
+        index = 0
+        for network_id in networks:
+            agent = index % len(dhcp_agents)
+            LOG.info('Moving network %s from %s to %s' % (network_id,
+                     networks[network_id], dhcp_agents[agent]))
+            try:
+                quantum.remove_network_from_dhcp_agent(
+                    dhcp_agent=networks[network_id], network_id=network_id)
+            except exceptions.NeutronException as e:
+                LOG.error('Remove network raised exception: %s' % e)
+            try:
+                quantum.add_network_to_dhcp_agent(
+                    dhcp_agent=dhcp_agents[agent],
+                    body={'network_id': network_id})
+            except exceptions.NeutronException as e:
+                LOG.error('Add network raised exception: %s' % e)
+            index += 1
+
+    def get_quantum_client(self):
+        env = self.get_env()
+        if not env:
+            LOG.info('Unable to re-assign resources at this time')
+            return None
+
+        try:
+            from quantumclient.v2_0 import client
+        except ImportError:
+            # Try to import neutronclient instead for havana+
+            from neutronclient.v2_0 import client
+
+        auth_url = '%(auth_protocol)s://%(keystone_host)s:%(auth_port)s/v2.0' \
+                   % env
+        quantum = client.Client(username=env['service_username'],
+                                password=env['service_password'],
+                                tenant_name=env['service_tenant'],
+                                auth_url=auth_url,
+                                region_name=env['region'])
+        return quantum
+
+    def reassign_agent_resources(self, quantum=None):
+        """Use agent scheduler API to detect down agents and re-schedule"""
+        if not quantum:
+            LOG.error('Failed to get quantum client.')
+            return
+
+        try:
+            DHCP_AGENT = "DHCP Agent"
+            L3_AGENT = "L3 Agent"
+            agents = quantum.list_agents(agent_type=DHCP_AGENT)
+        except exceptions.NeutronException as e:
+            LOG.error('Failed to get quantum agents, %s' % e)
+            return
+
+        dhcp_agents = []
+        l3_agents = []
+        networks = {}
+        for agent in agents['agents']:
+            hosted_networks = quantum.list_networks_on_dhcp_agent(
+                agent['id'])['networks']
+            if not agent['alive']:
+                LOG.info('DHCP Agent %s down' % agent['id'])
+                for network in hosted_networks:
+                    networks[network['id']] = agent['id']
+                if self.is_same_host(agent['host']):
+                    self.cleanup_dhcp(networks)
+            else:
+                dhcp_agents.append(agent['id'])
+                LOG.info('Active dhcp agents: %s' % agent['id'])
+                if not hosted_networks and self.is_same_host(agent['host']):
+                    self.cleanup_dhcp(None)
+
+        agents = quantum.list_agents(agent_type=L3_AGENT)
+        routers = {}
+        for agent in agents['agents']:
+            hosted_routers = quantum.list_routers_on_l3_agent(
+                agent['id'])['routers']
+            if not agent['alive']:
+                LOG.info('L3 Agent %s down' % agent['id'])
+                for router in hosted_routers:
+                    routers[router['id']] = agent['id']
+                if self.is_same_host(agent['host']):
+                    self.cleanup_router(routers)
+            else:
+                l3_agents.append(agent['id'])
+                LOG.info('Active l3 agents: %s' % agent['id'])
+                if not hosted_routers and self.is_same_host(agent['host']):
+                    self.cleanup_router(None)
+
+        if not networks and not routers:
+            LOG.info('No networks and routers hosted on failed agents.')
+            return
+
+        if len(dhcp_agents) == 0 and len(l3_agents) == 0:
+            LOG.error('Unable to relocate resources, there are %s dhcp_agents '
+                      'and %s l3_agents in this cluster' % (len(dhcp_agents),
+                                                            len(l3_agents)))
+            return
+
+        if len(l3_agents) > 0:
+            self.l3_agents_reschedule(l3_agents, routers, quantum)
+            # new l3 node will not create a tunnel if don't restart ovs process
+
+        if len(dhcp_agents) > 0:
+            self.dhcp_agents_reschedule(dhcp_agents, networks, quantum)
+
+
+    def check_ovs_tunnel(self, quantum=None):
+        '''
+        Work around for Bug #1411163
+        No fdb entries added when failover dhcp and l3 agent together.
+        '''
+        if not quantum:
+            LOG.error('Failed to get quantum client.')
+            return
+
+        try:
+            OVS_AGENT = 'Open vSwitch agent'
+            agents = quantum.list_agents(agent_type=OVS_AGENT)
+        except exceptions.NeutronException as e:
+            LOG.error('No ovs agent found on localhost, error:%s.' % e)
+            return
+
+        for agent in agents['agents']:
+            if self.is_same_host(agent['host']) and agent['alive']:
+                conf = agent['configurations']
+                if 'gre' in conf['tunnel_types'] and conf['l2_population'] \
+                        and conf['devices']:
+                    LOG.debug('local ovs agent:%s' % agent)
+                    ovs_output = subprocess.check_output(['ovs-vsctl',
+                                                          'list-ports', 'br-tun'])
+                    ports = ovs_output.strip().split('\n')
+                    look_up_gre_port = False
+                    for port in ports:
+                        if port.startswith('gre-'):
+                            look_up_gre_port = True
+                            break
+                    if not look_up_gre_port:
+                        try:
+                            LOG.error('Local agent has devices, but no ovs tunnel is created,'
+                                      'restart ovs agent.')
+                            cmd = ['sudo', 'service', 'neutron-plugin-openvswitch-agent',
+                                   'restart']
+                            subprocess.call(cmd)
+                        except subprocess.CalledProcessError:
+                            LOG.error('Failed to restart neutron-plugin-openvswitch-agent.')
+
+    def check_local_agents(self):
+        services = ['openvswitch-switch', 'neutron-dhcp-agent',
+                    'neutron-metadata-agent', 'neutron-vpn-agent']
+        for s in services:
+            status = ['sudo', 'service', s, 'status']
+            restart = ['sudo', 'service', s, 'restart']
+            start = ['sudo', 'service', s, 'start']
+            stop = '%s stop/waiting' % s
+            try:
+                output = subprocess.check_output(status)
+                if output.strip() == stop:
+                    subprocess.check_output(start)
+                    LOG.error('Restart service: %s' % s)
+                    if s == 'neutron-metadata-agent':
+                        subprocess.check_output(['sudo', 'service',
+                                                 'neutron-vpn-agent',
+                                                 'restart'])
+                        LOG.error('Restart neutron-vpn-agent')
+            except subprocess.CalledProcessError:
+                LOG.error('Restart service: %s' % s)
+                subprocess.check_output(restart)
+                if s == 'neutron-metadata-agent':
+                    subprocess.check_output(['sudo', 'service',
+                                             'neutron-vpn-agent',
+                                             'restart'])
+
+    def run(self):
+        while True:
+            LOG.info('Monitor Neutron HA Agent Loop Start')
+            quantum = self.get_quantum_client()
+            self.reassign_agent_resources(quantum=quantum)
+            self.check_ovs_tunnel(quantum=quantum)
+            self.check_local_agents()
+            LOG.info('sleep %s' % cfg.CONF.check_interval)
+            time.sleep(float(cfg.CONF.check_interval))
+
+
+if __name__ == '__main__':
+    opts = [
+        cfg.StrOpt('check_interval',
+                   default=8,
+                   help='Check Neutron Agents interval.'),
+    ]
+
+    cfg.CONF.register_cli_opts(opts)
+    cfg.CONF(project='monitor_neutron_agents', default_config_files=[])
+    logging.setup('Neuron-HA-Monitor')
+    monitor_daemon = MonitorNeutronAgentsDaemon()
+    monitor_daemon.start()

hooks/charmhelpers/__init__.py

@@ -1,3 +1,19 @@
+# Copyright 2014-2015 Canonical Limited.
+#
+# This file is part of charm-helpers.
+#
+# charm-helpers is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License version 3 as
+# published by the Free Software Foundation.
+#
+# charm-helpers is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with charm-helpers.  If not, see <http://www.gnu.org/licenses/>.
+
 # Bootstrap charm-helpers, installing its dependencies if necessary using
 # only standard libraries.
 import subprocess

hooks/charmhelpers/contrib/__init__.py

@@ -0,0 +1,15 @@
+# Copyright 2014-2015 Canonical Limited.
+#
+# This file is part of charm-helpers.
+#
+# charm-helpers is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License version 3 as
+# published by the Free Software Foundation.
+#
+# charm-helpers is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with charm-helpers.  If not, see <http://www.gnu.org/licenses/>.

hooks/charmhelpers/contrib/charmsupport/__init__.py

@@ -0,0 +1,15 @@
+# Copyright 2014-2015 Canonical Limited.
+#
+# This file is part of charm-helpers.
+#
+# charm-helpers is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License version 3 as
+# published by the Free Software Foundation.
+#
+# charm-helpers is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with charm-helpers.  If not, see <http://www.gnu.org/licenses/>.

hooks/charmhelpers/contrib/charmsupport/nrpe.py

@@ -1,3 +1,19 @@
+# Copyright 2014-2015 Canonical Limited.
+#
+# This file is part of charm-helpers.
+#
+# charm-helpers is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License version 3 as
+# published by the Free Software Foundation.
+#
+# charm-helpers is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with charm-helpers.  If not, see <http://www.gnu.org/licenses/>.
+
 """Compatibility with the nrpe-external-master charm"""
 # Copyright 2012 Canonical Ltd.
 #

hooks/charmhelpers/contrib/charmsupport/volumes.py

@@ -1,3 +1,19 @@
+# Copyright 2014-2015 Canonical Limited.
+#
+# This file is part of charm-helpers.
+#
+# charm-helpers is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License version 3 as
+# published by the Free Software Foundation.
+#
+# charm-helpers is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with charm-helpers.  If not, see <http://www.gnu.org/licenses/>.
+
 '''
 Functions for managing volumes in juju units. One volume is supported per unit.
 Subordinates may have their own storage, provided it is on its own partition.

hooks/charmhelpers/contrib/hahelpers/__init__.py

@@ -0,0 +1,15 @@
+# Copyright 2014-2015 Canonical Limited.
+#
+# This file is part of charm-helpers.
+#
+# charm-helpers is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License version 3 as
+# published by the Free Software Foundation.
+#
+# charm-helpers is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with charm-helpers.  If not, see <http://www.gnu.org/licenses/>.

hooks/charmhelpers/contrib/hahelpers/apache.py

@@ -1,3 +1,19 @@
+# Copyright 2014-2015 Canonical Limited.
+#
+# This file is part of charm-helpers.
+#
+# charm-helpers is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License version 3 as
+# published by the Free Software Foundation.
+#
+# charm-helpers is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with charm-helpers.  If not, see <http://www.gnu.org/licenses/>.
+
 #
 # Copyright 2012 Canonical Ltd.
 #

hooks/charmhelpers/contrib/hahelpers/cluster.py

@@ -1,3 +1,19 @@
+# Copyright 2014-2015 Canonical Limited.
+#
+# This file is part of charm-helpers.
+#
+# charm-helpers is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License version 3 as
+# published by the Free Software Foundation.
+#
+# charm-helpers is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with charm-helpers.  If not, see <http://www.gnu.org/licenses/>.
+
 #
 # Copyright 2012 Canonical Ltd.
 #
@@ -205,19 +221,23 @@ def determine_apache_port(public_port, singlenode_mode=False):
     return public_port - (i * 10)
 
 
-def get_hacluster_config():
+def get_hacluster_config(exclude_keys=None):
     '''
     Obtains all relevant configuration from charm configuration required
     for initiating a relation to hacluster:
 
         ha-bindiface, ha-mcastport, vip
 
+    param: exclude_keys: list of setting key(s) to be excluded.
     returns: dict: A dict containing settings keyed by setting name.
     raises: HAIncompleteConfig if settings are missing.
     '''
     settings = ['ha-bindiface', 'ha-mcastport', 'vip']
     conf = {}
     for setting in settings:
+        if exclude_keys and setting in exclude_keys:
+            continue
+
         conf[setting] = config_get(setting)
     missing = []
     [missing.append(s) for s, v in six.iteritems(conf) if v is None]

hooks/charmhelpers/contrib/network/__init__.py

@@ -0,0 +1,15 @@
+# Copyright 2014-2015 Canonical Limited.
+#
+# This file is part of charm-helpers.
+#
+# charm-helpers is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License version 3 as
+# published by the Free Software Foundation.
+#
+# charm-helpers is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with charm-helpers.  If not, see <http://www.gnu.org/licenses/>.

hooks/charmhelpers/contrib/network/ip.py

@@ -1,3 +1,19 @@
+# Copyright 2014-2015 Canonical Limited.
+#
+# This file is part of charm-helpers.
+#
+# charm-helpers is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License version 3 as
+# published by the Free Software Foundation.
+#
+# charm-helpers is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with charm-helpers.  If not, see <http://www.gnu.org/licenses/>.
+
 import glob
 import re
 import subprocess

hooks/charmhelpers/contrib/network/ovs/__init__.py

@@ -1,3 +1,19 @@
+# Copyright 2014-2015 Canonical Limited.
+#
+# This file is part of charm-helpers.
+#
+# charm-helpers is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License version 3 as
+# published by the Free Software Foundation.
+#
+# charm-helpers is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with charm-helpers.  If not, see <http://www.gnu.org/licenses/>.
+
 ''' Helpers for interacting with OpenvSwitch '''
 import subprocess
 import os

hooks/charmhelpers/contrib/network/ufw.py

@@ -1,3 +1,19 @@
+# Copyright 2014-2015 Canonical Limited.
+#
+# This file is part of charm-helpers.
+#
+# charm-helpers is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License version 3 as
+# published by the Free Software Foundation.
+#
+# charm-helpers is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with charm-helpers.  If not, see <http://www.gnu.org/licenses/>.
+
 """
 This module contains helpers to add and remove ufw rules.
 

hooks/charmhelpers/contrib/openstack/__init__.py

@@ -0,0 +1,15 @@
+# Copyright 2014-2015 Canonical Limited.
+#
+# This file is part of charm-helpers.
+#
+# charm-helpers is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License version 3 as
+# published by the Free Software Foundation.
+#
+# charm-helpers is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with charm-helpers.  If not, see <http://www.gnu.org/licenses/>.

hooks/charmhelpers/contrib/openstack/alternatives.py

@@ -1,3 +1,19 @@
+# Copyright 2014-2015 Canonical Limited.
+#
+# This file is part of charm-helpers.
+#
+# charm-helpers is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License version 3 as
+# published by the Free Software Foundation.
+#
+# charm-helpers is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with charm-helpers.  If not, see <http://www.gnu.org/licenses/>.
+
 ''' Helper for managing alternatives for file conflict resolution '''
 
 import subprocess

hooks/charmhelpers/contrib/openstack/amulet/__init__.py

@@ -0,0 +1,15 @@
+# Copyright 2014-2015 Canonical Limited.
+#
+# This file is part of charm-helpers.
+#
+# charm-helpers is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License version 3 as
+# published by the Free Software Foundation.
+#
+# charm-helpers is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with charm-helpers.  If not, see <http://www.gnu.org/licenses/>.

hooks/charmhelpers/contrib/openstack/amulet/deployment.py

@@ -1,3 +1,19 @@
+# Copyright 2014-2015 Canonical Limited.
+#
+# This file is part of charm-helpers.
+#
+# charm-helpers is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License version 3 as
+# published by the Free Software Foundation.
+#
+# charm-helpers is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with charm-helpers.  If not, see <http://www.gnu.org/licenses/>.
+
 import six
 from charmhelpers.contrib.amulet.deployment import (
     AmuletDeployment

hooks/charmhelpers/contrib/openstack/amulet/utils.py

@@ -1,3 +1,19 @@
+# Copyright 2014-2015 Canonical Limited.
+#
+# This file is part of charm-helpers.
+#
+# charm-helpers is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License version 3 as
+# published by the Free Software Foundation.
+#
+# charm-helpers is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with charm-helpers.  If not, see <http://www.gnu.org/licenses/>.
+
 import logging
 import os
 import time

hooks/charmhelpers/contrib/openstack/context.py

@@ -1,3 +1,19 @@
+# Copyright 2014-2015 Canonical Limited.
+#
+# This file is part of charm-helpers.
+#
+# charm-helpers is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License version 3 as
+# published by the Free Software Foundation.
+#
+# charm-helpers is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with charm-helpers.  If not, see <http://www.gnu.org/licenses/>.
+
 import json
 import os
 import time
@@ -468,21 +484,25 @@ class HAProxyContext(OSContextGenerator):
                             _unit = unit.replace('/', '-')
                             cluster_hosts[laddr]['backends'][_unit] = _laddr
 
-        # NOTE(jamespage) no split configurations found, just use
+        # NOTE(jamespage) add backend based on private address - this
-        # private addresses
+        # with either be the only backend or the fallback if no acls
-        if not cluster_hosts:
+        # match in the frontend
-            netmask = get_netmask_for_address(addr)
+        cluster_hosts[addr] = {}
-            cluster_hosts[addr] = {'network': "{}/{}".format(addr, netmask),
+        netmask = get_netmask_for_address(addr)
-                                   'backends': {l_unit: addr}}
+        cluster_hosts[addr] = {'network': "{}/{}".format(addr, netmask),
-            for rid in relation_ids('cluster'):
+                               'backends': {l_unit: addr}}
-                for unit in related_units(rid):
+        for rid in relation_ids('cluster'):
-                    _laddr = relation_get('private-address',
+            for unit in related_units(rid):
-                                          rid=rid, unit=unit)
+                _laddr = relation_get('private-address',
-                    if _laddr:
+                                      rid=rid, unit=unit)
-                        _unit = unit.replace('/', '-')
+                if _laddr:
-                        cluster_hosts[addr]['backends'][_unit] = _laddr
+                    _unit = unit.replace('/', '-')
+                    cluster_hosts[addr]['backends'][_unit] = _laddr
 
-        ctxt = {'frontends': cluster_hosts}
+        ctxt = {
+            'frontends': cluster_hosts,
+            'default_backend': addr
+        }
 
         if config('haproxy-server-timeout'):
             ctxt['haproxy_server_timeout'] = config('haproxy-server-timeout')
@@ -663,8 +683,9 @@ class ApacheSSLContext(OSContextGenerator):
         addresses = self.get_network_addresses()
         for address, endpoint in sorted(set(addresses)):
             for api_port in self.external_ports:
-                ext_port = determine_apache_port(api_port)
+                ext_port = determine_apache_port(api_port,
-                int_port = determine_api_port(api_port)
+                                                 singlenode_mode=True)
+                int_port = determine_api_port(api_port, singlenode_mode=True)
                 portmap = (address, endpoint, int(ext_port), int(int_port))
                 ctxt['endpoints'].append(portmap)
                 ctxt['ext_ports'].append(int(ext_port))

hooks/charmhelpers/contrib/openstack/ip.py

@@ -1,3 +1,19 @@
+# Copyright 2014-2015 Canonical Limited.
+#
+# This file is part of charm-helpers.
+#
+# charm-helpers is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License version 3 as
+# published by the Free Software Foundation.
+#
+# charm-helpers is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with charm-helpers.  If not, see <http://www.gnu.org/licenses/>.
+
 from charmhelpers.core.hookenv import (
     config,
     unit_get,

hooks/charmhelpers/contrib/openstack/neutron.py

@@ -1,3 +1,19 @@
+# Copyright 2014-2015 Canonical Limited.
+#
+# This file is part of charm-helpers.
+#
+# charm-helpers is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License version 3 as
+# published by the Free Software Foundation.
+#
+# charm-helpers is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with charm-helpers.  If not, see <http://www.gnu.org/licenses/>.
+
 # Various utilies for dealing with Neutron and the renaming from Quantum.
 
 from subprocess import check_output

hooks/charmhelpers/contrib/openstack/templates/__init__.py

@@ -1,2 +1,18 @@
+# Copyright 2014-2015 Canonical Limited.
+#
+# This file is part of charm-helpers.
+#
+# charm-helpers is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License version 3 as
+# published by the Free Software Foundation.
+#
+# charm-helpers is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with charm-helpers.  If not, see <http://www.gnu.org/licenses/>.
+
 # dummy __init__.py to fool syncer into thinking this is a syncable python
 # module

hooks/charmhelpers/contrib/openstack/templating.py

@@ -1,3 +1,19 @@
+# Copyright 2014-2015 Canonical Limited.
+#
+# This file is part of charm-helpers.
+#
+# charm-helpers is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License version 3 as
+# published by the Free Software Foundation.
+#
+# charm-helpers is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with charm-helpers.  If not, see <http://www.gnu.org/licenses/>.
+
 import os
 
 import six

hooks/charmhelpers/contrib/openstack/utils.py

@@ -1,5 +1,21 @@
 #!/usr/bin/python
 
+# Copyright 2014-2015 Canonical Limited.
+#
+# This file is part of charm-helpers.
+#
+# charm-helpers is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License version 3 as
+# published by the Free Software Foundation.
+#
+# charm-helpers is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with charm-helpers.  If not, see <http://www.gnu.org/licenses/>.
+
 # Common python helper functions used for OpenStack charms.
 from collections import OrderedDict
 from functools import wraps

hooks/charmhelpers/contrib/python/__init__.py

@@ -0,0 +1,15 @@
+# Copyright 2014-2015 Canonical Limited.
+#
+# This file is part of charm-helpers.
+#
+# charm-helpers is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License version 3 as
+# published by the Free Software Foundation.
+#
+# charm-helpers is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with charm-helpers.  If not, see <http://www.gnu.org/licenses/>.

hooks/charmhelpers/contrib/python/packages.py

@@ -1,6 +1,22 @@
 #!/usr/bin/env python
 # coding: utf-8
 
+# Copyright 2014-2015 Canonical Limited.
+#
+# This file is part of charm-helpers.
+#
+# charm-helpers is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License version 3 as
+# published by the Free Software Foundation.
+#
+# charm-helpers is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with charm-helpers.  If not, see <http://www.gnu.org/licenses/>.
+
 __author__ = "Jorge Niedbalski <jorge.niedbalski@canonical.com>"
 
 from charmhelpers.fetch import apt_install, apt_update
@@ -35,7 +51,7 @@ def pip_install_requirements(requirements, **options):
     pip_execute(command)
 
 
-def pip_install(package, fatal=False, **options):
+def pip_install(package, fatal=False, upgrade=False, **options):
     """Install a python package"""
     command = ["install"]
 
@@ -43,6 +59,9 @@ def pip_install(package, fatal=False, **options):
     for option in parse_options(options, available_options):
         command.append(option)
 
+    if upgrade:
+        command.append('--upgrade')
+
     if isinstance(package, list):
         command.extend(package)
     else:

hooks/charmhelpers/contrib/storage/__init__.py

@@ -0,0 +1,15 @@
+# Copyright 2014-2015 Canonical Limited.
+#
+# This file is part of charm-helpers.
+#
+# charm-helpers is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License version 3 as
+# published by the Free Software Foundation.
+#
+# charm-helpers is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with charm-helpers.  If not, see <http://www.gnu.org/licenses/>.

hooks/charmhelpers/contrib/storage/linux/__init__.py

@@ -0,0 +1,15 @@
+# Copyright 2014-2015 Canonical Limited.
+#
+# This file is part of charm-helpers.
+#
+# charm-helpers is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License version 3 as
+# published by the Free Software Foundation.
+#
+# charm-helpers is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with charm-helpers.  If not, see <http://www.gnu.org/licenses/>.

hooks/charmhelpers/contrib/storage/linux/ceph.py

@@ -1,3 +1,19 @@
+# Copyright 2014-2015 Canonical Limited.
+#
+# This file is part of charm-helpers.
+#
+# charm-helpers is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License version 3 as
+# published by the Free Software Foundation.
+#
+# charm-helpers is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with charm-helpers.  If not, see <http://www.gnu.org/licenses/>.
+
 #
 # Copyright 2012 Canonical Ltd.
 #
@@ -157,6 +173,17 @@ def create_keyring(service, key):
     log('Created new ceph keyring at %s.' % keyring, level=DEBUG)
 
 
+def delete_keyring(service):
+    """Delete an existing Ceph keyring."""
+    keyring = _keyring_path(service)
+    if not os.path.exists(keyring):
+        log('Keyring does not exist at %s' % keyring, level=WARNING)
+        return
+
+    os.remove(keyring)
+    log('Deleted ring at %s.' % keyring, level=INFO)
+
+
 def create_key_file(service, key):
     """Create a file containing key."""
     keyfile = _keyfile_path(service)

hooks/charmhelpers/contrib/storage/linux/loopback.py

@@ -1,3 +1,19 @@
+# Copyright 2014-2015 Canonical Limited.
+#
+# This file is part of charm-helpers.
+#
+# charm-helpers is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License version 3 as
+# published by the Free Software Foundation.
+#
+# charm-helpers is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with charm-helpers.  If not, see <http://www.gnu.org/licenses/>.
+
 import os
 import re
 from subprocess import (

hooks/charmhelpers/contrib/storage/linux/lvm.py

@@ -1,3 +1,19 @@
+# Copyright 2014-2015 Canonical Limited.
+#
+# This file is part of charm-helpers.
+#
+# charm-helpers is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License version 3 as
+# published by the Free Software Foundation.
+#
+# charm-helpers is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with charm-helpers.  If not, see <http://www.gnu.org/licenses/>.
+
 from subprocess import (
     CalledProcessError,
     check_call,

hooks/charmhelpers/contrib/storage/linux/utils.py

@@ -1,3 +1,19 @@
+# Copyright 2014-2015 Canonical Limited.
+#
+# This file is part of charm-helpers.
+#
+# charm-helpers is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License version 3 as
+# published by the Free Software Foundation.
+#
+# charm-helpers is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with charm-helpers.  If not, see <http://www.gnu.org/licenses/>.
+
 import os
 import re
 from stat import S_ISBLK

hooks/charmhelpers/core/__init__.py

@@ -0,0 +1,15 @@
+# Copyright 2014-2015 Canonical Limited.
+#
+# This file is part of charm-helpers.
+#
+# charm-helpers is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License version 3 as
+# published by the Free Software Foundation.
+#
+# charm-helpers is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with charm-helpers.  If not, see <http://www.gnu.org/licenses/>.

hooks/charmhelpers/core/decorators.py

@@ -1,3 +1,19 @@
+# Copyright 2014-2015 Canonical Limited.
+#
+# This file is part of charm-helpers.
+#
+# charm-helpers is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License version 3 as
+# published by the Free Software Foundation.
+#
+# charm-helpers is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with charm-helpers.  If not, see <http://www.gnu.org/licenses/>.
+
 #
 # Copyright 2014 Canonical Ltd.
 #

hooks/charmhelpers/core/fstab.py

@@ -1,6 +1,22 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 
+# Copyright 2014-2015 Canonical Limited.
+#
+# This file is part of charm-helpers.
+#
+# charm-helpers is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License version 3 as
+# published by the Free Software Foundation.
+#
+# charm-helpers is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with charm-helpers.  If not, see <http://www.gnu.org/licenses/>.
+
 __author__ = 'Jorge Niedbalski R. <jorge.niedbalski@canonical.com>'
 
 import io

hooks/charmhelpers/core/hookenv.py

@@ -1,3 +1,19 @@
+# Copyright 2014-2015 Canonical Limited.
+#
+# This file is part of charm-helpers.
+#
+# charm-helpers is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License version 3 as
+# published by the Free Software Foundation.
+#
+# charm-helpers is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with charm-helpers.  If not, see <http://www.gnu.org/licenses/>.
+
 "Interactions with the Juju environment"
 # Copyright 2013 Canonical Ltd.
 #

hooks/charmhelpers/core/host.py

@@ -1,3 +1,19 @@
+# Copyright 2014-2015 Canonical Limited.
+#
+# This file is part of charm-helpers.
+#
+# charm-helpers is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License version 3 as
+# published by the Free Software Foundation.
+#
+# charm-helpers is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with charm-helpers.  If not, see <http://www.gnu.org/licenses/>.
+
 """Tools for working with the host system"""
 # Copyright 2012 Canonical Ltd.
 #
@@ -168,10 +184,10 @@ def mkdir(path, owner='root', group='root', perms=0o555, force=False):
             log("Removing non-directory file {} prior to mkdir()".format(path))
             os.unlink(realpath)
             os.makedirs(realpath, perms)
-        os.chown(realpath, uid, gid)
     elif not path_exists:
         os.makedirs(realpath, perms)
-        os.chown(realpath, uid, gid)
+    os.chown(realpath, uid, gid)
+    os.chmod(realpath, perms)
 
 
 def write_file(path, content, owner='root', group='root', perms=0o444):
@@ -389,6 +405,9 @@ def cmp_pkgrevno(package, revno, pkgcache=None):
     *  0 => Installed revno is the same as supplied arg
     * -1 => Installed revno is less than supplied arg
 
+    This function imports apt_cache function from charmhelpers.fetch if
+    the pkgcache argument is None. Be sure to add charmhelpers.fetch if
+    you call this function, or pass an apt_pkg.Cache() instance.
     '''
     import apt_pkg
     if not pkgcache:
@@ -407,13 +426,21 @@ def chdir(d):
         os.chdir(cur)
 
 
-def chownr(path, owner, group):
+def chownr(path, owner, group, follow_links=True):
     uid = pwd.getpwnam(owner).pw_uid
     gid = grp.getgrnam(group).gr_gid
+    if follow_links:
+        chown = os.chown
+    else:
+        chown = os.lchown
 
     for root, dirs, files in os.walk(path):
         for name in dirs + files:
             full = os.path.join(root, name)
             broken_symlink = os.path.lexists(full) and not os.path.exists(full)
             if not broken_symlink:
-                os.chown(full, uid, gid)
+                chown(full, uid, gid)
+
+
+def lchownr(path, owner, group):
+    chownr(path, owner, group, follow_links=False)

hooks/charmhelpers/core/services/__init__.py

@@ -1,2 +1,18 @@
+# Copyright 2014-2015 Canonical Limited.
+#
+# This file is part of charm-helpers.
+#
+# charm-helpers is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License version 3 as
+# published by the Free Software Foundation.
+#
+# charm-helpers is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with charm-helpers.  If not, see <http://www.gnu.org/licenses/>.
+
 from .base import *  # NOQA
 from .helpers import *  # NOQA

hooks/charmhelpers/core/services/base.py

@@ -1,3 +1,19 @@
+# Copyright 2014-2015 Canonical Limited.
+#
+# This file is part of charm-helpers.
+#
+# charm-helpers is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License version 3 as
+# published by the Free Software Foundation.
+#
+# charm-helpers is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with charm-helpers.  If not, see <http://www.gnu.org/licenses/>.
+
 import os
 import re
 import json

hooks/charmhelpers/core/services/helpers.py

@@ -1,3 +1,19 @@
+# Copyright 2014-2015 Canonical Limited.
+#
+# This file is part of charm-helpers.
+#
+# charm-helpers is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License version 3 as
+# published by the Free Software Foundation.
+#
+# charm-helpers is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with charm-helpers.  If not, see <http://www.gnu.org/licenses/>.
+
 import os
 import yaml
 from charmhelpers.core import hookenv

hooks/charmhelpers/core/sysctl.py

@@ -1,6 +1,22 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 
+# Copyright 2014-2015 Canonical Limited.
+#
+# This file is part of charm-helpers.
+#
+# charm-helpers is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License version 3 as
+# published by the Free Software Foundation.
+#
+# charm-helpers is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with charm-helpers.  If not, see <http://www.gnu.org/licenses/>.
+
 __author__ = 'Jorge Niedbalski R. <jorge.niedbalski@canonical.com>'
 
 import yaml

hooks/charmhelpers/core/templating.py

@@ -1,3 +1,19 @@
+# Copyright 2014-2015 Canonical Limited.
+#
+# This file is part of charm-helpers.
+#
+# charm-helpers is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License version 3 as
+# published by the Free Software Foundation.
+#
+# charm-helpers is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with charm-helpers.  If not, see <http://www.gnu.org/licenses/>.
+
 import os
 
 from charmhelpers.core import host

hooks/charmhelpers/fetch/__init__.py

@@ -1,3 +1,19 @@
+# Copyright 2014-2015 Canonical Limited.
+#
+# This file is part of charm-helpers.
+#
+# charm-helpers is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License version 3 as
+# published by the Free Software Foundation.
+#
+# charm-helpers is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with charm-helpers.  If not, see <http://www.gnu.org/licenses/>.
+
 import importlib
 from tempfile import NamedTemporaryFile
 import time

hooks/charmhelpers/fetch/archiveurl.py

@@ -1,3 +1,19 @@
+# Copyright 2014-2015 Canonical Limited.
+#
+# This file is part of charm-helpers.
+#
+# charm-helpers is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License version 3 as
+# published by the Free Software Foundation.
+#
+# charm-helpers is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with charm-helpers.  If not, see <http://www.gnu.org/licenses/>.
+
 import os
 import hashlib
 import re

hooks/charmhelpers/fetch/bzrurl.py

@@ -1,3 +1,19 @@
+# Copyright 2014-2015 Canonical Limited.
+#
+# This file is part of charm-helpers.
+#
+# charm-helpers is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License version 3 as
+# published by the Free Software Foundation.
+#
+# charm-helpers is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with charm-helpers.  If not, see <http://www.gnu.org/licenses/>.
+
 import os
 from charmhelpers.fetch import (
     BaseFetchHandler,
@@ -11,10 +27,12 @@ if six.PY3:
 
 try:
     from bzrlib.branch import Branch
+    from bzrlib import bzrdir, workingtree, errors
 except ImportError:
     from charmhelpers.fetch import apt_install
     apt_install("python-bzrlib")
     from bzrlib.branch import Branch
+    from bzrlib import bzrdir, workingtree, errors
 
 
 class BzrUrlFetchHandler(BaseFetchHandler):
@@ -34,9 +52,15 @@ class BzrUrlFetchHandler(BaseFetchHandler):
         if url_parts.scheme == "lp":
             from bzrlib.plugin import load_plugins
             load_plugins()
+        try:
+            local_branch = bzrdir.BzrDir.create_branch_convenience(dest)
+        except errors.AlreadyControlDirError:
+            local_branch = Branch.open(dest)
         try:
             remote_branch = Branch.open(source)
-            remote_branch.bzrdir.sprout(dest).open_branch()
+            remote_branch.push(local_branch)
+            tree = workingtree.WorkingTree.open(dest)
+            tree.update()
         except Exception as e:
             raise e
 

hooks/charmhelpers/fetch/giturl.py

@@ -1,3 +1,19 @@
+# Copyright 2014-2015 Canonical Limited.
+#
+# This file is part of charm-helpers.
+#
+# charm-helpers is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License version 3 as
+# published by the Free Software Foundation.
+#
+# charm-helpers is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with charm-helpers.  If not, see <http://www.gnu.org/licenses/>.
+
 import os
 from charmhelpers.fetch import (
     BaseFetchHandler,
@@ -16,6 +32,8 @@ except ImportError:
     apt_install("python-git")
     from git import Repo
 
+from git.exc import GitCommandError
+
 
 class GitUrlFetchHandler(BaseFetchHandler):
     """Handler for git branches via generic and github URLs"""
@@ -46,6 +64,8 @@ class GitUrlFetchHandler(BaseFetchHandler):
             mkdir(dest_dir, perms=0o755)
         try:
             self.clone(source, dest_dir, branch)
+        except GitCommandError as e:
+            raise UnhandledSource(e.message)
         except OSError as e:
             raise UnhandledSource(e.strerror)
         return dest_dir

hooks/charmhelpers/payload/__init__.py

@@ -1 +1,17 @@
+# Copyright 2014-2015 Canonical Limited.
+#
+# This file is part of charm-helpers.
+#
+# charm-helpers is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License version 3 as
+# published by the Free Software Foundation.
+#
+# charm-helpers is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with charm-helpers.  If not, see <http://www.gnu.org/licenses/>.
+
 "Tools for working with files injected into a charm just before deployment."

hooks/charmhelpers/payload/execd.py

@@ -1,5 +1,21 @@
 #!/usr/bin/env python
 
+# Copyright 2014-2015 Canonical Limited.
+#
+# This file is part of charm-helpers.
+#
+# charm-helpers is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License version 3 as
+# published by the Free Software Foundation.
+#
+# charm-helpers is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with charm-helpers.  If not, see <http://www.gnu.org/licenses/>.
+
 import os
 import sys
 import subprocess

hooks/ha-relation-departed

@@ -0,0 +1 @@
+quantum_hooks.py

hooks/quantum_hooks.py

@@ -23,6 +23,7 @@ from charmhelpers.core.host import (
     lsb_release,
 )
 from charmhelpers.contrib.hahelpers.cluster import(
+    get_hacluster_config,
     eligible_leader
 )
 from charmhelpers.contrib.hahelpers.apache import(
@@ -48,8 +49,14 @@ from quantum_utils import (
     get_common_package,
     valid_plugin,
     configure_ovs,
+    stop_services,
+    cache_env_data,
+    update_legacy_ha_files,
+    remove_legacy_ha_files,
+    install_legacy_ha_files,
+    cleanup_ovs_netns,
     reassign_agent_resources,
-    stop_services
+    stop_neutron_ha_monitor_daemon
 )
 
 hooks = Hooks()
@@ -75,6 +82,9 @@ def install():
         log('Please provide a valid plugin config', level=ERROR)
         sys.exit(1)
 
+    # Legacy HA for Icehouse
+    update_legacy_ha_files()
+
 
 @hooks.hook('config-changed')
 @restart_on_change(restart_map())
@@ -109,11 +119,15 @@ def config_changed():
         else:
             apt_purge('neutron-l3-agent')
 
+    # Setup legacy ha configurations
+    update_legacy_ha_files()
+
 
 @hooks.hook('upgrade-charm')
 def upgrade_charm():
     install()
     config_changed()
+    update_legacy_ha_files(force=True)
 
 
 @hooks.hook('shared-db-relation-joined')
@@ -194,6 +208,9 @@ def nm_changed():
         ca_crt = b64decode(relation_get('ca_cert'))
         install_ca_cert(ca_crt)
 
+    if config('ha-legacy-mode'):
+        cache_env_data()
+
 
 @hooks.hook("cluster-relation-departed")
 @restart_on_change(restart_map())
@@ -207,7 +224,7 @@ def cluster_departed():
         log('Unable to re-assign agent resources for failed nodes with n1kv',
             level=WARNING)
         return
-    if eligible_leader(None):
+    if not config('ha-legacy-mode') and eligible_leader(None):
         reassign_agent_resources()
         CONFIGS.write_all()
 
@@ -216,6 +233,9 @@ def cluster_departed():
 @hooks.hook('stop')
 def stop():
     stop_services()
+    if config('ha-legacy-mode'):
+        # Cleanup ovs and netns for destroyed units.
+        cleanup_ovs_netns()
 
 
 @hooks.hook('nrpe-external-master-relation-joined',
@@ -244,6 +264,40 @@ def update_nrpe_config():
     nrpe_setup.write()
 
 
+@hooks.hook('ha-relation-joined')
+@hooks.hook('ha-relation-changed')
+def ha_relation_joined():
+    if config('ha-legacy-mode'):
+        log('ha-relation-changed update_legacy_ha_files')
+        install_legacy_ha_files()
+        cache_env_data()
+        cluster_config = get_hacluster_config(exclude_keys=['vip'])
+        resources = {
+            'res_monitor': 'ocf:canonical:NeutronAgentMon',
+        }
+        resource_params = {
+            'res_monitor': 'op monitor interval="60s"',
+        }
+        clones = {
+            'cl_monitor': 'res_monitor meta interleave="true"',
+        }
+
+        relation_set(corosync_bindiface=cluster_config['ha-bindiface'],
+                     corosync_mcastport=cluster_config['ha-mcastport'],
+                     resources=resources,
+                     resource_params=resource_params,
+                     clones=clones)
+
+
+@hooks.hook('ha-relation-departed')
+def ha_relation_destroyed():
+    # If e.g. we want to upgrade to Juno and use native Neutron HA support then
+    # we need to un-corosync-cluster to enable the transition.
+    if config('ha-legacy-mode'):
+        stop_neutron_ha_monitor_daemon()
+        remove_legacy_ha_files()
+
+
 if __name__ == '__main__':
     try:
         hooks.execute(sys.argv)

hooks/quantum_utils.py

@@ -1,11 +1,18 @@
+import os
+import subprocess
+from shutil import copy2
 from charmhelpers.core.host import (
+    mkdir,
     service_running,
     service_stop,
     service_restart,
-    lsb_release
+    lsb_release,
 )
 from charmhelpers.core.hookenv import (
     log,
+    DEBUG,
+    INFO,
+    ERROR,
     config,
     relations_of_type,
     unit_private_ip,
@@ -145,6 +152,22 @@ EARLY_PACKAGES = {
     N1KV: []
 }
 
+LEGACY_HA_TEMPLATE_FILES = 'files'
+LEGACY_FILES_MAP = {
+    'neutron-ha-monitor.py': {
+        'path': '/usr/local/bin/',
+        'permissions': 0o755
+    },
+    'neutron-ha-monitor.conf': {
+        'path': '/var/lib/juju-neutron-ha/',
+    },
+    'NeutronAgentMon': {
+        'path': '/usr/lib/ocf/resource.d/canonical',
+        'permissions': 0o755
+    },
+}
+LEGACY_RES_MAP = ['res_monitor']
+
 
 def get_early_packages():
     '''Return a list of package for pre-install based on configured plugin'''
@@ -580,3 +603,100 @@ def configure_ovs():
         if data_port_ctx and data_port_ctx['data_port']:
             add_bridge_port(DATA_BRIDGE, data_port_ctx['data_port'],
                             promisc=True)
+
+
+def copy_file(src, dst, perms=None, force=False):
+    """Copy file to destination and optionally set permissionss.
+
+    If destination does not exist it will be created.
+    """
+    if not os.path.isdir(dst):
+        log('Creating directory %s' % dst, level=DEBUG)
+        mkdir(dst)
+
+    fdst = os.path.join(dst, os.path.basename(src))
+    if not os.path.isfile(fdst) or force:
+        try:
+            copy2(src, fdst)
+            if perms:
+                os.chmod(fdst, perms)
+        except IOError:
+            log('Failed to copy file from %s to %s.' % (src, dst), level=ERROR)
+            raise
+
+
+def remove_file(path):
+    if not os.path.isfile(path):
+        log('File %s does not exist.' % path, level=INFO)
+        return
+
+    try:
+        os.remove(path)
+    except IOError:
+        log('Failed to remove file %s.' % path, level=ERROR)
+
+
+def install_legacy_ha_files(force=False):
+    for f, p in LEGACY_FILES_MAP.iteritems():
+        srcfile = os.path.join(LEGACY_HA_TEMPLATE_FILES, f)
+        copy_file(srcfile, p['path'], p.get('permissions', None), force=force)
+
+
+def remove_legacy_ha_files():
+    for f, p in LEGACY_FILES_MAP.iteritems():
+        remove_file(os.path.join(p['path'], f))
+
+
+def update_legacy_ha_files(force=False):
+    if config('ha-legacy-mode'):
+        install_legacy_ha_files(force=force)
+    else:
+        remove_legacy_ha_files()
+
+
+def cache_env_data():
+    env = NetworkServiceContext()()
+    if not env:
+        log('Unable to get NetworkServiceContext at this time', level=ERROR)
+        return
+
+    no_envrc = False
+    envrc_f = '/etc/legacy_ha_envrc'
+    if os.path.isfile(envrc_f):
+        with open(envrc_f, 'r') as f:
+            data = f.read()
+
+        data = data.strip().split('\n')
+        diff = False
+        for line in data:
+            k = line.split('=')[0]
+            v = line.split('=')[1]
+            if k not in env or v != env[k]:
+                diff = True
+                break
+    else:
+        no_envrc = True
+
+    if no_envrc or diff:
+        with open(envrc_f, 'w') as f:
+            for k, v in env.items():
+                f.write(''.join([k, '=', v, '\n']))
+
+
+def stop_neutron_ha_monitor_daemon():
+    try:
+        cmd = ['pgrep', '-f', 'neutron-ha-monitor.py']
+        res = subprocess.check_output(cmd).decode('UTF-8')
+        pid = res.strip()
+        if pid:
+            subprocess.call(['sudo', 'kill', '-9', pid])
+    except subprocess.CalledProcessError as e:
+        log('Faild to kill neutron-ha-monitor daemon, %s' % e, level=ERROR)
+
+
+def cleanup_ovs_netns():
+    try:
+        subprocess.call('neutron-ovs-cleanup')
+        subprocess.call('neutron-netns-cleanup')
+    except subprocess.CalledProcessError as e:
+        log('Faild to cleanup ovs and netns, %s' % e, level=ERROR)

metadata.yaml

@@ -32,6 +32,9 @@ requires:
     interface: rabbitmq
   neutron-plugin-api:
     interface: neutron-plugin-api
+  ha:
+    interface: hacluster
+    scope: container
 peers:
   cluster:
     interface: quantum-gateway-ha

tests/charmhelpers/__init__.py

@@ -1,3 +1,19 @@
+# Copyright 2014-2015 Canonical Limited.
+#
+# This file is part of charm-helpers.
+#
+# charm-helpers is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License version 3 as
+# published by the Free Software Foundation.
+#
+# charm-helpers is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with charm-helpers.  If not, see <http://www.gnu.org/licenses/>.
+
 # Bootstrap charm-helpers, installing its dependencies if necessary using
 # only standard libraries.
 import subprocess

tests/charmhelpers/contrib/__init__.py

@@ -0,0 +1,15 @@
+# Copyright 2014-2015 Canonical Limited.
+#
+# This file is part of charm-helpers.
+#
+# charm-helpers is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License version 3 as
+# published by the Free Software Foundation.
+#
+# charm-helpers is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with charm-helpers.  If not, see <http://www.gnu.org/licenses/>.

tests/charmhelpers/contrib/amulet/__init__.py

@@ -0,0 +1,15 @@
+# Copyright 2014-2015 Canonical Limited.
+#
+# This file is part of charm-helpers.
+#
+# charm-helpers is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License version 3 as
+# published by the Free Software Foundation.
+#
+# charm-helpers is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with charm-helpers.  If not, see <http://www.gnu.org/licenses/>.

tests/charmhelpers/contrib/amulet/deployment.py

@@ -1,3 +1,19 @@
+# Copyright 2014-2015 Canonical Limited.
+#
+# This file is part of charm-helpers.
+#
+# charm-helpers is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License version 3 as
+# published by the Free Software Foundation.
+#
+# charm-helpers is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with charm-helpers.  If not, see <http://www.gnu.org/licenses/>.
+
 import amulet
 import os
 import six

tests/charmhelpers/contrib/amulet/utils.py

@@ -1,3 +1,19 @@
+# Copyright 2014-2015 Canonical Limited.
+#
+# This file is part of charm-helpers.
+#
+# charm-helpers is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License version 3 as
+# published by the Free Software Foundation.
+#
+# charm-helpers is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with charm-helpers.  If not, see <http://www.gnu.org/licenses/>.
+
 import ConfigParser
 import io
 import logging

tests/charmhelpers/contrib/openstack/__init__.py

@@ -0,0 +1,15 @@
+# Copyright 2014-2015 Canonical Limited.
+#
+# This file is part of charm-helpers.
+#
+# charm-helpers is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License version 3 as
+# published by the Free Software Foundation.
+#
+# charm-helpers is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with charm-helpers.  If not, see <http://www.gnu.org/licenses/>.

tests/charmhelpers/contrib/openstack/amulet/__init__.py

@@ -0,0 +1,15 @@
+# Copyright 2014-2015 Canonical Limited.
+#
+# This file is part of charm-helpers.
+#
+# charm-helpers is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License version 3 as
+# published by the Free Software Foundation.
+#
+# charm-helpers is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with charm-helpers.  If not, see <http://www.gnu.org/licenses/>.

tests/charmhelpers/contrib/openstack/amulet/deployment.py

@@ -1,3 +1,19 @@
+# Copyright 2014-2015 Canonical Limited.
+#
+# This file is part of charm-helpers.
+#
+# charm-helpers is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License version 3 as
+# published by the Free Software Foundation.
+#
+# charm-helpers is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with charm-helpers.  If not, see <http://www.gnu.org/licenses/>.
+
 import six
 from charmhelpers.contrib.amulet.deployment import (
     AmuletDeployment

tests/charmhelpers/contrib/openstack/amulet/utils.py

@@ -1,3 +1,19 @@
+# Copyright 2014-2015 Canonical Limited.
+#
+# This file is part of charm-helpers.
+#
+# charm-helpers is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License version 3 as
+# published by the Free Software Foundation.
+#
+# charm-helpers is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with charm-helpers.  If not, see <http://www.gnu.org/licenses/>.
+
 import logging
 import os
 import time

unit_tests/test_quantum_hooks.py

@@ -33,8 +33,6 @@ TO_PATCH = [
     'unit_get',
     'relation_get',
     'install_ca_cert',
-    'eligible_leader',
-    'reassign_agent_resources',
     'get_common_package',
     'execd_preinstall',
     'lsb_release',
@@ -43,6 +41,13 @@ TO_PATCH = [
     'is_relation_made',
     'create_sysctl',
     'update_nrpe_config',
+    'update_legacy_ha_files',
+    'install_legacy_ha_files',
+    'cache_env_data',
+    'get_hacluster_config',
+    'remove_legacy_ha_files',
+    'cleanup_ovs_netns',
+    'stop_neutron_ha_monitor_daemon'
 ]
 
 
@@ -245,19 +250,25 @@ class TestQuantumHooks(CharmTestCase):
         self.test_config.set('plugin', 'nvp')
         self._call_hook('cluster-relation-departed')
         self.assertTrue(self.log.called)
-        self.assertFalse(self.eligible_leader.called)
-        self.assertFalse(self.reassign_agent_resources.called)
-
-    def test_cluster_departed_ovs_not_leader(self):
-        self.eligible_leader.return_value = False
-        self._call_hook('cluster-relation-departed')
-        self.assertFalse(self.reassign_agent_resources.called)
-
-    def test_cluster_departed_ovs_leader(self):
-        self.eligible_leader.return_value = True
-        self._call_hook('cluster-relation-departed')
-        self.assertTrue(self.reassign_agent_resources.called)
 
     def test_stop(self):
         self._call_hook('stop')
         self.assertTrue(self.stop_services.called)
+
+    def test_ha_relation_joined(self):
+        self.test_config.set('ha-legacy-mode', True)
+        self._call_hook('ha_relation_joined')
+        self.assertTrue(self.cache_env_data.called)
+        self.assertTrue(self.get_hacluster_config.called)
+        self.assertTrue(self.install_legacy_ha_files.called)
+
+    def test_ha_relation_departed(self):
+        self.test_config.set('ha-legacy-mode', True)
+        self._call_hook('ha-relation-departed')
+        self.assertTrue(self.remove_legacy_ha_files.called)
+        self.assertTrue(self.stop_neutron_ha_monitor_daemon.called)
+
+    def test_quantum_network_service_relation_changed(self):
+        self.test_config.set('ha-legacy-mode', True)
+        self._call_hook('quantum-network-service-relation-changed')
+        self.assertTrue(self.cache_env_data.called)

unit_tests/test_quantum_utils.py

@@ -44,7 +44,9 @@ TO_PATCH = [
     'service_restart',
     'remap_plugin',
     'is_relation_made',
-    'lsb_release'
+    'lsb_release',
+    'mkdir',
+    'copy2'
 ]
 
 
@@ -365,6 +367,40 @@ class TestQuantumUtils(CharmTestCase):
         self.get_os_codename_package.return_value = None
         self.assertEquals(quantum_utils.get_common_package(), 'neutron-common')
 
+    def test_copy_file_without_update(self):
+        src = 'dummy_source_dir/dummy_file'
+        dst = 'dummy_des_dir'
+        quantum_utils.copy_file(src, dst)
+        self.assertTrue(self.mkdir.called)
+        self.assertTrue(self.copy2.called)
+
+    @patch('quantum_utils.os.path.isfile')
+    def test_copy_file_with_update(self, _isfile):
+        src = 'dummy_source_dir/dummy_file'
+        dst = 'dummy_des_dir'
+        _isfile.return_value = False
+        quantum_utils.copy_file(src, dst, force=True)
+        self.assertTrue(self.mkdir.called)
+        self.assertTrue(self.copy2.called)
+
+    @patch('quantum_utils.os.remove')
+    @patch('quantum_utils.os.path.isfile')
+    def test_remove_file_exists(self, _isfile, _remove):
+        path = 'dummy_des_dir/dummy_file'
+        _isfile.return_value = True
+        quantum_utils.remove_file(path)
+        self.assertTrue(_remove.called)
+        self.assertFalse(self.log.called)
+
+    @patch('quantum_utils.os.remove')
+    @patch('quantum_utils.os.path.isfile')
+    def test_remove_file_non_exists(self, _isfile, _remove):
+        path = 'dummy_des_dir/dummy_file'
+        _isfile.return_value = False
+        quantum_utils.remove_file(path)
+        self.assertFalse(_remove.called)
+        self.assertTrue(self.log.called)
+
 
 network_context = {
     'service_username': 'foo',