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