HAproxy based load balancer customization

Add new feature for load balancers based on haproxy

Author: Rakesh Venkatesh

api/src/main/java/com/cloud/agent/api/to/LoadBalancerConfigTO.java

@@ -0,0 +1,42 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements.  See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership.  The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with 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.agent.api.to;
+
+import org.apache.cloudstack.network.lb.LoadBalancerConfig;
+
+public class LoadBalancerConfigTO {
+    private String name;
+    private String value;
+
+    public LoadBalancerConfigTO(String name, String value) {
+        this.name = name;
+        this.value = value;
+    }
+
+    public LoadBalancerConfigTO(LoadBalancerConfig config) {
+        this.name = config.getName();
+        this.value = config.getValue();
+    }
+
+    public String getName() {
+        return name;
+    }
+
+    public String getValue() {
+        return value;
+    }
+}

api/src/main/java/com/cloud/agent/api/to/LoadBalancerTO.java

@@ -35,6 +35,9 @@
 import com.cloud.network.lb.LoadBalancingRule.LbStickinessPolicy;
 import com.cloud.utils.Pair;
 
+import org.apache.cloudstack.network.lb.LoadBalancerConfig;
+import org.springframework.util.CollectionUtils;
+
 public class LoadBalancerTO {
     String uuid;
     String srcIp;
@@ -50,6 +53,7 @@ public class LoadBalancerTO {
     String srcIpNetmask;
     Long networkId;
     DestinationTO[] destinations;
+    private LoadBalancerConfigTO[] lbConfigs;
     private StickinessPolicyTO[] stickinessPolicies;
     private HealthCheckPolicyTO[] healthCheckPolicies;
     private LbSslCert sslCert; /* XXX: Should this be SslCertTO?  */
@@ -179,6 +183,22 @@ public boolean isInline() {
         return inline;
     }
 
+    public LoadBalancerConfigTO[] getLbConfigs() {
+        return this.lbConfigs;
+    }
+
+    public void setLbConfigs(List<? extends LoadBalancerConfig> lbConfigs) {
+        if (CollectionUtils.isEmpty(lbConfigs)) {
+            this.lbConfigs = new LoadBalancerConfigTO[0];
+            return;
+        }
+        this.lbConfigs = new LoadBalancerConfigTO[lbConfigs.size()];
+        int i = 0;
+        for (LoadBalancerConfig lbConfig : lbConfigs) {
+            this.lbConfigs[i++] = new LoadBalancerConfigTO(lbConfig);
+        }
+    }
+
     public StickinessPolicyTO[] getStickinessPolicies() {
         return stickinessPolicies;
     }
@@ -207,6 +227,10 @@ public LbSslCert getSslCert() {
         return this.sslCert;
     }
 
+    public void setLbSslCert(LbSslCert sslCert) {
+        this.sslCert = sslCert;
+    }
+
     public String getSrcIpVlan() {
         return srcIpVlan;
     }

api/src/main/java/com/cloud/event/EventTypes.java

@@ -176,6 +176,10 @@ public class EventTypes {
     public static final String EVENT_LB_CERT_DELETE = "LB.CERT.DELETE";
     public static final String EVENT_LB_CERT_ASSIGN = "LB.CERT.ASSIGN";
     public static final String EVENT_LB_CERT_REMOVE = "LB.CERT.REMOVE";
+    public static final String EVENT_LOAD_BALANCER_CONFIG_CREATE = "LB.CONFIG.CREATE";
+    public static final String EVENT_LOAD_BALANCER_CONFIG_DELETE = "LB.CONFIG.DELETE";
+    public static final String EVENT_LOAD_BALANCER_CONFIG_REPLACE = "LB.CONFIG.REPLACE";
+    public static final String EVENT_LOAD_BALANCER_CONFIG_UPDATE = "LB.CONFIG.UPDATE";
 
     // Global Load Balancer rules
     public static final String EVENT_ASSIGN_TO_GLOBAL_LOAD_BALANCER_RULE = "GLOBAL.LB.ASSIGN";

api/src/main/java/com/cloud/network/lb/LoadBalancingRulesService.java

@@ -102,7 +102,7 @@ LoadBalancer createPublicLoadBalancerRule(String xId, String name, String descri
 
     boolean applyLoadBalancerConfig(long lbRuleId) throws ResourceUnavailableException;
 
-    boolean assignCertToLoadBalancer(long lbRuleId, Long certId);
+    boolean assignCertToLoadBalancer(long lbRuleId, Long certId, boolean forced);
 
     boolean removeCertFromLoadBalancer(long lbRuleId);
 

api/src/main/java/org/apache/cloudstack/api/ApiConstants.java

@@ -88,6 +88,7 @@ public class ApiConstants {
     public static final String CLUSTER_TYPE = "clustertype";
     public static final String CN = "cn";
     public static final String COMMAND = "command";
+    public static final String CONFIG = "config";
     public static final String CMD_EVENT_TYPE = "cmdeventtype";
     public static final String COMPONENT = "component";
     public static final String CPU_CORE_PER_SOCKET = "cpucorepersocket";
@@ -110,6 +111,7 @@ public class ApiConstants {
     public static final String MAX_IOPS = "maxiops";
     public static final String HYPERVISOR_SNAPSHOT_RESERVE = "hypervisorsnapshotreserve";
     public static final String DATADISK_OFFERING_LIST = "datadiskofferinglist";
+    public static final String DEFAULT_VALUE = "defaultvalue";
     public static final String DESCRIPTION = "description";
     public static final String DESTINATION_ZONE_ID = "destzoneid";
     public static final String DETAILS = "details";
@@ -564,6 +566,7 @@ public class ApiConstants {
     public static final String LOAD_BALANCER_DEVICE_STATE = "lbdevicestate";
     public static final String LOAD_BALANCER_DEVICE_CAPACITY = "lbdevicecapacity";
     public static final String LOAD_BALANCER_DEVICE_DEDICATED = "lbdevicededicated";
+    public static final String LOAD_BALANCER_ID = "loadbalancerid";
     public static final String LOAD_BALANCER_RULE = "loadbalancerrule";
     public static final String LOAD_BALANCER_RULE_LIST = "loadbalancerrulelist";
     public static final String FIREWALL_DEVICE_ID = "fwdeviceid";

api/src/main/java/org/apache/cloudstack/api/BaseCmd.java

@@ -44,6 +44,7 @@
 import org.apache.cloudstack.network.element.InternalLoadBalancerElementService;
 import org.apache.cloudstack.network.lb.ApplicationLoadBalancerService;
 import org.apache.cloudstack.network.lb.InternalLoadBalancerVMService;
+import org.apache.cloudstack.network.lb.LoadBalancerConfigService;
 import org.apache.cloudstack.query.QueryService;
 import org.apache.cloudstack.storage.ImageStoreService;
 import org.apache.cloudstack.usage.UsageService;
@@ -152,6 +153,8 @@ public static enum CommandType {
     @Inject
     public LoadBalancingRulesService _lbService;
     @Inject
+    public LoadBalancerConfigService _lbConfigService;
+    @Inject
     public RemoteAccessVpnService _ravService;
     @Inject
     public ProjectService _projectService;

api/src/main/java/org/apache/cloudstack/api/ResponseGenerator.java

@@ -77,6 +77,7 @@
 import org.apache.cloudstack.api.response.LBHealthCheckResponse;
 import org.apache.cloudstack.api.response.LBStickinessResponse;
 import org.apache.cloudstack.api.response.ListResponse;
+import org.apache.cloudstack.api.response.LoadBalancerConfigResponse;
 import org.apache.cloudstack.api.response.LoadBalancerResponse;
 import org.apache.cloudstack.api.response.ManagementServerResponse;
 import org.apache.cloudstack.api.response.NetworkACLItemResponse;
@@ -137,6 +138,7 @@
 import org.apache.cloudstack.backup.BackupSchedule;
 import org.apache.cloudstack.config.Configuration;
 import org.apache.cloudstack.network.lb.ApplicationLoadBalancerRule;
+import org.apache.cloudstack.network.lb.LoadBalancerConfig;
 import org.apache.cloudstack.region.PortableIp;
 import org.apache.cloudstack.region.PortableIpRange;
 import org.apache.cloudstack.region.Region;
@@ -268,6 +270,10 @@ public interface ResponseGenerator {
 
     LoadBalancerResponse createLoadBalancerResponse(LoadBalancer loadBalancer);
 
+    LoadBalancerConfigResponse createLoadBalancerConfigResponse(LoadBalancerConfig config);
+
+    List<LoadBalancerConfigResponse> createLoadBalancerConfigResponse(List<? extends LoadBalancerConfig> configs);
+
     LBStickinessResponse createLBStickinessPolicyResponse(List<? extends StickinessPolicy> stickinessPolicies, LoadBalancer lb);
 
     LBStickinessResponse createLBStickinessPolicyResponse(StickinessPolicy stickinessPolicy, LoadBalancer lb);

api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/AssignCertToLoadBalancerCmd.java

@@ -17,9 +17,11 @@
 // under the License.
 package org.apache.cloudstack.api.command.user.loadbalancer;
 
+import org.apache.commons.lang3.BooleanUtils;
 import org.apache.log4j.Logger;
 
 import org.apache.cloudstack.api.APICommand;
+import org.apache.cloudstack.api.ApiCommandJobType;
 import org.apache.cloudstack.api.ApiConstants;
 import org.apache.cloudstack.api.ApiErrorCode;
 import org.apache.cloudstack.api.BaseAsyncCmd;
@@ -44,7 +46,7 @@ public class AssignCertToLoadBalancerCmd extends BaseAsyncCmd {
 
     public static final Logger s_logger = Logger.getLogger(AssignCertToLoadBalancerCmd.class.getName());
 
-    private static final String s_name = "assigncerttoloadbalancerresponse";
+    private static final String RESPONSE_NAME = "assigncerttoloadbalancerresponse";
 
     @Parameter(name = ApiConstants.LBID,
                type = CommandType.UUID,
@@ -60,11 +62,17 @@ public class AssignCertToLoadBalancerCmd extends BaseAsyncCmd {
                description = "the ID of the certificate")
     Long certId;
 
+    @Parameter(name = ApiConstants.FORCED, type = CommandType.BOOLEAN, required = false,
+        since = "4.17",
+        description = "Force assign the certificate. If there is a certificate bound to the LB, it will be removed")
+    private Boolean forced;
+
+
     @Override
     public void execute() throws ResourceUnavailableException, InsufficientCapacityException, ServerApiException, ConcurrentOperationException,
         ResourceAllocationException, NetworkRuleConflictException {
         //To change body of implemented methods use File | Settings | File Templates.
-        if (_lbService.assignCertToLoadBalancer(getLbRuleId(), getCertId())) {
+        if (_lbService.assignCertToLoadBalancer(getLbRuleId(), getCertId(), isForced())) {
             SuccessResponse response = new SuccessResponse(getCommandName());
             this.setResponseObject(response);
         } else {
@@ -79,7 +87,7 @@ public String getEventType() {
 
     @Override
     public String getCommandName() {
-        return s_name;
+        return RESPONSE_NAME;
     }
 
     @Override
@@ -103,4 +111,29 @@ public Long getCertId() {
     public Long getLbRuleId() {
         return lbRuleId;
     }
+
+    public boolean isForced() {
+        return BooleanUtils.toBoolean(forced);
+    }
+
+    @Override
+    public ApiCommandJobType getInstanceType() {
+        return ApiCommandJobType.LoadBalancerRule;
+    }
+
+    @Override
+    public Long getInstanceId() {
+        return lbRuleId;
+    }
+
+    @Override
+    public String getSyncObjType() {
+        return BaseAsyncCmd.networkSyncObject;
+    }
+
+    @Override
+    public Long getSyncObjId() {
+        LoadBalancer lb = _entityMgr.findById(LoadBalancer.class, getLbRuleId());
+        return (lb != null )? lb.getNetworkId(): null;
+    }
 }