2 * Copyright (c) 2014, 2015 SDN Hub, LLC. and others. All rights reserved.
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
9 package org.opendaylight.ovsdb.openstack.netvirt;
11 import java.net.HttpURLConnection;
12 import java.util.List;
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.INeutronLoadBalancerAware;
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.NodeCacheListener;
29 import org.opendaylight.ovsdb.openstack.netvirt.api.NodeCacheManager;
30 import org.opendaylight.ovsdb.utils.servicehelper.ServiceHelper;
31 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
33 import org.osgi.framework.ServiceReference;
34 import org.slf4j.Logger;
35 import org.slf4j.LoggerFactory;
37 import com.google.common.base.Preconditions;
40 * Handle requests for OpenStack Neutron v2.0 LBaaS API calls for /v2.0/loadbalancers.
43 //TODO: Implement INeutronLoadBalancerHealthMonitorAware, INeutronLoadBalancerListenerAware, INeutronLoadBalancerPoolMemberAware,
45 public class LBaaSHandler extends AbstractHandler
46 implements INeutronLoadBalancerAware, ConfigInterface, NodeCacheListener {
47 private static final Logger LOG = LoggerFactory.getLogger(LBaaSHandler.class);
49 // The implementation for each of these services is resolved by the OSGi Service Manager
50 private volatile INeutronLoadBalancerCRUD neutronLBCache;
51 private volatile INeutronLoadBalancerPoolCRUD neutronLBPoolCache;
52 private volatile INeutronPortCRUD neutronPortCache;
53 private volatile INeutronNetworkCRUD neutronNetworkCache;
54 private volatile INeutronSubnetCRUD neutronSubnetCache;
55 private volatile LoadBalancerProvider loadBalancerProvider;
56 private volatile NodeCacheManager nodeCacheManager;
59 public int canCreateNeutronLoadBalancer(NeutronLoadBalancer neutronLB) {
60 //Always allowed and not wait for pool and members to be created
61 return HttpURLConnection.HTTP_OK;
65 public void neutronLoadBalancerCreated(NeutronLoadBalancer neutronLB) {
66 LOG.debug("Neutron LB Creation : {}", neutronLB.toString());
67 enqueueEvent(new NorthboundEvent(neutronLB, Action.ADD));
71 * Assuming that the pool information is fully populated before this call is made,
72 * we go with creating the LoadBalancerConfiguration object for this call with
73 * all information that is necessary to insert flow_mods
75 private void doNeutronLoadBalancerCreate(NeutronLoadBalancer neutronLB) {
76 Preconditions.checkNotNull(loadBalancerProvider);
77 LoadBalancerConfiguration lbConfig = extractLBConfiguration(neutronLB);
78 final List<Node> nodes = nodeCacheManager.getBridgeNodes();
80 if (!lbConfig.isValid()) {
81 LOG.debug("Neutron LB pool configuration invalid for {} ", lbConfig.getName());
82 } else if (nodes.isEmpty()) {
83 LOG.debug("Noop with LB {} creation because no nodes available.", lbConfig.getName());
85 for (Node node : nodes) {
86 loadBalancerProvider.programLoadBalancerRules(node, lbConfig, Action.ADD);
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;
98 public void neutronLoadBalancerUpdated(NeutronLoadBalancer neutronLB) {
99 LOG.debug("Neutron LB Update : {}", neutronLB.toString());
100 enqueueEvent(new NorthboundEvent(neutronLB, Action.UPDATE));
104 public int canDeleteNeutronLoadBalancer(NeutronLoadBalancer neutronLB) {
105 //Always allowed and not wait for pool to stop using it
106 return HttpURLConnection.HTTP_OK;
110 public void neutronLoadBalancerDeleted(NeutronLoadBalancer neutronLB) {
111 LOG.debug("Neutron LB Deletion : {}", neutronLB.toString());
112 enqueueEvent(new NorthboundEvent(neutronLB, Action.DELETE));
115 private void doNeutronLoadBalancerDelete(NeutronLoadBalancer neutronLB) {
116 Preconditions.checkNotNull(loadBalancerProvider);
117 LoadBalancerConfiguration lbConfig = extractLBConfiguration(neutronLB);
118 final List<Node> nodes = nodeCacheManager.getBridgeNodes();
120 if (!lbConfig.isValid()) {
121 LOG.debug("Neutron LB pool configuration invalid for {} ", lbConfig.getName());
122 } else if (nodes.isEmpty()) {
123 LOG.debug("Noop with LB {} deletion because no nodes available.", lbConfig.getName());
125 for (Node node : nodes) {
126 loadBalancerProvider.programLoadBalancerRules(node, lbConfig, Action.DELETE);
134 * @param abstractEvent the {@link org.opendaylight.ovsdb.openstack.netvirt.AbstractEvent} event to be handled.
135 * @see org.opendaylight.ovsdb.openstack.netvirt.api.EventDispatcher
138 public void processEvent(AbstractEvent abstractEvent) {
139 LOG.debug("Processing Loadbalancer event {}", abstractEvent);
140 if (!(abstractEvent instanceof NorthboundEvent)) {
141 LOG.error("Unable to process abstract event {}", abstractEvent);
144 NorthboundEvent ev = (NorthboundEvent) abstractEvent;
145 switch (ev.getAction()) {
147 doNeutronLoadBalancerCreate(ev.getLoadBalancer());
150 doNeutronLoadBalancerDelete(ev.getLoadBalancer());
154 * Currently member update requires delete and re-adding
155 * Also, weights and weight updates are not supported
157 doNeutronLoadBalancerDelete(ev.getLoadBalancer());
158 doNeutronLoadBalancerCreate(ev.getLoadBalancer());
161 LOG.warn("Unable to process event action {}", ev.getAction());
167 * Useful utility for extracting the loadbalancer instance
168 * configuration from the neutron LB cache
169 * @param neutronLB neutron load balancer object
170 * @return returns load balancer configuration
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.getID();
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(ServiceReference serviceReference) {
253 loadBalancerProvider =
254 (LoadBalancerProvider) ServiceHelper.getGlobalInstance(LoadBalancerProvider.class, this);
256 (NodeCacheManager) ServiceHelper.getGlobalInstance(NodeCacheManager.class, this);
257 nodeCacheManager.cacheListenerAdded(serviceReference, this);
259 (EventDispatcher) ServiceHelper.getGlobalInstance(EventDispatcher.class, this);
260 eventDispatcher.eventHandlerAdded(serviceReference, this);
264 public void setDependencies(Object impl) {
265 if (impl instanceof INeutronNetworkCRUD) {
266 neutronNetworkCache = (INeutronNetworkCRUD)impl;
267 } else if (impl instanceof INeutronPortCRUD) {
268 neutronPortCache = (INeutronPortCRUD)impl;
269 } else if (impl instanceof INeutronSubnetCRUD) {
270 neutronSubnetCache = (INeutronSubnetCRUD)impl;
271 } else if (impl instanceof INeutronLoadBalancerCRUD) {
272 neutronLBCache = (INeutronLoadBalancerCRUD)impl;
273 } else if (impl instanceof INeutronLoadBalancerPoolCRUD) {
274 neutronLBPoolCache = (INeutronLoadBalancerPoolCRUD)impl;
275 } else if (impl instanceof LoadBalancerProvider) {
276 loadBalancerProvider = (LoadBalancerProvider)impl;