Support VPC public gateway rate throttling, built on NIC/network rate persistence and precedence fixes

api/src/main/java/com/cloud/network/vpc/VpcOffering.java

@@ -86,4 +86,6 @@ public enum State {
     Boolean isSpecifyAsNumber();
 
     boolean isConserveMode();
+
+    Integer getPublicNetworkRate();
 }

api/src/main/java/com/cloud/network/vpc/VpcProvisioningService.java

@@ -42,7 +42,7 @@ VpcOffering createVpcOffering(String name, String displayText, List<String> supp
                                   Map serviceCapabilitystList, NetUtils.InternetProtocol internetProtocol,
                                   Long serviceOfferingId, String externalProvider, NetworkOffering.NetworkMode networkMode,
                                   List<Long> domainIds, List<Long> zoneIds, VpcOffering.State state,
-                                  NetworkOffering.RoutingMode routingMode, boolean specifyAsNumber, boolean conserveMode);
+                                  NetworkOffering.RoutingMode routingMode, boolean specifyAsNumber, boolean conserveMode, Integer publicNetworkRate);
 
 
     Pair<List<? extends VpcOffering>,Integer> listVpcOfferings(ListVPCOfferingsCmd cmd);

api/src/main/java/com/cloud/vm/Nic.java

@@ -168,5 +168,7 @@ public enum ReservationStrategy {
 
     Integer getMtu();
 
+    Integer getNetworkRate();
+
     boolean isEnabled();
 }

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

@@ -729,6 +729,7 @@ public class ApiConstants {
     public static final String IS_USER_DEFINED = "isuserdefined";
     public static final String AVAILABILITY = "availability";
     public static final String NETWORKRATE = "networkrate";
+    public static final String PUBLIC_NETWORK_RATE = "publicnetworkrate";
     public static final String HOST_TAGS = "hosttags";
     public static final String SSH_KEYPAIR = "keypair";
     public static final String SSH_KEYPAIRS = "keypairs";

api/src/main/java/org/apache/cloudstack/api/command/admin/vpc/CreateVPCOfferingCmd.java

@@ -165,6 +165,11 @@ public class CreateVPCOfferingCmd extends BaseAsyncCreateCmd {
             description = "True if the VPC offering is IP conserve mode enabled, allowing public IPs to be used across multiple VPC tiers. Default value is false")
     private Boolean conserveMode;
 
+    @Parameter(name = ApiConstants.PUBLIC_NETWORK_RATE, type = CommandType.INTEGER,
+            since = "4.24.0",
+            description = "Data transfer rate in megabits per second allowed for a VPC's public gateway (internet-facing network), created with this offering. Default is unlimited")
+    private Integer publicNetworkRate;
+
 
     /////////////////////////////////////////////////////
     /////////////////// Accessors ///////////////////////
@@ -318,6 +323,10 @@ public boolean isConserveMode() {
         return BooleanUtils.toBoolean(conserveMode);
     }
 
+    public Integer getPublicNetworkRate() {
+        return publicNetworkRate;
+    }
+
     @Override
     public void create() throws ResourceAllocationException {
         VpcOffering vpcOff = _vpcProvSvc.createVpcOffering(this);

api/src/main/java/org/apache/cloudstack/api/command/admin/vpc/UpdateVPCOfferingCmd.java

@@ -68,6 +68,11 @@ public class UpdateVPCOfferingCmd extends BaseAsyncCmd implements DomainAndZoneI
     @Parameter(name = ApiConstants.SORT_KEY, type = CommandType.INTEGER, description = "Sort key of the VPC offering, integer")
     private Integer sortKey;
 
+    @Parameter(name = ApiConstants.PUBLIC_NETWORK_RATE, type = CommandType.INTEGER,
+            since = "4.24.0",
+            description = "Data transfer rate in megabits per second allowed for a VPC's public gateway (internet-facing network), created with this offering. Use 0 for unlimited")
+    private Integer publicNetworkRate;
+
     /////////////////////////////////////////////////////
     /////////////////// Accessors ///////////////////////
     /////////////////////////////////////////////////////
@@ -100,6 +105,10 @@ public Integer getSortKey() {
         return sortKey;
     }
 
+    public Integer getPublicNetworkRate() {
+        return publicNetworkRate;
+    }
+
     /////////////////////////////////////////////////////
     /////////////// API Implementation///////////////////
     /////////////////////////////////////////////////////

api/src/main/java/org/apache/cloudstack/api/response/NetworkResponse.java

@@ -311,6 +311,10 @@ public class NetworkResponse extends BaseResponseWithAssociatedNetwork implement
     @Param(description = "MTU configured on the network VR's private interfaces")
     private Integer privateMtu;
 
+    @SerializedName(ApiConstants.NETWORKRATE)
+    @Param(description = "Network rate (in Mb/s) configured for the Guest interface of this network; -1 if unlimited", since = "4.24.0")
+    private Integer networkRate;
+
     @SerializedName(ApiConstants.IP6_DNS1)
     @Param(description = "The first IPv6 DNS for the network", since = "4.18.0")
     private String ipv6Dns1;
@@ -707,6 +711,14 @@ public void setPrivateMtu(Integer privateMtu) {
         this.privateMtu = privateMtu;
     }
 
+    public Integer getNetworkRate() {
+        return networkRate;
+    }
+
+    public void setNetworkRate(Integer networkRate) {
+        this.networkRate = networkRate;
+    }
+
     public void setIpv6Dns1(String ipv6Dns1) {
         this.ipv6Dns1 = ipv6Dns1;
     }

api/src/main/java/org/apache/cloudstack/api/response/NicResponse.java

@@ -138,6 +138,10 @@ public class NicResponse extends BaseResponse {
     @Param(description = "MTU configured on the NIC", since="4.18.0")
     private Integer mtu;
 
+    @SerializedName(ApiConstants.NETWORKRATE)
+    @Param(description = "Network rate (in Mb/s) configured for the NIC; -1 if unlimited", since = "4.24.0")
+    private Integer networkRate;
+
     @SerializedName(ApiConstants.PUBLIC_IP_ID)
     @Param(description = "Public IP address ID associated with this NIC via Static NAT rule")
     private String publicIpId;
@@ -413,6 +417,14 @@ public void setMtu(Integer mtu) {
         this.mtu = mtu;
     }
 
+    public Integer getNetworkRate() {
+        return networkRate;
+    }
+
+    public void setNetworkRate(Integer networkRate) {
+        this.networkRate = networkRate;
+    }
+
     public String getVpcId() {
         return vpcId;
     }

api/src/main/java/org/apache/cloudstack/api/response/VpcOfferingResponse.java

@@ -106,6 +106,10 @@ public class VpcOfferingResponse extends BaseResponse {
     @Param(description = "True if the VPC offering is IP conserve mode enabled, allowing public IP services to be used across multiple VPC tiers.", since = "4.23.0")
     private Boolean conserveMode;
 
+    @SerializedName(ApiConstants.PUBLIC_NETWORK_RATE)
+    @Param(description = "Data transfer rate in megabits per second allowed for a VPC's public gateway (internet-facing network), created with this offering; -1 if unset (falls back to the zone/global default) or unlimited", since = "4.24.0")
+    private Integer publicNetworkRate;
+
     public void setId(String id) {
         this.id = id;
     }
@@ -213,4 +217,8 @@ public Boolean getConserveMode() {
     public void setConserveMode(Boolean conserveMode) {
         this.conserveMode = conserveMode;
     }
+
+    public void setPublicNetworkRate(Integer publicNetworkRate) {
+        this.publicNetworkRate = publicNetworkRate;
+    }
 }

api/src/main/java/org/apache/cloudstack/api/response/VpcResponse.java

@@ -77,6 +77,10 @@ public class VpcResponse extends BaseResponseWithAnnotations implements Controll
     @Param(description = "true if VPC offering is ip conserve mode enabled", since = "4.23")
     private Boolean vpcOfferingConserveMode;
 
+    @SerializedName(ApiConstants.PUBLIC_NETWORK_RATE)
+    @Param(description = "Data transfer rate in megabits per second allowed for this VPC's public gateway (internet-facing network); -1 if unlimited", since = "4.24.0")
+    private Integer publicNetworkRate;
+
     @SerializedName(ApiConstants.CREATED)
     @Param(description = "The date this VPC was created")
     private Date created;
@@ -209,6 +213,10 @@ public void setVpcOfferingConserveMode(Boolean vpcOfferingConserveMode) {
         this.vpcOfferingConserveMode = vpcOfferingConserveMode;
     }
 
+    public void setPublicNetworkRate(Integer publicNetworkRate) {
+        this.publicNetworkRate = publicNetworkRate;
+    }
+
     public void setCreated(final Date created) {
         this.created = created;
     }

engine/api/src/main/java/org/apache/cloudstack/engine/orchestration/service/NetworkOrchestrationService.java

@@ -138,6 +138,9 @@ public interface NetworkOrchestrationService {
     ConfigKey<Integer> VmNetworkThrottlingRate = new ConfigKey<Integer>("Network", Integer.class, "vm.network.throttling.rate", "200",
             "Default data transfer rate in megabits per second allowed in User vm's default network.", true, ConfigKey.Scope.Zone);
 
+    ConfigKey<Integer> VpcPublicNetworkThrottlingRate = new ConfigKey<>("Network", Integer.class, "vpc.public.network.throttling.rate", "0",
+            "Default data transfer rate in megabits per second allowed for a VPC's public/internet-facing network. 0 means unlimited.", true, ConfigKey.Scope.Zone);
+
     List<? extends Network> setupNetwork(Account owner, NetworkOffering offering, DeploymentPlan plan, String name, String displayText, boolean isDefault)
         throws ConcurrentOperationException;
 

engine/components-api/src/main/java/com/cloud/configuration/ConfigurationManager.java

@@ -82,6 +82,8 @@ public interface ConfigurationManager {
 
     Integer getServiceOfferingNetworkRate(long serviceOfferingId, Long dataCenterId);
 
+    Integer getVpcOfferingNetworkRate(long vpcOfferingId, Long dataCenterId);
+
     /**
      * Updates a configuration entry with a new value
      */

engine/orchestration/src/main/java/org/apache/cloudstack/engine/orchestration/NetworkOrchestrator.java

@@ -777,6 +777,11 @@ private void updateRouterIpInNetworkDetails(Long networkId, String routerIp, Str
         }
     }
 
+    private void saveNetworkRateInDetails(long networkId, NetworkOffering offering, long dataCenterId) {
+        Integer rate = _configMgr.getNetworkOfferingNetworkRate(offering.getId(), dataCenterId);
+        networkDetailsDao.addDetail(networkId, ApiConstants.NETWORKRATE, String.valueOf(rate), true);
+    }
+
     @Override
     public List<? extends Network> setupNetwork(final Account owner, final NetworkOffering offering, final DeploymentPlan plan, final String name, final String displayText, final boolean isDefault)
             throws ConcurrentOperationException {
@@ -852,6 +857,7 @@ public void doInTransactionWithoutResult(final TransactionStatus status) {
                         }
 
                         updateRouterIpInNetworkDetails(networkPersisted.getId(), network.getRouterIp(), network.getRouterIpv6());
+                        saveNetworkRateInDetails(networkPersisted.getId(), offering, plan.getDataCenterId());
 
                         if (predefined instanceof NetworkVO && guru instanceof NetworkGuruAdditionalFunctions) {
                             final NetworkGuruAdditionalFunctions functions = (NetworkGuruAdditionalFunctions) guru;
@@ -1227,14 +1233,15 @@ public Pair<NicProfile, Integer> allocateNic(final NicProfile requested, final N
         NicVO vo = checkForRaceAndAllocateNic(requested, network, isDefaultNic, deviceId, vm);
 
         final Integer networkRate = _networkModel.getNetworkRate(network.getId(), vm.getId());
+        vo.setNetworkRate(networkRate);
         final NicProfile vmNic = new NicProfile(vo, network, vo.getBroadcastUri(), vo.getIsolationUri(), networkRate, _networkModel.isSecurityGroupSupportedInNetwork(network),
                 _networkModel.getNetworkTag(vm.getHypervisorType(), network));
         if (vm.getType() == Type.DomainRouter) {
             Pair<NetworkVO, VpcVO> networks = getGuestNetworkRouterAndVpcDetails(vm.getId());
             setMtuDetailsInVRNic(networks, network, vo);
-            _nicDao.update(vo.getId(), vo);
             setMtuInVRNicProfile(networks, network.getTrafficType(), vmNic);
         }
+        _nicDao.update(vo.getId(), vo);
         return new Pair<>(vmNic, Integer.valueOf(deviceId));
     }
 
@@ -2300,6 +2307,8 @@ public NicProfile prepareNic(final VirtualMachineProfile vmProfile, final Deploy
             nic.setState(Nic.State.Reserved);
         }
 
+        nic.setNetworkRate(networkRate);
+
         if (vmProfile.getType() == Type.DomainRouter) {
             Pair<NetworkVO, VpcVO> networks = getGuestNetworkRouterAndVpcDetails(vmProfile.getId());
             setMtuDetailsInVRNic(networks, network, nic);
@@ -4962,6 +4971,8 @@ public NicVO doInTransaction(TransactionStatus status) {
         }
 
         final Integer networkRate = _networkModel.getNetworkRate(network.getId(), vm.getId());
+        vo.setNetworkRate(networkRate);
+        _nicDao.update(vo.getId(), vo);
         final NicProfile vmNic = new NicProfile(vo, network, vo.getBroadcastUri(), vo.getIsolationUri(), networkRate, _networkModel.isSecurityGroupSupportedInNetwork(network),
                 _networkModel.getNetworkTag(vm.getHypervisorType(), network));
 
@@ -5066,7 +5077,7 @@ public String getConfigComponentName() {
     @Override
     public ConfigKey<?>[] getConfigKeys() {
         return new ConfigKey<?>[]{NetworkGcWait, NetworkGcInterval, NetworkLockTimeout, DeniedRoutes,
-                GuestDomainSuffix, NetworkThrottlingRate, VmNetworkThrottlingRate, MinVRVersion, DhcpLeaseTimeout,
+                GuestDomainSuffix, NetworkThrottlingRate, VmNetworkThrottlingRate, VpcPublicNetworkThrottlingRate, MinVRVersion, DhcpLeaseTimeout,
                 PromiscuousMode, MacAddressChanges, ForgedTransmits, MacLearning, RollingRestartEnabled,
                 TUNGSTEN_ENABLED, NSX_ENABLED, NETRIS_ENABLED, NETWORK_LB_HAPROXY_MAX_CONN,
                 NETWORK_LB_HAPROXY_IDLE_TIMEOUT};

engine/schema/src/main/java/com/cloud/network/vpc/VpcOfferingVO.java

@@ -94,6 +94,9 @@ public class VpcOfferingVO implements VpcOffering {
     @Column(name = "conserve_mode")
     private boolean conserveMode;
 
+    @Column(name = "public_nw_rate")
+    private Integer publicNetworkRate;
+
     public VpcOfferingVO() {
         this.uuid = UUID.randomUUID().toString();
     }
@@ -254,4 +257,13 @@ public boolean isConserveMode() {
     public void setConserveMode(boolean conserveMode) {
         this.conserveMode = conserveMode;
     }
+
+    @Override
+    public Integer getPublicNetworkRate() {
+        return publicNetworkRate;
+    }
+
+    public void setPublicNetworkRate(Integer publicNetworkRate) {
+        this.publicNetworkRate = publicNetworkRate;
+    }
 }