openstack/net-virt/src/main/java/org/opendaylight/ovsdb/openstack/netvirt/LBaaSHandler.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.controller.networkconfig.neutron.INeutronLoadBalancerAware;
  14 import org.opendaylight.controller.networkconfig.neutron.INeutronLoadBalancerCRUD;
  15 import org.opendaylight.controller.networkconfig.neutron.INeutronLoadBalancerPoolCRUD;
  16 import org.opendaylight.controller.networkconfig.neutron.INeutronNetworkCRUD;
  17 import org.opendaylight.controller.networkconfig.neutron.INeutronPortCRUD;
  18 import org.opendaylight.controller.networkconfig.neutron.INeutronSubnetCRUD;
  19 import org.opendaylight.controller.networkconfig.neutron.NeutronLoadBalancer;
  20 import org.opendaylight.controller.networkconfig.neutron.NeutronLoadBalancerPool;
  21 import org.opendaylight.controller.networkconfig.neutron.NeutronLoadBalancerPoolMember;
  22 import org.opendaylight.controller.sal.core.Node;
  23 import org.opendaylight.controller.sal.core.NodeConnector;
  24 import org.opendaylight.controller.sal.core.Property;
  25 import org.opendaylight.controller.sal.core.UpdateType;
  26 import org.opendaylight.controller.switchmanager.IInventoryListener;
  27 import org.opendaylight.controller.switchmanager.ISwitchManager;
  28 import org.opendaylight.ovsdb.openstack.netvirt.api.Action;
  29 import org.opendaylight.ovsdb.openstack.netvirt.api.LoadBalancerConfiguration;
  30 import org.opendaylight.ovsdb.openstack.netvirt.api.LoadBalancerProvider;
  31 import org.slf4j.Logger;
  32 import org.slf4j.LoggerFactory;
  33
  34 import com.google.common.base.Preconditions;
  35
  36 import java.net.HttpURLConnection;
  37 import java.util.List;
  38 import java.util.Map;
  39
  40 /**
  41  * Handle requests for OpenStack Neutron v2.0 LBaaS API calls for /v2.0/loadbalancers.
  42  */
  43
  44 //TODO: Implement INeutronLoadBalancerHealthMonitorAware, INeutronLoadBalancerListenerAware, INeutronLoadBalancerPoolMemberAware,
  45
  46 public class LBaaSHandler extends AbstractHandler
  47         implements INeutronLoadBalancerAware, IInventoryListener {
  48
  49     private static final Logger logger = LoggerFactory.getLogger(LBaaSHandler.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 INeutronLoadBalancerPoolCRUD neutronLBPoolCache;
  54     private volatile INeutronPortCRUD neutronPortsCache;
  55     private volatile INeutronNetworkCRUD neutronNetworkCache;
  56     private volatile INeutronSubnetCRUD neutronSubnetCache;
  57     private volatile LoadBalancerProvider loadBalancerProvider;
  58     private volatile ISwitchManager switchManager;
  59
  60     @Override
  61     public int canCreateNeutronLoadBalancer(NeutronLoadBalancer neutronLB) {
  62         //Always allowed and not wait for pool and members to be created
  63         return HttpURLConnection.HTTP_OK;
  64     }
  65
  66     @Override
  67     public void neutronLoadBalancerCreated(NeutronLoadBalancer neutronLB) {
  68         logger.debug("Neutron LB Creation : {}", neutronLB.toString());
  69         enqueueEvent(new NorthboundEvent(neutronLB, 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 doNeutronLoadBalancerCreate(NeutronLoadBalancer neutronLB) {
  78         Preconditions.checkNotNull(loadBalancerProvider);
  79         LoadBalancerConfiguration lbConfig = extractLBConfiguration(neutronLB);
  80
  81         if (!lbConfig.isValid()) {
  82             logger.debug("Neutron LB pool configuration invalid for {} ", lbConfig.getName());
  83         } else if (this.switchManager.getNodes().size() == 0) {
  84             logger.debug("Noop with LB {} creation because no nodes available.", lbConfig.getName());
  85         } else {
  86             for (Node node: this.switchManager.getNodes())
  87                 loadBalancerProvider.programLoadBalancerRules(node, lbConfig, Action.ADD);
  88         }
  89     }
  90
  91     @Override
  92     public int canUpdateNeutronLoadBalancer(NeutronLoadBalancer delta, NeutronLoadBalancer original) {
  93         //Update allowed anytime, even when the LB has no active pool yet
  94         return HttpURLConnection.HTTP_OK;
  95     }
  96
  97     @Override
  98     public void neutronLoadBalancerUpdated(NeutronLoadBalancer neutronLB) {
  99         logger.debug("Neutron LB Update : {}", neutronLB.toString());
 100         enqueueEvent(new NorthboundEvent(neutronLB, Action.UPDATE));
 101     }
 102
 103     @Override
 104     public int canDeleteNeutronLoadBalancer(NeutronLoadBalancer neutronLB) {
 105         //Always allowed and not wait for pool to stop using it
 106         return HttpURLConnection.HTTP_OK;
 107     }
 108
 109     @Override
 110     public void neutronLoadBalancerDeleted(NeutronLoadBalancer neutronLB) {
 111         logger.debug("Neutron LB Deletion : {}", neutronLB.toString());
 112         enqueueEvent(new NorthboundEvent(neutronLB, Action.DELETE));
 113     }
 114
 115     private void doNeutronLoadBalancerDelete(NeutronLoadBalancer neutronLB) {
 116         Preconditions.checkNotNull(loadBalancerProvider);
 117         LoadBalancerConfiguration lbConfig = extractLBConfiguration(neutronLB);
 118
 119         if (!lbConfig.isValid()) {
 120             logger.debug("Neutron LB pool configuration invalid for {} ", lbConfig.getName());
 121         } else if (this.switchManager.getNodes().size() == 0) {
 122             logger.debug("Noop with LB {} deletion because no nodes available.", lbConfig.getName());
 123         } else {
 124             for (Node node: this.switchManager.getNodes())
 125                 loadBalancerProvider.programLoadBalancerRules(node, lbConfig, Action.DELETE);
 126         }
 127     }
 128
 129     /**
 130      * Process the event.
 131      *
 132      * @param abstractEvent the {@link org.opendaylight.ovsdb.openstack.netvirt.AbstractEvent} event to be handled.
 133      * @see org.opendaylight.ovsdb.openstack.netvirt.api.EventDispatcher
 134      */
 135     @Override
 136     public void processEvent(AbstractEvent abstractEvent) {
 137         logger.debug("Processing Loadbalancer event " + abstractEvent);
 138         if (!(abstractEvent instanceof NorthboundEvent)) {
 139             logger.error("Unable to process abstract event " + abstractEvent);
 140             return;
 141         }
 142         NorthboundEvent ev = (NorthboundEvent) abstractEvent;
 143         switch (ev.getAction()) {
 144             case ADD:
 145                 doNeutronLoadBalancerCreate(ev.getLoadBalancer());
 146                 break;
 147             case DELETE:
 148                 doNeutronLoadBalancerDelete(ev.getLoadBalancer());
 149                 break;
 150             case UPDATE:
 151                 /**
 152                  * Currently member update requires delete and re-adding
 153                  * Also, weights and weight updates are not supported
 154                  */
 155                 doNeutronLoadBalancerDelete(ev.getLoadBalancer());
 156                 doNeutronLoadBalancerCreate(ev.getLoadBalancer());
 157                 break;
 158             default:
 159                 logger.warn("Unable to process event action " + ev.getAction());
 160                 break;
 161         }
 162     }
 163
 164     /**
 165      * Useful utility for extracting the loadbalancer instance
 166      * configuration from the neutron LB cache
 167      */
 168     public LoadBalancerConfiguration extractLBConfiguration(NeutronLoadBalancer neutronLB) {
 169         String loadBalancerName = neutronLB.getLoadBalancerName();
 170         String loadBalancerVip = neutronLB.getLoadBalancerVipAddress();
 171         String loadBalancerSubnetID = neutronLB.getLoadBalancerVipSubnetID();
 172
 173         LoadBalancerConfiguration lbConfig = new LoadBalancerConfiguration(loadBalancerName, loadBalancerVip);
 174         Map.Entry<String,String> providerInfo = NeutronCacheUtils.getProviderInformation(neutronNetworkCache, neutronSubnetCache, loadBalancerSubnetID);
 175         if (providerInfo != null) {
 176             lbConfig.setProviderNetworkType(providerInfo.getKey());
 177             lbConfig.setProviderSegmentationId(providerInfo.getValue());
 178         }
 179         lbConfig.setVmac(NeutronCacheUtils.getMacAddress(neutronPortsCache, loadBalancerVip));
 180
 181         String memberID, memberIP, memberMAC, memberProtocol, memberSubnetID;
 182         Integer memberPort;
 183         Boolean memberAdminStateIsUp;
 184
 185         for (NeutronLoadBalancerPool neutronLBPool: neutronLBPoolCache.getAllNeutronLoadBalancerPools()) {
 186             List<NeutronLoadBalancerPoolMember> members = neutronLBPool.getLoadBalancerPoolMembers();
 187             memberProtocol = neutronLBPool.getLoadBalancerPoolProtocol();
 188             if (memberProtocol == null)
 189                 continue;
 190
 191             if (!(memberProtocol.equalsIgnoreCase(LoadBalancerConfiguration.PROTOCOL_TCP) ||
 192                   memberProtocol.equalsIgnoreCase(LoadBalancerConfiguration.PROTOCOL_HTTP) ||
 193                   memberProtocol.equalsIgnoreCase(LoadBalancerConfiguration.PROTOCOL_HTTPS)))
 194                 continue;
 195             for (NeutronLoadBalancerPoolMember neutronLBPoolMember: members) {
 196                 memberAdminStateIsUp = neutronLBPoolMember.getPoolMemberAdminStateIsUp();
 197                 memberSubnetID = neutronLBPoolMember.getPoolMemberSubnetID();
 198                 if (memberSubnetID == null || memberAdminStateIsUp == null)
 199                     continue;
 200                 else if (memberSubnetID.equals(loadBalancerSubnetID) && memberAdminStateIsUp.booleanValue()) {
 201                     memberID = neutronLBPoolMember.getPoolMemberID();
 202                     memberIP = neutronLBPoolMember.getPoolMemberAddress();
 203                     memberPort = neutronLBPoolMember.getPoolMemberProtoPort();
 204                     if (memberSubnetID == null || memberID == null || memberIP == null || memberPort == null) {
 205                         logger.debug("Neutron LB pool member details incomplete: {}", neutronLBPoolMember);
 206                         continue;
 207                     }
 208                     memberMAC = NeutronCacheUtils.getMacAddress(neutronPortsCache, memberIP);
 209                     if (memberMAC == null)
 210                         continue;
 211                     lbConfig.addMember(memberID, memberIP, memberMAC, memberProtocol, memberPort);
 212                 }
 213             }
 214         }
 215         return lbConfig;
 216     }
 217
 218     /**
 219      * On the addition of a new node, we iterate through all existing loadbalancer
 220      * instances and program the node for all of them. It is sufficient to do that only
 221      * when a node is added, and only for the LB instances (and not individual members).
 222      */
 223     @Override
 224     public void notifyNode(Node node, UpdateType type, Map<String, Property> propMap) {
 225         logger.debug("notifyNode: Node {} update {} from Controller's inventory Service", node, type);
 226         Preconditions.checkNotNull(loadBalancerProvider);
 227
 228         for (NeutronLoadBalancer neutronLB: neutronLBCache.getAllNeutronLoadBalancers()) {
 229             LoadBalancerConfiguration lbConfig = extractLBConfiguration(neutronLB);
 230             if (!lbConfig.isValid())
 231                 logger.debug("Neutron LB configuration invalid for {} ", lbConfig.getName());
 232             else {
 233                if (type.equals(UpdateType.ADDED))
 234                     loadBalancerProvider.programLoadBalancerRules(node, lbConfig, Action.ADD);
 235
 236                /* When node disappears, we do nothing for now. Making a call to
 237                 * loadBalancerProvider.programLoadBalancerRules(node, lbConfig, Action.DELETE)
 238                 * can lead to TransactionCommitFailedException. Similarly when node is changed,
 239                 * because of remove followed by add, we do nothing.
 240                 */
 241                else //(type.equals(UpdateType.REMOVED) || type.equals(UpdateType.CHANGED))
 242                     continue;
 243             }
 244         }
 245     }
 246
 247     @Override
 248     public void notifyNodeConnector(NodeConnector arg0, UpdateType arg1,
 249             Map<String, Property> arg2) {
 250         //NOOP
 251     }
 252 }