--- a/heartbeat/gcp-vpc-move-vip.in 2020-08-03 15:48:28.497845842 +0200 +++ b/heartbeat/gcp-vpc-move-vip.in 2020-08-03 15:49:24.129888908 +0200 @@ -22,7 +22,8 @@ import sys import time -OCF_FUNCTIONS_DIR="%s/lib/heartbeat" % os.environ.get("OCF_ROOT") +OCF_FUNCTIONS_DIR = os.environ.get("OCF_FUNCTIONS_DIR", "%s/lib/heartbeat" + % os.environ.get("OCF_ROOT")) sys.path.append(OCF_FUNCTIONS_DIR) from ocf import * @@ -43,6 +44,10 @@ import urllib2 as urlrequest +# Constants for alias add/remove modes +ADD = 0 +REMOVE = 1 + CONN = None THIS_VM = None ALIAS = None @@ -53,27 +58,27 @@ 1.0 - Floating IP Address on Google Cloud Platform - Using Alias IP address functionality to attach a secondary IP address to a running instance - Floating IP Address on Google Cloud Platform + Floating IP Address or Range on Google Cloud Platform - Using Alias IP address functionality to attach a secondary IP range to a running instance + Floating IP Address or Range on Google Cloud Platform - IP Address to be added including CIDR. E.g 192.168.0.1/32 - IP Address to be added including CIDR. E.g 192.168.0.1/32 + IP range to be added including CIDR netmask (e.g., 192.168.0.1/32) + IP range to be added including CIDR netmask (e.g., 192.168.0.1/32) - + Subnet name for the Alias IP Subnet name for the Alias IP - - List of hosts in the cluster + + List of hosts in the cluster, separated by spaces Host list - If enabled (set to true), IP failover logs will be posted to stackdriver logging. Using stackdriver logging requires additional libraries (google-cloud-logging). - Stackdriver-logging support. Requires additional libraries (google-cloud-logging). + If enabled (set to true), IP failover logs will be posted to stackdriver logging + Stackdriver-logging support @@ -107,7 +112,8 @@ url = '%s?%s' % (metadata_url, params) request = urlrequest.Request(url, headers=METADATA_HEADERS) request_opener = urlrequest.build_opener(urlrequest.ProxyHandler({})) - return request_opener.open(request, timeout=timeout * 1.1).read() + return request_opener.open( + request, timeout=timeout * 1.1).read().decode("utf-8") def get_instance(project, zone, instance): @@ -134,17 +140,21 @@ time.sleep(1) -def set_alias(project, zone, instance, alias, alias_range_name=None): - fingerprint = get_network_ifaces(project, zone, instance)[0]['fingerprint'] +def set_aliases(project, zone, instance, aliases, fingerprint): + """Sets the alias IP ranges for an instance. + + Args: + project: string, the project in which the instance resides. + zone: string, the zone in which the instance resides. + instance: string, the name of the instance. + aliases: list, the list of dictionaries containing alias IP ranges + to be added to or removed from the instance. + fingerprint: string, the fingerprint of the network interface. + """ body = { - 'aliasIpRanges': [], - 'fingerprint': fingerprint + 'aliasIpRanges': aliases, + 'fingerprint': fingerprint } - if alias: - obj = {'ipCidrRange': alias} - if alias_range_name: - obj['subnetworkRangeName'] = alias_range_name - body['aliasIpRanges'].append(obj) request = CONN.instances().updateNetworkInterface( instance=instance, networkInterface='nic0', project=project, zone=zone, @@ -153,21 +163,75 @@ wait_for_operation(project, zone, operation) -def get_alias(project, zone, instance): - iface = get_network_ifaces(project, zone, instance) +def add_rm_alias(mode, project, zone, instance, alias, alias_range_name=None): + """Adds or removes an alias IP range for a GCE instance. + + Args: + mode: int, a constant (ADD (0) or REMOVE (1)) indicating the + operation type. + project: string, the project in which the instance resides. + zone: string, the zone in which the instance resides. + instance: string, the name of the instance. + alias: string, the alias IP range to be added to or removed from + the instance. + alias_range_name: string, the subnet name for the alias IP range. + + Returns: + True if the existing list of alias IP ranges was modified, or False + otherwise. + """ + ifaces = get_network_ifaces(project, zone, instance) + fingerprint = ifaces[0]['fingerprint'] + + try: + old_aliases = ifaces[0]['aliasIpRanges'] + except KeyError: + old_aliases = [] + + new_aliases = [a for a in old_aliases if a['ipCidrRange'] != alias] + + if alias: + if mode == ADD: + obj = {'ipCidrRange': alias} + if alias_range_name: + obj['subnetworkRangeName'] = alias_range_name + new_aliases.append(obj) + elif mode == REMOVE: + pass # already removed during new_aliases build + else: + raise ValueError('Invalid value for mode: {}'.format(mode)) + + if (sorted(new_aliases) != sorted(old_aliases)): + set_aliases(project, zone, instance, new_aliases, fingerprint) + return True + else: + return False + + +def add_alias(project, zone, instance, alias, alias_range_name=None): + return add_rm_alias(ADD, project, zone, instance, alias, alias_range_name) + + +def remove_alias(project, zone, instance, alias): + return add_rm_alias(REMOVE, project, zone, instance, alias) + + +def get_aliases(project, zone, instance): + ifaces = get_network_ifaces(project, zone, instance) try: - return iface[0]['aliasIpRanges'][0]['ipCidrRange'] + aliases = ifaces[0]['aliasIpRanges'] + return [a['ipCidrRange'] for a in aliases] except KeyError: - return '' + return [] -def get_localhost_alias(): +def get_localhost_aliases(): net_iface = get_metadata('instance/network-interfaces', {'recursive': True}) - net_iface = json.loads(net_iface.decode('utf-8')) + net_iface = json.loads(net_iface) try: - return net_iface[0]['ipAliases'][0] + return net_iface[0]['ipAliases'] except (KeyError, IndexError): - return '' + return [] def get_zone(project, instance): @@ -201,21 +265,17 @@ def gcp_alias_start(alias): - my_alias = get_localhost_alias() + my_aliases = get_localhost_aliases() my_zone = get_metadata('instance/zone').split('/')[-1] project = get_metadata('project/project-id') - # If I already have the IP, exit. If it has an alias IP that isn't the VIP, - # then remove it - if my_alias == alias: + if alias in my_aliases: + # TODO: Do we need to check alias_range_name? logger.info( '%s already has %s attached. No action required' % (THIS_VM, alias)) sys.exit(OCF_SUCCESS) - elif my_alias: - logger.info('Removing %s from %s' % (my_alias, THIS_VM)) - set_alias(project, my_zone, THIS_VM, '') - # Loops through all hosts & remove the alias IP from the host that has it + # If the alias is currently attached to another host, detach it. hostlist = os.environ.get('OCF_RESKEY_hostlist', '') if hostlist: hostlist = hostlist.replace(THIS_VM, '').split() @@ -223,47 +283,53 @@ hostlist = get_instances_list(project, THIS_VM) for host in hostlist: host_zone = get_zone(project, host) - host_alias = get_alias(project, host_zone, host) - if alias == host_alias: + host_aliases = get_aliases(project, host_zone, host) + if alias in host_aliases: logger.info( - '%s is attached to %s - Removing all alias IP addresses from %s' % - (alias, host, host)) - set_alias(project, host_zone, host, '') + '%s is attached to %s - Removing %s from %s' % + (alias, host, alias, host)) + remove_alias(project, host_zone, host, alias) break - # add alias IP to localhost - set_alias( + # Add alias IP range to localhost + add_alias( project, my_zone, THIS_VM, alias, os.environ.get('OCF_RESKEY_alias_range_name')) - # Check the IP has been added - my_alias = get_localhost_alias() - if alias == my_alias: + # Verify that the IP range has been added + my_aliases = get_localhost_aliases() + if alias in my_aliases: logger.info('Finished adding %s to %s' % (alias, THIS_VM)) - elif my_alias: - logger.error( - 'Failed to add IP. %s has an IP attached but it isn\'t %s' % - (THIS_VM, alias)) - sys.exit(OCF_ERR_GENERIC) else: - logger.error('Failed to add IP address %s to %s' % (alias, THIS_VM)) + if my_aliases: + logger.error( + 'Failed to add alias IP range %s. %s has alias IP ranges attached but' + + ' they don\'t include %s' % (alias, THIS_VM, alias)) + else: + logger.error( + 'Failed to add IP range %s. %s has no alias IP ranges attached' + % (alias, THIS_VM)) sys.exit(OCF_ERR_GENERIC) def gcp_alias_stop(alias): - my_alias = get_localhost_alias() + my_aliases = get_localhost_aliases() my_zone = get_metadata('instance/zone').split('/')[-1] project = get_metadata('project/project-id') - if my_alias == alias: - logger.info('Removing %s from %s' % (my_alias, THIS_VM)) - set_alias(project, my_zone, THIS_VM, '') + if alias in my_aliases: + logger.info('Removing %s from %s' % (alias, THIS_VM)) + remove_alias(project, my_zone, THIS_VM, alias) + else: + logger.info( + '%s is not attached to %s. No action required' + % (alias, THIS_VM)) def gcp_alias_status(alias): - my_alias = get_localhost_alias() - if alias == my_alias: - logger.info('%s has the correct IP address attached' % THIS_VM) + my_aliases = get_localhost_aliases() + if alias in my_aliases: + logger.info('%s has the correct IP range attached' % THIS_VM) else: sys.exit(OCF_NOT_RUNNING) @@ -275,7 +341,8 @@ # Populate global vars try: - CONN = googleapiclient.discovery.build('compute', 'v1') + CONN = googleapiclient.discovery.build('compute', 'v1', + cache_discovery=False) except Exception as e: logger.error('Couldn\'t connect with google api: ' + str(e)) sys.exit(OCF_ERR_CONFIGURED) @@ -283,7 +350,8 @@ try: THIS_VM = get_metadata('instance/name') except Exception as e: - logger.error('Couldn\'t get instance name, is this running inside GCE?: ' + str(e)) + logger.error('Couldn\'t get instance name, is this running inside GCE?: ' + + str(e)) sys.exit(OCF_ERR_CONFIGURED) ALIAS = os.environ.get('OCF_RESKEY_alias_ip') @@ -309,7 +377,8 @@ formatter = logging.Formatter('gcp:alias "%(message)s"') handler.setFormatter(formatter) log.addHandler(handler) - logger = logging.LoggerAdapter(log, {'OCF_RESOURCE_INSTANCE': OCF_RESOURCE_INSTANCE}) + logger = logging.LoggerAdapter(log, {'OCF_RESOURCE_INSTANCE': + OCF_RESOURCE_INSTANCE}) except ImportError: logger.error('Couldn\'t import google.cloud.logging, ' 'disabling Stackdriver-logging support')