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