bug CS-14291: support EIP with multiple NetScalers in basic zone

This fix will enable support for multiple NetScaler devices providing EIP service in same zone.

    - Introduced global setting "eip.use.multiple.netscalers" to turn multiple netscaler support
    - Enhanced configureNetscalerLoadBalancer API to take the PBR setup between the POD's subnet
      and NetScaler device
    - logic to pick a NetScaler (based on the guest IP and corresponding pod) while configuring INAT rule

Author: Murali reddy

api/src/com/cloud/api/ApiConstants.java

@@ -127,6 +127,7 @@ public class ApiConstants {
     public static final String SSHKEY_ENABLED = "sshkeyenabled";
     public static final String PATH = "path";
     public static final String POD_ID = "podid";
+    public static final String POD_IDS = "podids";
     public static final String POLICY_ID = "policyid";
     public static final String PORT = "port";
     public static final String PORTAL = "portal";

api/src/com/cloud/api/response/NetscalerLoadBalancerResponse.java

@@ -12,11 +12,16 @@
 // Automatically generated by addcopyright.py at 04/03/2012
 package com.cloud.api.response;
 
+import java.util.List;
+
 import com.cloud.api.ApiConstants;
+import com.cloud.api.Parameter;
+import com.cloud.api.BaseCmd.CommandType;
 import com.cloud.utils.IdentityProxy;
 import com.cloud.serializer.Param;
 import com.google.gson.annotations.SerializedName;
 
+@SuppressWarnings("unused")
 public class NetscalerLoadBalancerResponse extends BaseResponse {
 
     @SerializedName(ApiConstants.LOAD_BALANCER_DEVICE_ID) @Param(description="device id of the netscaler load balancer")
@@ -52,6 +57,11 @@ public class NetscalerLoadBalancerResponse extends BaseResponse {
     @SerializedName(ApiConstants.IP_ADDRESS) @Param(description="the management IP address of the external load balancer")
     private String ipAddress;
 
+    @SerializedName(ApiConstants.POD_IDS) @Param(description="Used when NetScaler device is provider of EIP service." +
+            " This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to " +
+            "route pod's subnet IP to a NetScaler device.")
+    private List<Long> podIds;
+    
     public void setId(long lbDeviceId) {
         this.id.setValue(lbDeviceId);
     }
@@ -95,4 +105,8 @@ public void setPrivateInterface(String privateInterface) {
     public void setIpAddress(String ipAddress) {
         this.ipAddress = ipAddress;
     }
+
+    public void setAssociatedPods(List<Long> pods) {
+        this.podIds = pods;
+    }
 }

server/src/com/cloud/api/commands/ConfigureNetscalerLoadBalancerCmd.java

@@ -12,6 +12,8 @@
 // Automatically generated by addcopyright.py at 04/03/2012
 package com.cloud.api.commands;
 
+import java.util.List;
+
 import org.apache.log4j.Logger;
 
 import com.cloud.api.ApiConstants;
@@ -22,6 +24,7 @@
 import com.cloud.api.Parameter;
 import com.cloud.api.PlugService;
 import com.cloud.api.ServerApiException;
+import com.cloud.api.BaseCmd.CommandType;
 import com.cloud.api.response.NetscalerLoadBalancerResponse;
 import com.cloud.event.EventTypes;
 import com.cloud.exception.ConcurrentOperationException;
@@ -58,6 +61,12 @@ public class ConfigureNetscalerLoadBalancerCmd extends BaseAsyncCmd {
     @Parameter (name=ApiConstants.INLINE, type=CommandType.BOOLEAN, required=false, description="true if netscaler load balancer is intended to be used in in-line with firewall, false if netscaler load balancer will side-by-side with firewall")
     private Boolean inline;
 
+    @IdentityMapper(entityTableName="host_pod_ref")
+    @Parameter(name=ApiConstants.POD_IDS, type=CommandType.LIST, required=false, description="Used when NetScaler device is provider of EIP service." +
+            " This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to " +
+            "route pod's subnet IP to a NetScaler device.")
+    private List<Long> podIds;
+
     /////////////////////////////////////////////////////
     /////////////////// Accessors ///////////////////////
     /////////////////////////////////////////////////////
@@ -78,6 +87,10 @@ public Boolean getLoadBalancerInline() {
         return inline;
     }
 
+    public List<Long> getPodIds() {
+        return podIds;
+    }
+
     /////////////////////////////////////////////////////
     /////////////// API Implementation///////////////////
     /////////////////////////////////////////////////////

server/src/com/cloud/configuration/Config.java

@@ -328,6 +328,7 @@ public enum Config {
 
     DefaultExternalLoadBalancerCapacity("Advanced", ManagementServer.class, String.class, "external.lb.default.capacity", "50", "default number of networks permitted per external load balancer device", null),
     DefaultExternalFirewallCapacity("Advanced", ManagementServer.class, String.class, "external.firewall.default.capacity", "50", "default number of networks permitted per external load firewall device", null),
+    EIPWithMultipleNetScalersEnabled("Advanced", ManagementServer.class, Boolean.class, "eip.use.multiple.netscalers", "false", "Should be set to true, if there will be multiple NetScaler devices providing EIP service in a zone", null),
 	CustomDiskOfferingMinSize("Advanced", ManagementServer.class, Long.class, "custom.diskoffering.size.min", "1", "Minimum size in GB for custom disk offering", null),
 	CustomDiskOfferingMaxSize("Advanced", ManagementServer.class, Long.class, "custom.diskoffering.size.max", "1024", "Maximum size in GB for custom disk offering", null),
 	ConsoleProxyServiceOffering("Advanced", ManagementServer.class, Long.class, "consoleproxy.service.offering", null, "Service offering used by console proxy; if NULL - system offering will be used", null),

server/src/com/cloud/configuration/DefaultComponentLibrary.java

@@ -79,6 +79,7 @@
 import com.cloud.network.dao.LBStickinessPolicyDaoImpl;
 import com.cloud.network.dao.LoadBalancerDaoImpl;
 import com.cloud.network.dao.LoadBalancerVMMapDaoImpl;
+import com.cloud.network.dao.NetScalerPodDaoImpl;
 import com.cloud.network.dao.NetworkDaoImpl;
 import com.cloud.network.dao.NetworkDomainDaoImpl;
 import com.cloud.network.dao.NetworkExternalFirewallDaoImpl;
@@ -315,6 +316,7 @@ protected void populateDaos() {
         addDao("ExternalFirewallDeviceDao", ExternalFirewallDeviceDaoImpl.class);
         addDao("NetworkExternalLoadBalancerDao", NetworkExternalLoadBalancerDaoImpl.class);
         addDao("NetworkExternalFirewallDao", NetworkExternalFirewallDaoImpl.class);
+        addDao("NetScalerPodDao", NetScalerPodDaoImpl.class);
         addDao("PhysicalNetworkTrafficTypeDao", PhysicalNetworkTrafficTypeDaoImpl.class);
         addDao("NetworkServiceMapDao", NetworkServiceMapDaoImpl.class);
         addDao("StorageNetworkIpAddressDao", StorageNetworkIpAddressDaoImpl.class);

server/src/com/cloud/network/NetScalerPodVO.java

@@ -0,0 +1,61 @@
+// Copyright 2012 Citrix Systems, Inc. Licensed under the
+// Apache License, Version 2.0 (the "License"); you may not use this
+// file except in compliance with the License.  Citrix Systems, Inc.
+// reserves all rights not expressly granted by the License.
+// You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package com.cloud.network;
+
+import javax.persistence.Column;
+import javax.persistence.Entity;
+import javax.persistence.GeneratedValue;
+import javax.persistence.GenerationType;
+import javax.persistence.Id;
+import javax.persistence.Table;
+
+/**
+ * NetScalerPodVO contains information about a EIP deployment where on datacenter L3 router a PBR (policy
+ * based routing) is setup between a POD's subnet IP range to a NetScaler device. This VO object 
+ * represents a mapping between a POD and NetScaler device where PBR is setup. 
+ *
+ */
+@Entity
+@Table(name="netscaler_pod_ref")
+public class NetScalerPodVO {
+ 
+    @Column(name="external_load_balancer_device_id")
+    private long netscalerDeviceId;
+
+    @Id
+    @Column(name="id")
+    private long id;
+
+    @Column(name="pod_id")
+    private long podId;
+
+    public NetScalerPodVO() {
+        
+    }
+
+    public NetScalerPodVO(long netscalerDeviceId, long podId) {
+    	this.netscalerDeviceId = netscalerDeviceId;
+    	this.podId = podId;
+    }
+
+    public long getId() {
+        return id;
+    }
+
+    public long getPodId() {
+        return podId;
+    }
+
+    public long getNetscalerDeviceId() {
+    	return netscalerDeviceId;
+    }
+}

server/src/com/cloud/network/dao/NetScalerPodDao.java

@@ -0,0 +1,24 @@
+// Copyright 2012 Citrix Systems, Inc. Licensed under the
+// Apache License, Version 2.0 (the "License"); you may not use this
+// file except in compliance with the License.  Citrix Systems, Inc.
+// reserves all rights not expressly granted by the License.
+// You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package com.cloud.network.dao;
+
+import java.util.List;
+
+import com.cloud.network.NetScalerPodVO;
+import com.cloud.utils.db.GenericDao;
+
+public interface NetScalerPodDao extends GenericDao<NetScalerPodVO, Long> {
+
+    NetScalerPodVO findByPodId(long podId);
+
+    List<NetScalerPodVO> listByNetScalerDeviceId(long netscalerDeviceId);
+}

server/src/com/cloud/network/dao/NetScalerPodDaoImpl.java

@@ -0,0 +1,57 @@
+// Copyright 2012 Citrix Systems, Inc. Licensed under the
+// Apache License, Version 2.0 (the "License"); you may not use this
+// file except in compliance with the License.  Citrix Systems, Inc.
+// reserves all rights not expressly granted by the License.
+// You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package com.cloud.network.dao;
+
+import java.util.List;
+
+import javax.ejb.Local;
+
+import com.cloud.network.NetScalerPodVO;
+import com.cloud.utils.db.DB;
+import com.cloud.utils.db.GenericDaoBase;
+import com.cloud.utils.db.SearchBuilder;
+import com.cloud.utils.db.SearchCriteria;
+import com.cloud.utils.db.SearchCriteria.Op;
+
+@Local(value=NetScalerPodDao.class) @DB(txn=false)
+public class NetScalerPodDaoImpl extends GenericDaoBase<NetScalerPodVO, Long> implements NetScalerPodDao {
+
+    final SearchBuilder<NetScalerPodVO> podIdSearch;
+    final SearchBuilder<NetScalerPodVO> deviceIdSearch;
+
+    protected NetScalerPodDaoImpl() {
+        super();
+
+        podIdSearch = createSearchBuilder();
+        podIdSearch.and("pod_id", podIdSearch.entity().getPodId(), Op.EQ);
+        podIdSearch.done();
+
+        deviceIdSearch = createSearchBuilder();
+        deviceIdSearch.and("netscalerDeviceId", deviceIdSearch.entity().getNetscalerDeviceId(), Op.EQ);
+        deviceIdSearch.done();
+    }
+
+    @Override
+    public NetScalerPodVO findByPodId(long podId) {
+        SearchCriteria<NetScalerPodVO> sc = podIdSearch.create();
+        sc.setParameters("pod_id", podId);
+        return findOneBy(sc);
+    }
+
+    @Override
+    public List<NetScalerPodVO> listByNetScalerDeviceId(long netscalerDeviceId) {
+        SearchCriteria<NetScalerPodVO> sc = deviceIdSearch.create();
+        sc.setParameters("netscalerDeviceId", netscalerDeviceId);
+        return search(sc, null);
+    }
+
+}