openstack/net-virt/src/main/java/org/opendaylight/ovsdb/openstack/netvirt/LBaaSPoolMemberHandler.java

   1 /*
   2  * Copyright (C) 2014 SDN Hub, LLC.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  *
   8  * Authors : Srini Seetharaman
   9  */
  10 package org.opendaylight.ovsdb.openstack.netvirt;
  11
  12 import java.net.HttpURLConnection;
  13 import java.util.List;
  14 import java.util.Map;
  15
  16 import org.opendaylight.neutron.spi.INeutronLoadBalancerCRUD;
  17 import org.opendaylight.neutron.spi.INeutronLoadBalancerPoolCRUD;
  18 import org.opendaylight.neutron.spi.INeutronLoadBalancerPoolMemberAware;
  19 import org.opendaylight.neutron.spi.INeutronNetworkCRUD;
  20 import org.opendaylight.neutron.spi.INeutronPortCRUD;
  21 import org.opendaylight.neutron.spi.INeutronSubnetCRUD;
  22 import org.opendaylight.neutron.spi.NeutronLoadBalancer;
  23 import org.opendaylight.neutron.spi.NeutronLoadBalancerPool;
  24 import org.opendaylight.neutron.spi.NeutronLoadBalancerPoolMember;
  25 import org.opendaylight.ovsdb.openstack.netvirt.api.Action;
  26 import org.opendaylight.ovsdb.openstack.netvirt.api.EventDispatcher;
  27 import org.opendaylight.ovsdb.openstack.netvirt.api.LoadBalancerConfiguration;
  28 import org.opendaylight.ovsdb.openstack.netvirt.api.LoadBalancerProvider;
  29 import org.opendaylight.ovsdb.openstack.netvirt.api.NodeCacheManager;
  30 import org.opendaylight.ovsdb.utils.servicehelper.ServiceHelper;
  31 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
  32 import org.osgi.framework.BundleContext;
  33 import org.osgi.framework.ServiceReference;
  34 import org.slf4j.Logger;
  35 import org.slf4j.LoggerFactory;
  36
  37 import com.google.common.base.Preconditions;
  38
  39 /**
  40  * Handle requests for OpenStack Neutron v2.0 LBaaS API calls for
  41  * /v2.0/pools/{pool_id}/members
  42  */
  43
  44 public class LBaaSPoolMemberHandler extends AbstractHandler
  45         implements INeutronLoadBalancerPoolMemberAware, ConfigInterface {
  46     private static final Logger LOG = LoggerFactory.getLogger(LBaaSPoolMemberHandler.class);
  47
  48     // The implementation for each of these services is resolved by the OSGi Service Manager
  49     private volatile INeutronLoadBalancerPoolCRUD neutronLBPoolCache;
  50     private volatile INeutronLoadBalancerCRUD neutronLBCache;
  51     private volatile INeutronPortCRUD neutronPortCache;
  52     private volatile INeutronNetworkCRUD neutronNetworkCache;
  53     private volatile INeutronSubnetCRUD neutronSubnetCache;
  54     private volatile LoadBalancerProvider loadBalancerProvider;
  55     private volatile NodeCacheManager nodeCacheManager;
  56
  57     @Override
  58     public int canCreateNeutronLoadBalancerPoolMember(NeutronLoadBalancerPoolMember neutronLBPoolMember) {
  59         LoadBalancerConfiguration lbConfig = extractLBConfiguration(neutronLBPoolMember);
  60         if (lbConfig == null) {
  61             return HttpURLConnection.HTTP_BAD_REQUEST;
  62         } else if (!lbConfig.isValid()) {
  63             return HttpURLConnection.HTTP_NOT_ACCEPTABLE;
  64         } else {
  65             return HttpURLConnection.HTTP_OK;
  66         }
  67     }
  68
  69     @Override
  70     public void neutronLoadBalancerPoolMemberCreated(NeutronLoadBalancerPoolMember neutronLBPoolMember) {
  71         LOG.debug("Neutron LB Pool Member Creation : {}", neutronLBPoolMember.toString());
  72         enqueueEvent(new NorthboundEvent(neutronLBPoolMember, Action.ADD));
  73     }
  74
  75     /**
  76      * Assuming that the pool information is fully populated before this call is made,
  77      * we go with creating the LoadBalancerConfiguration object for this call with
  78      * all information that is necessary to insert flow_mods
  79      */
  80     private void doNeutronLoadBalancerPoolMemberCreate(NeutronLoadBalancerPoolMember neutronLBPoolMember) {
  81         Preconditions.checkNotNull(loadBalancerProvider);
  82         LoadBalancerConfiguration lbConfig = extractLBConfiguration(neutronLBPoolMember);
  83         final List<Node> nodes =
  84                 nodeCacheManager.getBridgeNodes();
  85         if (lbConfig == null) {
  86             LOG.debug("Neutron LB configuration invalid for member {} ", neutronLBPoolMember.getPoolMemberAddress());
  87         } else if (lbConfig.getVip() == null) {
  88             LOG.debug("Neutron LB VIP not created yet for member {} ", neutronLBPoolMember.getPoolMemberID());
  89         } else if (!lbConfig.isValid()) {
  90             LOG.debug("Neutron LB pool configuration invalid for {} ", lbConfig.getName());
  91         } else if (nodes.isEmpty()) {
  92             LOG.debug("Noop with LB pool member {} creation because no nodes available.", neutronLBPoolMember.getPoolMemberID());
  93         } else {
  94             for (Node node : nodes) {
  95                 loadBalancerProvider.programLoadBalancerPoolMemberRules(node,
  96                         lbConfig,
  97                         lbConfig.getMembers().get(neutronLBPoolMember.getPoolMemberID()), Action.ADD);
  98             }
  99         }
 100     }
 101
 102     @Override
 103     public int canUpdateNeutronLoadBalancerPoolMember(NeutronLoadBalancerPoolMember delta, NeutronLoadBalancerPoolMember original) {
 104         return HttpURLConnection.HTTP_NOT_IMPLEMENTED;
 105     }
 106
 107     @Override
 108     public void neutronLoadBalancerPoolMemberUpdated(NeutronLoadBalancerPoolMember neutronLBPoolMember) {
 109         LOG.debug("Neutron LB Pool Member Update : {}", neutronLBPoolMember.toString());
 110         enqueueEvent(new NorthboundEvent(neutronLBPoolMember, Action.UPDATE));
 111     }
 112
 113     @Override
 114     public int canDeleteNeutronLoadBalancerPoolMember(NeutronLoadBalancerPoolMember neutronLBPoolMember) {
 115         LoadBalancerConfiguration lbConfig = extractLBConfiguration(neutronLBPoolMember);
 116         if (lbConfig == null) {
 117             return HttpURLConnection.HTTP_BAD_REQUEST;
 118         } else if (!lbConfig.isValid()) {
 119             return HttpURLConnection.HTTP_NOT_ACCEPTABLE;
 120         } else {
 121             return HttpURLConnection.HTTP_OK;
 122         }
 123     }
 124
 125     @Override
 126     public void neutronLoadBalancerPoolMemberDeleted(NeutronLoadBalancerPoolMember neutronLBPoolMember) {
 127         LOG.debug("Neutron LB Pool Member Deletion : {}", neutronLBPoolMember.toString());
 128         enqueueEvent(new NorthboundEvent(neutronLBPoolMember, Action.DELETE));
 129     }
 130
 131     private void doNeutronLoadBalancerPoolMemberDelete(NeutronLoadBalancerPoolMember neutronLBPoolMember) {
 132         Preconditions.checkNotNull(loadBalancerProvider);
 133
 134         LoadBalancerConfiguration lbConfig = extractLBConfiguration(neutronLBPoolMember);
 135         final List<Node> nodes = nodeCacheManager.getBridgeNodes();
 136         if (lbConfig == null) {
 137             LOG.debug("Neutron LB configuration invalid for member {} ", neutronLBPoolMember.getPoolMemberAddress());
 138         } else if (lbConfig.getVip() == null) {
 139             LOG.debug("Neutron LB VIP not created yet for member {} ", neutronLBPoolMember.getPoolMemberID());
 140         } else if (!lbConfig.isValid()) {
 141             LOG.debug("Neutron LB pool configuration invalid for {} ", lbConfig.getName());
 142         } else if (nodes.isEmpty()) {
 143             LOG.debug("Noop with LB pool member {} deletion because no nodes available.", neutronLBPoolMember.getPoolMemberID());
 144         } else {
 145             /* As of now, deleting a member involves recomputing member indices.
 146              * This is best done through a complete update of the load balancer instance.
 147              */
 148             LoadBalancerConfiguration newLBConfig = new LoadBalancerConfiguration(lbConfig);
 149             newLBConfig.removeMember(neutronLBPoolMember.getPoolMemberID());
 150
 151             for (Node node : nodes) {
 152                 loadBalancerProvider.programLoadBalancerRules(node, lbConfig, Action.DELETE);
 153                 loadBalancerProvider.programLoadBalancerRules(node, newLBConfig, Action.ADD);
 154             }
 155         }
 156     }
 157
 158     /**
 159      * Process the event.
 160      *
 161      * @param abstractEvent the {@link org.opendaylight.ovsdb.openstack.netvirt.AbstractEvent} event to be handled.
 162      * @see org.opendaylight.ovsdb.openstack.netvirt.api.EventDispatcher
 163      */
 164     @Override
 165     public void processEvent(AbstractEvent abstractEvent) {
 166         LOG.debug("Processing Loadbalancer member event {}", abstractEvent);
 167         if (!(abstractEvent instanceof NorthboundEvent)) {
 168             LOG.error("Unable to process abstract event {}", abstractEvent);
 169             return;
 170         }
 171         NorthboundEvent ev = (NorthboundEvent) abstractEvent;
 172         switch (ev.getAction()) {
 173             case ADD:
 174                 doNeutronLoadBalancerPoolMemberCreate(ev.getLoadBalancerPoolMember());
 175                 break;
 176             case DELETE:
 177                 doNeutronLoadBalancerPoolMemberDelete(ev.getLoadBalancerPoolMember());
 178                 break;
 179             case UPDATE:
 180                 /**
 181                  * Typical upgrade involves changing weights. Since weights are not
 182                  * supported yet, updates are not supported either. TODO
 183                  */
 184                 LOG.warn("Load balancer pool member update is not supported");
 185                 break;
 186             default:
 187                 LOG.warn("Unable to process event action {}", ev.getAction());
 188                 break;
 189         }
 190     }
 191
 192     /**
 193      * Useful utility for extracting the loadbalancer instance
 194      * configuration from the neutron LB cache based on member info
 195      */
 196     public LoadBalancerConfiguration extractLBConfiguration(NeutronLoadBalancerPoolMember neutronLBPoolMember) {
 197         String memberID = neutronLBPoolMember.getPoolMemberID();
 198         String memberIP = neutronLBPoolMember.getPoolMemberAddress();
 199         String memberSubnetID = neutronLBPoolMember.getPoolMemberSubnetID();
 200         Integer memberPort = neutronLBPoolMember.getPoolMemberProtoPort();
 201         String memberPoolID = neutronLBPoolMember.getPoolID();
 202
 203         if (memberSubnetID == null || memberID == null || memberPoolID == null) {
 204             LOG.debug("Neutron LB pool member details incomplete [id={}, pool_id={},subnet_id={}",
 205                     memberID, memberPoolID, memberSubnetID);
 206             return null;
 207         }
 208         String memberMAC = NeutronCacheUtils.getMacAddress(neutronPortCache, memberSubnetID, memberIP);
 209         if (memberMAC == null) {
 210             LOG.debug("Neutron LB pool member {} MAC address unavailable", memberID);
 211             return null;
 212         }
 213         NeutronLoadBalancerPool neutronLBPool = neutronLBPoolCache.getNeutronLoadBalancerPool(memberPoolID);
 214         String memberProtocol = neutronLBPool.getLoadBalancerPoolProtocol();
 215         if (!(memberProtocol.equalsIgnoreCase(LoadBalancerConfiguration.PROTOCOL_TCP) ||
 216                 memberProtocol.equalsIgnoreCase(LoadBalancerConfiguration.PROTOCOL_HTTP) ||
 217                 memberProtocol.equalsIgnoreCase(LoadBalancerConfiguration.PROTOCOL_HTTPS))) {
 218             return null;
 219         }
 220
 221         String loadBalancerSubnetID=null, loadBalancerVip=null, loadBalancerName=null;
 222         for (NeutronLoadBalancer neutronLB: neutronLBCache.getAllNeutronLoadBalancers()) {
 223             loadBalancerSubnetID = neutronLB.getLoadBalancerVipSubnetID();
 224             if (memberSubnetID.equals(loadBalancerSubnetID)) {
 225                 loadBalancerName = neutronLB.getLoadBalancerName();
 226                 loadBalancerVip = neutronLB.getLoadBalancerVipAddress();
 227                 break;
 228             }
 229         }
 230
 231         /**
 232          * It is possible that the VIP has not been created yet.
 233          * In that case, we create dummy configuration that will not program rules.
 234          */
 235         LoadBalancerConfiguration lbConfig = new LoadBalancerConfiguration(loadBalancerName, loadBalancerVip);
 236         Map.Entry<String,String> providerInfo = NeutronCacheUtils.getProviderInformation(neutronNetworkCache, neutronSubnetCache, memberSubnetID);
 237         if (providerInfo != null) {
 238             lbConfig.setProviderNetworkType(providerInfo.getKey());
 239             lbConfig.setProviderSegmentationId(providerInfo.getValue());
 240         }
 241         lbConfig.setVmac(NeutronCacheUtils.getMacAddress(neutronPortCache, loadBalancerSubnetID, loadBalancerVip));
 242
 243         /* Extract all other active members and include in LB config
 244          */
 245         String otherMemberID, otherMemberSubnetID, otherMemberIP, otherMemberMAC, otherMemberProtocol;
 246         Boolean otherMemberAdminStateIsUp;
 247         Integer otherMemberPort;
 248
 249         for (NeutronLoadBalancerPoolMember otherMember: neutronLBPool.getLoadBalancerPoolMembers()) {
 250             otherMemberID = otherMember.getPoolMemberID();
 251             if (otherMemberID.equals(memberID)) {
 252                 continue; //skip
 253             }
 254
 255             otherMemberIP = otherMember.getPoolMemberAddress();
 256             otherMemberAdminStateIsUp = otherMember.getPoolMemberAdminStateIsUp();
 257             otherMemberSubnetID = otherMember.getPoolMemberSubnetID();
 258             otherMemberPort = otherMember.getPoolMemberProtoPort();
 259             otherMemberProtocol = memberProtocol;
 260
 261             if (otherMemberIP != null && otherMemberSubnetID != null && otherMemberAdminStateIsUp != null &&
 262                     otherMemberAdminStateIsUp) {
 263                 otherMemberMAC = NeutronCacheUtils.getMacAddress(neutronPortCache, otherMemberSubnetID, otherMemberIP);
 264                 if (otherMemberMAC == null) {
 265                     continue;
 266                 }
 267                 lbConfig.addMember(otherMemberID, otherMemberIP, otherMemberMAC, otherMemberProtocol, otherMemberPort);
 268             }
 269         }
 270
 271         lbConfig.addMember(memberID, memberIP, memberMAC, memberProtocol, memberPort);
 272         return lbConfig;
 273     }
 274
 275     @Override
 276     public void setDependencies(BundleContext bundleContext, ServiceReference serviceReference) {
 277         loadBalancerProvider =
 278                 (LoadBalancerProvider) ServiceHelper.getGlobalInstance(LoadBalancerProvider.class, this);
 279         nodeCacheManager =
 280                 (NodeCacheManager) ServiceHelper.getGlobalInstance(NodeCacheManager.class, this);
 281         eventDispatcher =
 282                 (EventDispatcher) ServiceHelper.getGlobalInstance(EventDispatcher.class, this);
 283         eventDispatcher.eventHandlerAdded(
 284                 bundleContext.getServiceReference(INeutronLoadBalancerPoolMemberAware.class.getName()), this);
 285     }
 286
 287     @Override
 288     public void setDependencies(Object impl) {
 289         if (impl instanceof INeutronNetworkCRUD) {
 290             neutronNetworkCache = (INeutronNetworkCRUD)impl;
 291         } else if (impl instanceof INeutronPortCRUD) {
 292             neutronPortCache = (INeutronPortCRUD)impl;
 293         } else if (impl instanceof INeutronSubnetCRUD) {
 294             neutronSubnetCache = (INeutronSubnetCRUD)impl;
 295         } else if (impl instanceof INeutronLoadBalancerCRUD) {
 296             neutronLBCache = (INeutronLoadBalancerCRUD)impl;
 297         } else if (impl instanceof INeutronLoadBalancerPoolCRUD) {
 298             neutronLBPoolCache = (INeutronLoadBalancerPoolCRUD)impl;
 299         } else if (impl instanceof LoadBalancerProvider) {
 300             loadBalancerProvider = (LoadBalancerProvider)impl;
 301         }
 302     }
 303 }