| // 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.configuration; |
| |
| import java.util.List; |
| import java.util.Map; |
| import java.util.Set; |
| |
| import com.cloud.dc.VlanVO; |
| import org.apache.cloudstack.framework.config.ConfigKey; |
| import org.apache.cloudstack.framework.config.impl.ConfigurationSubGroupVO; |
| |
| import com.cloud.dc.ClusterVO; |
| import com.cloud.dc.DataCenter; |
| import com.cloud.dc.DataCenter.NetworkType; |
| import com.cloud.dc.DataCenterVO; |
| import com.cloud.dc.HostPodVO; |
| import com.cloud.dc.Pod; |
| import com.cloud.dc.Vlan; |
| import com.cloud.domain.Domain; |
| import com.cloud.exception.ConcurrentOperationException; |
| import com.cloud.exception.InsufficientCapacityException; |
| import com.cloud.exception.InvalidParameterValueException; |
| import com.cloud.network.Network; |
| import com.cloud.network.Network.Capability; |
| import com.cloud.network.Network.Provider; |
| import com.cloud.network.Network.Service; |
| import com.cloud.network.Networks.TrafficType; |
| import com.cloud.offering.DiskOffering; |
| import com.cloud.offering.NetworkOffering; |
| import com.cloud.offering.NetworkOffering.Availability; |
| import com.cloud.offerings.NetworkOfferingVO; |
| import com.cloud.org.Grouping.AllocationState; |
| import com.cloud.user.Account; |
| import com.cloud.utils.Pair; |
| import com.cloud.utils.net.NetUtils; |
| |
| /** |
| * ConfigurationManager handles adding pods/zones, changing IP ranges, enabling external firewalls, and editing |
| * configuration values |
| * |
| */ |
| public interface ConfigurationManager { |
| |
| String MESSAGE_CREATE_POD_IP_RANGE_EVENT = "Message.CreatePodIpRange.Event"; |
| String MESSAGE_DELETE_POD_IP_RANGE_EVENT = "Message.DeletePodIpRange.Event"; |
| String MESSAGE_CREATE_VLAN_IP_RANGE_EVENT = "Message.CreateVlanIpRange.Event"; |
| String MESSAGE_DELETE_VLAN_IP_RANGE_EVENT = "Message.DeleteVlanIpRange.Event"; |
| |
| public static final ConfigKey<Boolean> AllowNonRFC1918CompliantIPs = new ConfigKey<>(Boolean.class, |
| "allow.non.rfc1918.compliant.ips", "Advanced", "false", |
| "Allows non-compliant RFC 1918 IPs for Shared, Isolated networks and VPCs", true, null); |
| |
| ConfigKey<Float> HostCapacityTypeCpuMemoryWeight = new ConfigKey<>(ConfigKey.CATEGORY_ADVANCED, Float.class, |
| "host.capacityType.to.order.clusters.cputomemoryweight", |
| "0.5", |
| "Weight for CPU (as a value between 0 and 1) applied to compute capacity for Pods, Clusters and Hosts for COMBINED capacityType for ordering. Weight for RAM will be (1 - weight of CPU)", |
| true, ConfigKey.Scope.Global); |
| |
| /** |
| * Is this for a VPC |
| * @param offering the offering to check |
| * @return true or false |
| */ |
| boolean isOfferingForVpc(NetworkOffering offering); |
| |
| Integer getNetworkOfferingNetworkRate(long networkOfferingId, Long dataCenterId); |
| |
| Integer getServiceOfferingNetworkRate(long serviceOfferingId, Long dataCenterId); |
| |
| /** |
| * Updates a configuration entry with a new value |
| */ |
| String updateConfiguration(long userId, String name, String category, String value, ConfigKey.Scope scope, Long id); |
| |
| /** |
| * Creates a new pod |
| * @param skipGatewayOverlapCheck (true if it is ok to not validate that gateway IP address overlap with Start/End IP of the POD) |
| * @return Pod |
| */ |
| HostPodVO createPod(long userId, String podName, DataCenter zone, String gateway, String cidr, String startIp, String endIp, String allocationState, |
| boolean skipGatewayOverlapCheck, List<String> storageAccessGroups); |
| |
| /** |
| * Creates a new zone |
| * @param userId |
| * @param zoneName |
| * @param dns1 |
| * @param dns2 |
| * @param internalDns1 |
| * @param internalDns2 |
| * @param guestCidr |
| * @param domain |
| * @param domainId |
| * @param zoneType |
| * @param allocationState |
| * @param networkDomain |
| * @param isSecurityGroupEnabled |
| * @param isLocalStorageEnabled |
| * @param ip6Dns1 |
| * @param ip6Dns2 |
| * @param isEdge |
| * @param storageAccessGroups |
| * @return |
| */ |
| DataCenterVO createZone(long userId, String zoneName, String dns1, String dns2, String internalDns1, String internalDns2, String guestCidr, String domain, |
| Long domainId, NetworkType zoneType, String allocationState, String networkDomain, boolean isSecurityGroupEnabled, boolean isLocalStorageEnabled, String ip6Dns1, |
| String ip6Dns2, boolean isEdge, List<String> storageAccessGroups); |
| |
| /** |
| * Deletes a VLAN from the database, along with all of its IP addresses. Will not delete VLANs that have allocated |
| * IP addresses. |
| * |
| * @param caller TODO |
| * @return success/failure |
| */ |
| VlanVO deleteVlanAndPublicIpRange(long userId, long vlanDbId, Account caller); |
| |
| void checkZoneAccess(Account caller, DataCenter zone); |
| |
| void checkDiskOfferingAccess(Account caller, DiskOffering dof, DataCenter zone); |
| |
| /** |
| * Creates a new network offering |
| * @param name |
| * @param displayText |
| * @param trafficType |
| * @param tags |
| * @param specifyVlan |
| * @param availability |
| * @param networkRate |
| * @param serviceProviderMap |
| * @param isDefault |
| * @param type |
| * @param systemOnly |
| * @param serviceOfferingId |
| * @param conserveMode |
| * @param serviceCapabilityMap |
| * @param specifyIpRanges |
| * @param isPersistent |
| * @param details |
| * @param egressDefaultPolicy |
| * @param maxconn |
| * @param enableKeepAlive |
| * @param forVpc |
| * @param forTungsten |
| * @param forNsx |
| * @param forNetris |
| * @param networkMode |
| * @param domainIds |
| * @param zoneIds |
| * @param enableOffering |
| * @param internetProtocol |
| * @param routingMode |
| * @param specifyAsNumber |
| * @return the network offering |
| */ |
| NetworkOfferingVO createNetworkOffering(String name, String displayText, TrafficType trafficType, String tags, boolean specifyVlan, Availability availability, |
| Integer networkRate, Map<Service, Set<Provider>> serviceProviderMap, boolean isDefault, Network.GuestType type, boolean systemOnly, Long serviceOfferingId, |
| boolean conserveMode, Map<Service, Map<Capability, String>> serviceCapabilityMap, boolean specifyIpRanges, boolean isPersistent, |
| Map<NetworkOffering.Detail, String> details, boolean egressDefaultPolicy, Integer maxconn, boolean enableKeepAlive, Boolean forVpc, |
| Boolean forTungsten, boolean forNsx, boolean forNetris, NetworkOffering.NetworkMode networkMode, List<Long> domainIds, List<Long> zoneIds, boolean enableOffering, final NetUtils.InternetProtocol internetProtocol, |
| NetworkOffering.RoutingMode routingMode, boolean specifyAsNumber); |
| |
| Vlan createVlanAndPublicIpRange(long zoneId, long networkId, long physicalNetworkId, boolean forVirtualNetwork, boolean forSystemVms, Long podId, String startIP, String endIP, |
| String vlanGateway, String vlanNetmask, String vlanId, boolean bypassVlanOverlapCheck, Domain domain, Account vlanOwner, String startIPv6, String endIPv6, String vlanIp6Gateway, String vlanIp6Cidr, Provider provider) |
| throws InsufficientCapacityException, ConcurrentOperationException, InvalidParameterValueException; |
| |
| void createDefaultSystemNetworks(long zoneId) throws ConcurrentOperationException; |
| |
| /** |
| * Release dedicated virtual ip ranges of a domain. |
| * |
| * @return success/failure |
| */ |
| boolean releaseDomainSpecificVirtualRanges(Domain domain); |
| |
| /** |
| * Release dedicated virtual ip ranges of an account. |
| * |
| * @return success/failure |
| */ |
| boolean releaseAccountSpecificVirtualRanges(Account account); |
| |
| /** |
| * Edits a pod in the database. Will not allow you to edit pods that are being used anywhere in the system. |
| * |
| * @return Pod |
| */ |
| Pod editPod(long id, String name, String startIp, String endIp, String gateway, String netmask, String allocationState); |
| |
| void checkPodCidrSubnets(long zoneId, Long podIdToBeSkipped, String cidr); |
| |
| AllocationState findPodAllocationState(HostPodVO pod); |
| |
| AllocationState findClusterAllocationState(ClusterVO cluster); |
| |
| String getConfigurationType(String configName); |
| |
| Pair<String, String> getConfigurationGroupAndSubGroup(String configName); |
| |
| List<ConfigurationSubGroupVO> getConfigurationSubGroups(Long groupId); |
| |
| void validateExtraConfigInServiceOfferingDetail(String detailName); |
| } |
