| // 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.capacity; | |
| import java.util.List; | |
| import org.apache.cloudstack.framework.config.ConfigKey; | |
| import org.apache.cloudstack.storage.datastore.db.StoragePoolVO; | |
| import com.cloud.host.Host; | |
| import com.cloud.offering.ServiceOffering; | |
| import com.cloud.storage.VMTemplateVO; | |
| import com.cloud.utils.Pair; | |
| import com.cloud.vm.VirtualMachine; | |
| /** | |
| * Capacity Manager manages the different capacities | |
| * available within the Cloud Stack. | |
| * | |
| */ | |
| public interface CapacityManager { | |
| static final String CpuOverprovisioningFactorCK = "cpu.overprovisioning.factor"; | |
| static final String MemOverprovisioningFactorCK = "mem.overprovisioning.factor"; | |
| static final String StorageCapacityDisableThresholdCK = "pool.storage.capacity.disablethreshold"; | |
| static final String StorageOverprovisioningFactorCK = "storage.overprovisioning.factor"; | |
| static final String StorageAllocatedCapacityDisableThresholdCK = "pool.storage.allocated.capacity.disablethreshold"; | |
| static final String StorageAllocatedCapacityDisableThresholdForVolumeResizeCK = "pool.storage.allocated.resize.capacity.disablethreshold"; | |
| static final ConfigKey<Float> CpuOverprovisioningFactor = | |
| new ConfigKey<>( | |
| Float.class, | |
| CpuOverprovisioningFactorCK, | |
| ConfigKey.CATEGORY_ADVANCED, | |
| "1.0", | |
| "Used for CPU overprovisioning calculation; available CPU will be (actualCpuCapacity * cpu.overprovisioning.factor)", | |
| true, | |
| ConfigKey.Scope.Cluster, | |
| null); | |
| static final ConfigKey<Float> MemOverprovisioningFactor = | |
| new ConfigKey<>( | |
| Float.class, | |
| MemOverprovisioningFactorCK, | |
| ConfigKey.CATEGORY_ADVANCED, | |
| "1.0", | |
| "Used for memory overprovisioning calculation", | |
| true, | |
| ConfigKey.Scope.Cluster, | |
| null); | |
| static final ConfigKey<Double> StorageCapacityDisableThreshold = | |
| new ConfigKey<>( | |
| ConfigKey.CATEGORY_ALERT, | |
| Double.class, | |
| StorageCapacityDisableThresholdCK, | |
| "0.85", | |
| "Percentage (as a value between 0 and 1) of storage utilization above which allocators will disable using the pool for low storage available.", | |
| true, | |
| List.of(ConfigKey.Scope.StoragePool, ConfigKey.Scope.Zone)); | |
| static final ConfigKey<Double> StorageOverprovisioningFactor = | |
| new ConfigKey<>( | |
| "Storage", | |
| Double.class, | |
| StorageOverprovisioningFactorCK, | |
| "2", | |
| "Used for storage overprovisioning calculation; available storage will be (actualStorageSize * storage.overprovisioning.factor)", | |
| true, | |
| ConfigKey.Scope.StoragePool); | |
| static final ConfigKey<Double> StorageAllocatedCapacityDisableThreshold = | |
| new ConfigKey<>( | |
| ConfigKey.CATEGORY_ALERT, | |
| Double.class, | |
| StorageAllocatedCapacityDisableThresholdCK, | |
| "0.85", | |
| "Percentage (as a value between 0 and 1) of allocated storage utilization above which allocators will disable using the pool for low allocated storage available.", | |
| true, | |
| List.of(ConfigKey.Scope.StoragePool, ConfigKey.Scope.Zone)); | |
| static final ConfigKey<Boolean> StorageOperationsExcludeCluster = | |
| new ConfigKey<>( | |
| Boolean.class, | |
| "cluster.storage.operations.exclude", | |
| ConfigKey.CATEGORY_ADVANCED, | |
| "false", | |
| "Exclude cluster from storage operations", | |
| true, | |
| ConfigKey.Scope.Cluster, | |
| null); | |
| static final ConfigKey<String> ImageStoreNFSVersion = | |
| new ConfigKey<>( | |
| String.class, | |
| "secstorage.nfs.version", | |
| ConfigKey.CATEGORY_ADVANCED, | |
| null, | |
| "Enforces specific NFS version when mounting Secondary Storage. If NULL default selection is performed", | |
| true, | |
| ConfigKey.Scope.ImageStore, | |
| null); | |
| static final ConfigKey<Float> SecondaryStorageCapacityThreshold = | |
| new ConfigKey<>( | |
| ConfigKey.CATEGORY_ADVANCED, | |
| Float.class, | |
| "secondary.storage.capacity.threshold", | |
| "0.90", | |
| "Percentage (as a value between 0 and 1) of secondary storage capacity threshold.", | |
| true); | |
| static final ConfigKey<Double> StorageAllocatedCapacityDisableThresholdForVolumeSize = | |
| new ConfigKey<>( | |
| ConfigKey.CATEGORY_ALERT, | |
| Double.class, | |
| StorageAllocatedCapacityDisableThresholdForVolumeResizeCK, | |
| "0.90", | |
| "Percentage (as a value between 0 and 1) of allocated storage utilization above which allocators will disable using the pool for volume resize. " + | |
| "This is applicable only when volume.resize.allowed.beyond.allocation is set to true.", | |
| true, | |
| List.of(ConfigKey.Scope.StoragePool, ConfigKey.Scope.Zone)); | |
| ConfigKey<Integer> CapacityCalculateWorkers = new ConfigKey<>(ConfigKey.CATEGORY_ADVANCED, Integer.class, | |
| "capacity.calculate.workers", "1", | |
| "Number of worker threads to be used for capacities calculation", true); | |
| public boolean releaseVmCapacity(VirtualMachine vm, boolean moveFromReserved, boolean moveToReservered, Long hostId); | |
| void allocateVmCapacity(VirtualMachine vm, boolean fromLastHost); | |
| /** | |
| * @param hostId Id of the host to check capacity | |
| * @param cpu required CPU | |
| * @param ram required RAM | |
| * @param cpuOverprovisioningFactor factor to apply to the actual host cpu | |
| */ | |
| boolean checkIfHostHasCapacity(Host host, Integer cpu, long ram, boolean checkFromReservedCapacity, float cpuOverprovisioningFactor, float memoryOvercommitRatio, | |
| boolean considerReservedCapacity); | |
| void updateCapacityForHost(Host host); | |
| /** | |
| * @param pool storage pool | |
| * @param templateForVmCreation template that will be used for vm creation | |
| * @return total allocated capacity for the storage pool | |
| */ | |
| long getAllocatedPoolCapacity(StoragePoolVO pool, VMTemplateVO templateForVmCreation); | |
| /** | |
| * Check if specified host's running VM count has reach hypervisor limit | |
| * @param host the host to be checked | |
| * @return true if the count of host's running VMs >= hypervisor limit | |
| */ | |
| boolean checkIfHostReachMaxGuestLimit(Host host); | |
| /** | |
| * Check if specified host has capability to support cpu cores and speed freq | |
| * @param host the host to be checked | |
| * @param cpuNum cpu number to check | |
| * @param cpuSpeed cpu Speed to check | |
| * @return true if the count of host's running VMs >= hypervisor limit | |
| */ | |
| boolean checkIfHostHasCpuCapability(Host host, Integer cpuNum, Integer cpuSpeed); | |
| /** | |
| * Check if cluster will cross threshold if the cpu/memory requested are accommodated | |
| * @param clusterId the clusterId to check | |
| * @param cpuRequested cpu requested | |
| * @param ramRequested cpu requested | |
| * @return true if the customer crosses threshold, false otherwise | |
| */ | |
| boolean checkIfClusterCrossesThreshold(Long clusterId, Integer cpuRequested, long ramRequested); | |
| float getClusterOverProvisioningFactor(Long clusterId, short capacityType); | |
| long getUsedBytes(StoragePoolVO pool); | |
| long getUsedIops(StoragePoolVO pool); | |
| Pair<Boolean, Boolean> checkIfHostHasCpuCapabilityAndCapacity(Host host, ServiceOffering offering, boolean considerReservedCapacity); | |
| } |