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