openstack/net-virt/src/main/java/org/opendaylight/ovsdb/openstack/netvirt/LBaaSPoolHandler.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
  11 package org.opendaylight.ovsdb.openstack.netvirt;
  12
  13 import java.net.HttpURLConnection;
  14 import java.util.List;
  15 import java.util.Map;
  16
  17 import org.opendaylight.neutron.spi.INeutronLoadBalancerCRUD;
  18 import org.opendaylight.neutron.spi.INeutronLoadBalancerPoolAware;
  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 import com.google.common.collect.Lists;
  39
  40 /**
  41  * Handle requests for OpenStack Neutron v2.0 LBaaS API calls for
  42  * /v2.0/pools . It is possible that each pool spans multiple subnets.
  43  * In that case, the user should be creating a separate VIP for each subnet.
  44  */
  45
  46 public class LBaaSPoolHandler extends AbstractHandler
  47         implements INeutronLoadBalancerPoolAware, ConfigInterface {
  48
  49     private static final Logger logger = LoggerFactory.getLogger(LBaaSPoolHandler.class);
  50
  51     // The implementation for each of these services is resolved by the OSGi Service Manager
  52     private volatile INeutronLoadBalancerCRUD neutronLBCache;
  53     private volatile INeutronPortCRUD neutronPortCache;
  54     private volatile INeutronNetworkCRUD neutronNetworkCache;
  55     private volatile INeutronSubnetCRUD neutronSubnetCache;
  56     private volatile LoadBalancerProvider loadBalancerProvider;
  57     private volatile NodeCacheManager nodeCacheManager;
  58
  59     @Override
  60     public int canCreateNeutronLoadBalancerPool(NeutronLoadBalancerPool neutronLBPool) {
  61         String poolProtocol = neutronLBPool.getLoadBalancerPoolProtocol();
  62         if (poolProtocol == null) {
  63             return HttpURLConnection.HTTP_BAD_REQUEST;
  64         } else if (!(poolProtocol.equalsIgnoreCase(LoadBalancerConfiguration.PROTOCOL_TCP) ||
  65                 poolProtocol.equalsIgnoreCase(LoadBalancerConfiguration.PROTOCOL_HTTP) ||
  66                 poolProtocol.equalsIgnoreCase(LoadBalancerConfiguration.PROTOCOL_HTTPS))) {
  67             return HttpURLConnection.HTTP_NOT_ACCEPTABLE;
  68         } else {
  69             return HttpURLConnection.HTTP_OK;
  70         }
  71     }
  72
  73     @Override
  74     public void neutronLoadBalancerPoolCreated(NeutronLoadBalancerPool neutronLBPool) {
  75         logger.debug("Neutron LB Pool Creation : {}", neutronLBPool.toString());
  76         enqueueEvent(new NorthboundEvent(neutronLBPool, Action.ADD));
  77     }
  78
  79     /**
  80      * Assuming that the pool information is fully populated before this call is made,
  81      * we go with creating the LoadBalancerConfiguration object for this call with
  82      * all information that is necessary to insert flow_mods
  83      */
  84     private void doNeutronLoadBalancerPoolCreate(NeutronLoadBalancerPool neutronLBPool) {
  85         Preconditions.checkNotNull(loadBalancerProvider);
  86         List<LoadBalancerConfiguration> lbConfigList = extractLBConfiguration(neutronLBPool);
  87         final List<Node> nodes = nodeCacheManager.getBridgeNodes();
  88         if (lbConfigList == null) {
  89             logger.debug("Neutron LB configuration invalid for pool {} ", neutronLBPool.getLoadBalancerPoolID());
  90         } else if (lbConfigList.size() == 0) {
  91             logger.debug("No Neutron LB VIP not created yet for pool {} ", neutronLBPool.getLoadBalancerPoolID());
  92         } else if (nodes.isEmpty()) {
  93             logger.debug("Noop with LB pool {} creation because no nodes available.", neutronLBPool.getLoadBalancerPoolID());
  94         } else {
  95             for (LoadBalancerConfiguration lbConfig: lbConfigList) {
  96                 if (!lbConfig.isValid()) {
  97                     logger.debug("Neutron LB pool configuration invalid for {} ", lbConfig.getName());
  98                     continue;
  99                 } else {
 100                     for (Node node : nodes) {
 101                         loadBalancerProvider.programLoadBalancerRules(node, lbConfig, Action.ADD);
 102                     }
 103                 }
 104             }
 105         }
 106     }
 107
 108     @Override
 109     public int canUpdateNeutronLoadBalancerPool(NeutronLoadBalancerPool delta, NeutronLoadBalancerPool original) {
 110         return HttpURLConnection.HTTP_NOT_IMPLEMENTED;
 111     }
 112
 113     @Override
 114     public void neutronLoadBalancerPoolUpdated(NeutronLoadBalancerPool neutronLBPool) {
 115         logger.debug("Neutron LB Pool Update : {}", neutronLBPool.toString());
 116         enqueueEvent(new NorthboundEvent(neutronLBPool, Action.UPDATE));
 117     }
 118
 119     @Override
 120     public int canDeleteNeutronLoadBalancerPool(NeutronLoadBalancerPool neutronLBPool) {
 121         String poolProtocol = neutronLBPool.getLoadBalancerPoolProtocol();
 122         if (poolProtocol == null) {
 123             return HttpURLConnection.HTTP_BAD_REQUEST;
 124         } else if (!(poolProtocol.equalsIgnoreCase(LoadBalancerConfiguration.PROTOCOL_TCP) ||
 125                 poolProtocol.equalsIgnoreCase(LoadBalancerConfiguration.PROTOCOL_HTTP) ||
 126                 poolProtocol.equalsIgnoreCase(LoadBalancerConfiguration.PROTOCOL_HTTPS))) {
 127             return HttpURLConnection.HTTP_NOT_ACCEPTABLE;
 128         } else {
 129             return HttpURLConnection.HTTP_OK;
 130         }
 131     }
 132
 133     @Override
 134     public void neutronLoadBalancerPoolDeleted(NeutronLoadBalancerPool neutronLBPool) {
 135         logger.debug("Neutron LB Pool Deletion : {}", neutronLBPool.toString());
 136         enqueueEvent(new NorthboundEvent(neutronLBPool, Action.DELETE));
 137     }
 138
 139     private void doNeutronLoadBalancerPoolDelete(NeutronLoadBalancerPool neutronLBPool) {
 140         Preconditions.checkNotNull(loadBalancerProvider);
 141
 142         List<LoadBalancerConfiguration> lbConfigList = extractLBConfiguration(neutronLBPool);
 143         final List<Node> nodes = nodeCacheManager.getBridgeNodes();
 144         if (lbConfigList == null) {
 145             logger.debug("Neutron LB configuration invalid for pool {} ", neutronLBPool.getLoadBalancerPoolID());
 146         } else if (lbConfigList.size() == 0) {
 147             logger.debug("No Neutron LB VIP not created yet for pool {} ", neutronLBPool.getLoadBalancerPoolID());
 148         } else if (nodes.isEmpty()) {
 149             logger.debug("Noop with LB pool {} deletion because no nodes available.", neutronLBPool.getLoadBalancerPoolID());
 150         } else {
 151             for (LoadBalancerConfiguration lbConfig: lbConfigList) {
 152                 if (!lbConfig.isValid()) {
 153                     logger.debug("Neutron LB pool configuration invalid for {} ", lbConfig.getName());
 154                     continue;
 155                 } else {
 156                     for (Node node : nodes) {
 157                         loadBalancerProvider.programLoadBalancerRules(node, lbConfig, Action.DELETE);
 158                     }
 159                 }
 160             }
 161         }
 162     }
 163
 164     /**
 165      * Process the event.
 166      *
 167      * @param abstractEvent the {@link org.opendaylight.ovsdb.openstack.netvirt.AbstractEvent} event to be handled.
 168      * @see org.opendaylight.ovsdb.openstack.netvirt.api.EventDispatcher
 169      */
 170     @Override
 171     public void processEvent(AbstractEvent abstractEvent) {
 172         logger.debug("Processing Loadbalancer Pool event " + abstractEvent);
 173         if (!(abstractEvent instanceof NorthboundEvent)) {
 174             logger.error("Unable to process abstract event " + abstractEvent);
 175             return;
 176         }
 177         NorthboundEvent ev = (NorthboundEvent) abstractEvent;
 178         switch (ev.getAction()) {
 179             case ADD:
 180                 doNeutronLoadBalancerPoolCreate(ev.getLoadBalancerPool());
 181                 break;
 182             case DELETE:
 183                 doNeutronLoadBalancerPoolDelete(ev.getLoadBalancerPool());
 184                 break;
 185             case UPDATE:
 186                 /**
 187                  * Typical upgrade involves changing algorithm. Right now
 188                  * we do not support this flexibility. TODO
 189                  */
 190                 logger.warn("Load balancer pool update is not supported");
 191                 break;
 192             default:
 193                 logger.warn("Unable to process event action " + ev.getAction());
 194                 break;
 195         }
 196     }
 197
 198     /**
 199      * Useful utility for extracting the loadbalancer instance. With
 200      * each LB pool, we allow multiple VIP and LB to be instantiated.
 201      */
 202     public List<LoadBalancerConfiguration> extractLBConfiguration(NeutronLoadBalancerPool neutronLBPool) {
 203         String poolProtocol = neutronLBPool.getLoadBalancerPoolProtocol();
 204         if (poolProtocol == null) {
 205             return null;
 206         }
 207         if (!(poolProtocol.equalsIgnoreCase(LoadBalancerConfiguration.PROTOCOL_HTTP) ||
 208                 poolProtocol.equalsIgnoreCase(LoadBalancerConfiguration.PROTOCOL_HTTPS))) {
 209             return null;
 210         }
 211
 212         List<NeutronLoadBalancerPoolMember> poolMembers = neutronLBPool.getLoadBalancerPoolMembers();
 213         if (poolMembers.size() == 0) {
 214             logger.debug("Neutron LB pool is empty: {}", neutronLBPool);
 215             return null;
 216         }
 217
 218         List<LoadBalancerConfiguration> lbConfigList = Lists.newLinkedList();
 219
 220         /* Iterate over all the Loadbalancers created so far and identify VIP
 221          */
 222         String loadBalancerSubnetID, loadBalancerVip=null, loadBalancerName=null;
 223         for (NeutronLoadBalancer neutronLB: neutronLBCache.getAllNeutronLoadBalancers()) {
 224             loadBalancerSubnetID = neutronLB.getLoadBalancerVipSubnetID();
 225             loadBalancerName = neutronLB.getLoadBalancerName();
 226             loadBalancerVip = neutronLB.getLoadBalancerVipAddress();
 227
 228             LoadBalancerConfiguration lbConfig = new LoadBalancerConfiguration(loadBalancerName, loadBalancerVip);
 229             Map.Entry<String,String> providerInfo = NeutronCacheUtils.getProviderInformation(neutronNetworkCache, neutronSubnetCache, loadBalancerSubnetID);
 230             if (providerInfo != null) {
 231                 lbConfig.setProviderNetworkType(providerInfo.getKey());
 232                 lbConfig.setProviderSegmentationId(providerInfo.getValue());
 233             }
 234             lbConfig.setVmac(NeutronCacheUtils.getMacAddress(neutronPortCache, loadBalancerSubnetID, loadBalancerVip));
 235
 236             /* Iterate over all the members in this pool and find those in same
 237              * subnet as the VIP. Those will be included in the lbConfigList
 238              */
 239             String memberSubnetID, memberIP, memberID, memberMAC;
 240             Integer memberPort;
 241             Boolean memberAdminStateIsUp;
 242             for (NeutronLoadBalancerPoolMember neutronLBPoolMember: neutronLBPool.getLoadBalancerPoolMembers()) {
 243                 memberAdminStateIsUp = neutronLBPoolMember.getPoolMemberAdminStateIsUp();
 244                 memberSubnetID = neutronLBPoolMember.getPoolMemberSubnetID();
 245                 if (memberSubnetID == null || memberAdminStateIsUp == null) {
 246                     continue;
 247                 } else if (memberSubnetID.equals(loadBalancerSubnetID) && memberAdminStateIsUp.booleanValue()) {
 248                     memberID = neutronLBPoolMember.getPoolMemberID();
 249                     memberIP = neutronLBPoolMember.getPoolMemberAddress();
 250                     memberPort = neutronLBPoolMember.getPoolMemberProtoPort();
 251                     if (memberSubnetID == null || memberID == null || memberIP == null || memberPort == null) {
 252                         logger.debug("Neutron LB pool member details incomplete: {}", neutronLBPoolMember);
 253                         continue;
 254                     }
 255                     memberMAC = NeutronCacheUtils.getMacAddress(neutronPortCache, memberSubnetID, memberIP);
 256                     if (memberMAC == null) {
 257                         continue;
 258                     }
 259                     lbConfig.addMember(memberID, memberIP, memberMAC, poolProtocol, memberPort);
 260                 }
 261             }
 262
 263             if (lbConfig.getMembers().size() > 0) {
 264                 lbConfigList.add(lbConfig);
 265             }
 266         }
 267
 268         return lbConfigList;
 269     }
 270
 271     @Override
 272     public void setDependencies(BundleContext bundleContext, ServiceReference serviceReference) {
 273         loadBalancerProvider =
 274                 (LoadBalancerProvider) ServiceHelper.getGlobalInstance(LoadBalancerProvider.class, this);
 275         nodeCacheManager =
 276                 (NodeCacheManager) ServiceHelper.getGlobalInstance(NodeCacheManager.class, this);
 277         eventDispatcher =
 278                 (EventDispatcher) ServiceHelper.getGlobalInstance(EventDispatcher.class, this);
 279         eventDispatcher.eventHandlerAdded(
 280                 bundleContext.getServiceReference(INeutronLoadBalancerPoolAware.class.getName()), this);
 281     }
 282
 283     @Override
 284     public void setDependencies(Object impl) {
 285         if (impl instanceof INeutronNetworkCRUD) {
 286             neutronNetworkCache = (INeutronNetworkCRUD)impl;
 287         } else if (impl instanceof INeutronPortCRUD) {
 288             neutronPortCache = (INeutronPortCRUD)impl;
 289         } else if (impl instanceof INeutronSubnetCRUD) {
 290             neutronSubnetCache = (INeutronSubnetCRUD)impl;
 291         } else if (impl instanceof INeutronLoadBalancerCRUD) {
 292             neutronLBCache = (INeutronLoadBalancerCRUD)impl;
 293         } else if (impl instanceof LoadBalancerProvider) {
 294             loadBalancerProvider = (LoadBalancerProvider)impl;
 295         }
 296     }
 297 }