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