openstack/net-virt/src/main/java/org/opendaylight/ovsdb/openstack/netvirt/LBaaSPoolMemberHandler.java

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