2 * Copyright (C) 2014 SDN Hub, LLC.
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
8 * Authors : Srini Seetharaman
11 package org.opendaylight.ovsdb.openstack.netvirt;
13 import java.net.HttpURLConnection;
14 import java.util.List;
17 import org.opendaylight.neutron.spi.INeutronLoadBalancerAware;
18 import org.opendaylight.neutron.spi.INeutronLoadBalancerCRUD;
19 import org.opendaylight.neutron.spi.INeutronLoadBalancerPoolCRUD;
20 import org.opendaylight.neutron.spi.INeutronNetworkCRUD;
21 import org.opendaylight.neutron.spi.INeutronPortCRUD;
22 import org.opendaylight.neutron.spi.INeutronSubnetCRUD;
23 import org.opendaylight.neutron.spi.NeutronLoadBalancer;
24 import org.opendaylight.neutron.spi.NeutronLoadBalancerPool;
25 import org.opendaylight.neutron.spi.NeutronLoadBalancerPoolMember;
26 import org.opendaylight.ovsdb.openstack.netvirt.api.Action;
27 import org.opendaylight.ovsdb.openstack.netvirt.api.EventDispatcher;
28 import org.opendaylight.ovsdb.openstack.netvirt.api.LoadBalancerConfiguration;
29 import org.opendaylight.ovsdb.openstack.netvirt.api.LoadBalancerProvider;
30 import org.opendaylight.ovsdb.openstack.netvirt.api.NodeCacheListener;
31 import org.opendaylight.ovsdb.openstack.netvirt.api.NodeCacheManager;
32 import org.opendaylight.ovsdb.utils.servicehelper.ServiceHelper;
33 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
34 import org.osgi.framework.BundleContext;
35 import org.osgi.framework.ServiceReference;
36 import org.slf4j.Logger;
37 import org.slf4j.LoggerFactory;
39 import com.google.common.base.Preconditions;
42 * Handle requests for OpenStack Neutron v2.0 LBaaS API calls for /v2.0/loadbalancers.
45 //TODO: Implement INeutronLoadBalancerHealthMonitorAware, INeutronLoadBalancerListenerAware, INeutronLoadBalancerPoolMemberAware,
47 public class LBaaSHandler extends AbstractHandler
48 implements INeutronLoadBalancerAware, ConfigInterface, NodeCacheListener {
49 private static final Logger LOG = LoggerFactory.getLogger(LBaaSHandler.class);
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 neutronPortCache;
55 private volatile INeutronNetworkCRUD neutronNetworkCache;
56 private volatile INeutronSubnetCRUD neutronSubnetCache;
57 private volatile LoadBalancerProvider loadBalancerProvider;
58 private volatile NodeCacheManager nodeCacheManager;
61 public int canCreateNeutronLoadBalancer(NeutronLoadBalancer neutronLB) {
62 //Always allowed and not wait for pool and members to be created
63 return HttpURLConnection.HTTP_OK;
67 public void neutronLoadBalancerCreated(NeutronLoadBalancer neutronLB) {
68 LOG.debug("Neutron LB Creation : {}", neutronLB.toString());
69 enqueueEvent(new NorthboundEvent(neutronLB, Action.ADD));
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
77 private void doNeutronLoadBalancerCreate(NeutronLoadBalancer neutronLB) {
78 Preconditions.checkNotNull(loadBalancerProvider);
79 LoadBalancerConfiguration lbConfig = extractLBConfiguration(neutronLB);
80 final List<Node> nodes = nodeCacheManager.getBridgeNodes();
82 if (!lbConfig.isValid()) {
83 LOG.debug("Neutron LB pool configuration invalid for {} ", lbConfig.getName());
84 } else if (nodes.isEmpty()) {
85 LOG.debug("Noop with LB {} creation because no nodes available.", lbConfig.getName());
87 for (Node node : nodes) {
88 loadBalancerProvider.programLoadBalancerRules(node, lbConfig, Action.ADD);
94 public int canUpdateNeutronLoadBalancer(NeutronLoadBalancer delta, NeutronLoadBalancer original) {
95 //Update allowed anytime, even when the LB has no active pool yet
96 return HttpURLConnection.HTTP_OK;
100 public void neutronLoadBalancerUpdated(NeutronLoadBalancer neutronLB) {
101 LOG.debug("Neutron LB Update : {}", neutronLB.toString());
102 enqueueEvent(new NorthboundEvent(neutronLB, Action.UPDATE));
106 public int canDeleteNeutronLoadBalancer(NeutronLoadBalancer neutronLB) {
107 //Always allowed and not wait for pool to stop using it
108 return HttpURLConnection.HTTP_OK;
112 public void neutronLoadBalancerDeleted(NeutronLoadBalancer neutronLB) {
113 LOG.debug("Neutron LB Deletion : {}", neutronLB.toString());
114 enqueueEvent(new NorthboundEvent(neutronLB, Action.DELETE));
117 private void doNeutronLoadBalancerDelete(NeutronLoadBalancer neutronLB) {
118 Preconditions.checkNotNull(loadBalancerProvider);
119 LoadBalancerConfiguration lbConfig = extractLBConfiguration(neutronLB);
120 final List<Node> nodes = nodeCacheManager.getBridgeNodes();
122 if (!lbConfig.isValid()) {
123 LOG.debug("Neutron LB pool configuration invalid for {} ", lbConfig.getName());
124 } else if (nodes.isEmpty()) {
125 LOG.debug("Noop with LB {} deletion because no nodes available.", lbConfig.getName());
127 for (Node node : nodes) {
128 loadBalancerProvider.programLoadBalancerRules(node, lbConfig, Action.DELETE);
136 * @param abstractEvent the {@link org.opendaylight.ovsdb.openstack.netvirt.AbstractEvent} event to be handled.
137 * @see org.opendaylight.ovsdb.openstack.netvirt.api.EventDispatcher
140 public void processEvent(AbstractEvent abstractEvent) {
141 LOG.debug("Processing Loadbalancer event {}", abstractEvent);
142 if (!(abstractEvent instanceof NorthboundEvent)) {
143 LOG.error("Unable to process abstract event {}", abstractEvent);
146 NorthboundEvent ev = (NorthboundEvent) abstractEvent;
147 switch (ev.getAction()) {
149 doNeutronLoadBalancerCreate(ev.getLoadBalancer());
152 doNeutronLoadBalancerDelete(ev.getLoadBalancer());
156 * Currently member update requires delete and re-adding
157 * Also, weights and weight updates are not supported
159 doNeutronLoadBalancerDelete(ev.getLoadBalancer());
160 doNeutronLoadBalancerCreate(ev.getLoadBalancer());
163 LOG.warn("Unable to process event action {}", ev.getAction());
169 * Useful utility for extracting the loadbalancer instance
170 * configuration from the neutron LB cache
172 public LoadBalancerConfiguration extractLBConfiguration(NeutronLoadBalancer neutronLB) {
173 String loadBalancerName = neutronLB.getLoadBalancerName();
174 String loadBalancerVip = neutronLB.getLoadBalancerVipAddress();
175 String loadBalancerSubnetID = neutronLB.getLoadBalancerVipSubnetID();
177 LoadBalancerConfiguration lbConfig = new LoadBalancerConfiguration(loadBalancerName, loadBalancerVip);
178 Map.Entry<String,String> providerInfo =
179 NeutronCacheUtils.getProviderInformation(neutronNetworkCache, neutronSubnetCache, loadBalancerSubnetID);
180 if (providerInfo != null) {
181 lbConfig.setProviderNetworkType(providerInfo.getKey());
182 lbConfig.setProviderSegmentationId(providerInfo.getValue());
184 lbConfig.setVmac(NeutronCacheUtils.getMacAddress(neutronPortCache, loadBalancerSubnetID, loadBalancerVip));
186 for (NeutronLoadBalancerPool neutronLBPool: neutronLBPoolCache.getAllNeutronLoadBalancerPools()) {
187 List<NeutronLoadBalancerPoolMember> members = neutronLBPool.getLoadBalancerPoolMembers();
188 String memberProtocol = neutronLBPool.getLoadBalancerPoolProtocol();
189 if (memberProtocol == null) {
193 if (!(memberProtocol.equalsIgnoreCase(LoadBalancerConfiguration.PROTOCOL_TCP) ||
194 memberProtocol.equalsIgnoreCase(LoadBalancerConfiguration.PROTOCOL_HTTP) ||
195 memberProtocol.equalsIgnoreCase(LoadBalancerConfiguration.PROTOCOL_HTTPS))) {
198 for (NeutronLoadBalancerPoolMember neutronLBPoolMember: members) {
199 Boolean memberAdminStateIsUp = neutronLBPoolMember.getPoolMemberAdminStateIsUp();
200 String memberSubnetID = neutronLBPoolMember.getPoolMemberSubnetID();
201 if (memberSubnetID != null && memberAdminStateIsUp != null &&
202 memberSubnetID.equals(loadBalancerSubnetID) && memberAdminStateIsUp) {
203 String memberID = neutronLBPoolMember.getPoolMemberID();
204 String memberIP = neutronLBPoolMember.getPoolMemberAddress();
205 Integer memberPort = neutronLBPoolMember.getPoolMemberProtoPort();
206 if (memberID == null || memberIP == null || memberPort == null) {
207 LOG.debug("Neutron LB pool member details incomplete: {}", neutronLBPoolMember);
210 String memberMAC = NeutronCacheUtils.getMacAddress(neutronPortCache, memberSubnetID, memberIP);
211 if (memberMAC == null) {
214 lbConfig.addMember(memberID, memberIP, memberMAC, memberProtocol, memberPort);
222 * On the addition of a new node, we iterate through all existing loadbalancer
223 * instances and program the node for all of them. It is sufficient to do that only
224 * when a node is added, and only for the LB instances (and not individual members).
227 public void notifyNode(Node node, Action type) {
228 LOG.debug("notifyNode: Node {} update {} from Controller's inventory Service", node, type);
229 Preconditions.checkNotNull(loadBalancerProvider);
231 for (NeutronLoadBalancer neutronLB: neutronLBCache.getAllNeutronLoadBalancers()) {
232 LoadBalancerConfiguration lbConfig = extractLBConfiguration(neutronLB);
233 if (!lbConfig.isValid()) {
234 LOG.debug("Neutron LB configuration invalid for {} ", lbConfig.getName());
236 if (type.equals(Action.ADD)) {
237 loadBalancerProvider.programLoadBalancerRules(node, lbConfig, Action.ADD);
239 /* When node disappears, we do nothing for now. Making a call to
240 * loadBalancerProvider.programLoadBalancerRules(node, lbConfig, Action.DELETE)
241 * can lead to TransactionCommitFailedException. Similarly when node is changed,
242 * because of remove followed by add, we do nothing.
245 //(type.equals(UpdateType.REMOVED) || type.equals(UpdateType.CHANGED))
252 public void setDependencies(BundleContext bundleContext, ServiceReference serviceReference) {
253 loadBalancerProvider =
254 (LoadBalancerProvider) ServiceHelper.getGlobalInstance(LoadBalancerProvider.class, this);
256 (NodeCacheManager) ServiceHelper.getGlobalInstance(NodeCacheManager.class, this);
257 nodeCacheManager.cacheListenerAdded(
258 bundleContext.getServiceReference(INeutronLoadBalancerAware.class.getName()), this);
260 (EventDispatcher) ServiceHelper.getGlobalInstance(EventDispatcher.class, this);
261 eventDispatcher.eventHandlerAdded(
262 bundleContext.getServiceReference(INeutronLoadBalancerAware.class.getName()), this);
266 public void setDependencies(Object impl) {
267 if (impl instanceof INeutronNetworkCRUD) {
268 neutronNetworkCache = (INeutronNetworkCRUD)impl;
269 } else if (impl instanceof INeutronPortCRUD) {
270 neutronPortCache = (INeutronPortCRUD)impl;
271 } else if (impl instanceof INeutronSubnetCRUD) {
272 neutronSubnetCache = (INeutronSubnetCRUD)impl;
273 } else if (impl instanceof INeutronLoadBalancerCRUD) {
274 neutronLBCache = (INeutronLoadBalancerCRUD)impl;
275 } else if (impl instanceof INeutronLoadBalancerPoolCRUD) {
276 neutronLBPoolCache = (INeutronLoadBalancerPoolCRUD)impl;
277 } else if (impl instanceof LoadBalancerProvider) {
278 loadBalancerProvider = (LoadBalancerProvider)impl;