mirror of
https://github.com/apache/cloudstack.git
synced 2025-10-26 08:42:29 +01:00
5360ab3d43
Unable to register private template across all Zones - crosszones flag no longer works. This was because the code skipped the loop after the first download initiation. Introduced a set so that if it is already downloaded to the same zone then skip it for private template.
447 lines
22 KiB
Java
Executable File
447 lines
22 KiB
Java
Executable File
// 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.template;
|
|
|
|
import java.net.MalformedURLException;
|
|
import java.net.URL;
|
|
import java.util.Collections;
|
|
import java.util.HashSet;
|
|
import java.util.List;
|
|
import java.util.Set;
|
|
import java.util.concurrent.ExecutionException;
|
|
|
|
import javax.ejb.Local;
|
|
import javax.inject.Inject;
|
|
|
|
import org.apache.log4j.Logger;
|
|
|
|
import org.apache.cloudstack.api.command.user.iso.DeleteIsoCmd;
|
|
import org.apache.cloudstack.api.command.user.iso.RegisterIsoCmd;
|
|
import org.apache.cloudstack.api.command.user.template.DeleteTemplateCmd;
|
|
import org.apache.cloudstack.api.command.user.template.RegisterTemplateCmd;
|
|
import org.apache.cloudstack.engine.subsystem.api.storage.DataStore;
|
|
import org.apache.cloudstack.engine.subsystem.api.storage.DataStoreManager;
|
|
import org.apache.cloudstack.engine.subsystem.api.storage.EndPointSelector;
|
|
import org.apache.cloudstack.engine.subsystem.api.storage.Scope;
|
|
import org.apache.cloudstack.engine.subsystem.api.storage.TemplateDataFactory;
|
|
import org.apache.cloudstack.engine.subsystem.api.storage.TemplateInfo;
|
|
import org.apache.cloudstack.engine.subsystem.api.storage.TemplateService;
|
|
import org.apache.cloudstack.engine.subsystem.api.storage.TemplateService.TemplateApiResult;
|
|
import org.apache.cloudstack.engine.subsystem.api.storage.ZoneScope;
|
|
import org.apache.cloudstack.framework.async.AsyncCallFuture;
|
|
import org.apache.cloudstack.framework.async.AsyncCallbackDispatcher;
|
|
import org.apache.cloudstack.framework.async.AsyncCompletionCallback;
|
|
import org.apache.cloudstack.framework.async.AsyncRpcContext;
|
|
import org.apache.cloudstack.storage.datastore.db.TemplateDataStoreVO;
|
|
import org.apache.cloudstack.storage.image.datastore.ImageStoreEntity;
|
|
|
|
import com.cloud.agent.AgentManager;
|
|
import com.cloud.alert.AlertManager;
|
|
import com.cloud.configuration.Resource.ResourceType;
|
|
import com.cloud.dc.DataCenterVO;
|
|
import com.cloud.dc.dao.DataCenterDao;
|
|
import com.cloud.event.EventTypes;
|
|
import com.cloud.event.UsageEventUtils;
|
|
import com.cloud.exception.InvalidParameterValueException;
|
|
import com.cloud.exception.ResourceAllocationException;
|
|
import com.cloud.org.Grouping;
|
|
import com.cloud.storage.ScopeType;
|
|
import com.cloud.storage.Storage.ImageFormat;
|
|
import com.cloud.storage.Storage.TemplateType;
|
|
import com.cloud.storage.TemplateProfile;
|
|
import com.cloud.storage.VMTemplateStorageResourceAssoc.Status;
|
|
import com.cloud.storage.VMTemplateVO;
|
|
import com.cloud.storage.VMTemplateZoneVO;
|
|
import com.cloud.storage.dao.VMTemplateZoneDao;
|
|
import com.cloud.storage.download.DownloadMonitor;
|
|
import com.cloud.user.Account;
|
|
import com.cloud.utils.UriUtils;
|
|
import com.cloud.utils.db.DB;
|
|
import com.cloud.utils.exception.CloudRuntimeException;
|
|
|
|
@Local(value = TemplateAdapter.class)
|
|
public class HypervisorTemplateAdapter extends TemplateAdapterBase {
|
|
private final static Logger s_logger = Logger.getLogger(HypervisorTemplateAdapter.class);
|
|
@Inject
|
|
DownloadMonitor _downloadMonitor;
|
|
@Inject
|
|
AgentManager _agentMgr;
|
|
|
|
@Inject
|
|
DataStoreManager storeMgr;
|
|
@Inject
|
|
TemplateService imageService;
|
|
@Inject
|
|
TemplateDataFactory imageFactory;
|
|
@Inject
|
|
TemplateManager templateMgr;
|
|
@Inject
|
|
AlertManager alertMgr;
|
|
@Inject
|
|
VMTemplateZoneDao templateZoneDao;
|
|
@Inject
|
|
EndPointSelector _epSelector;
|
|
@Inject
|
|
DataCenterDao _dcDao;
|
|
|
|
@Override
|
|
public String getName() {
|
|
return TemplateAdapterType.Hypervisor.getName();
|
|
}
|
|
|
|
@Override
|
|
public TemplateProfile prepare(RegisterIsoCmd cmd) throws ResourceAllocationException {
|
|
TemplateProfile profile = super.prepare(cmd);
|
|
String url = profile.getUrl();
|
|
|
|
if ((!url.toLowerCase().endsWith("iso")) && (!url.toLowerCase().endsWith("iso.zip")) && (!url.toLowerCase().endsWith("iso.bz2")) &&
|
|
(!url.toLowerCase().endsWith("iso.gz"))) {
|
|
throw new InvalidParameterValueException("Please specify a valid iso");
|
|
}
|
|
|
|
UriUtils.validateUrl(url);
|
|
profile.setUrl(url);
|
|
// Check that the resource limit for secondary storage won't be exceeded
|
|
_resourceLimitMgr.checkResourceLimit(_accountMgr.getAccount(cmd.getEntityOwnerId()), ResourceType.secondary_storage, UriUtils.getRemoteSize(url));
|
|
return profile;
|
|
}
|
|
|
|
@Override
|
|
public TemplateProfile prepare(RegisterTemplateCmd cmd) throws ResourceAllocationException {
|
|
TemplateProfile profile = super.prepare(cmd);
|
|
String url = profile.getUrl();
|
|
String path = null;
|
|
try {
|
|
URL str = new URL(url);
|
|
path = str.getPath();
|
|
} catch (MalformedURLException ex) {
|
|
throw new InvalidParameterValueException("Please specify a valid URL. URL:" + url + " is invalid");
|
|
}
|
|
|
|
try {
|
|
checkFormat(cmd.getFormat(), url);
|
|
} catch (InvalidParameterValueException ex) {
|
|
checkFormat(cmd.getFormat(), path);
|
|
}
|
|
|
|
UriUtils.validateUrl(url);
|
|
profile.setUrl(url);
|
|
// Check that the resource limit for secondary storage won't be exceeded
|
|
_resourceLimitMgr.checkResourceLimit(_accountMgr.getAccount(cmd.getEntityOwnerId()), ResourceType.secondary_storage, UriUtils.getRemoteSize(url));
|
|
return profile;
|
|
}
|
|
|
|
private void checkFormat(String format, String url) {
|
|
if ((!url.toLowerCase().endsWith("vhd")) && (!url.toLowerCase().endsWith("vhd.zip")) && (!url.toLowerCase().endsWith("vhd.bz2")) &&
|
|
(!url.toLowerCase().endsWith("vhdx")) && (!url.toLowerCase().endsWith("vhdx.gz")) &&
|
|
(!url.toLowerCase().endsWith("vhdx.bz2")) && (!url.toLowerCase().endsWith("vhdx.zip")) &&
|
|
(!url.toLowerCase().endsWith("vhd.gz")) && (!url.toLowerCase().endsWith("qcow2")) && (!url.toLowerCase().endsWith("qcow2.zip")) &&
|
|
(!url.toLowerCase().endsWith("qcow2.bz2")) && (!url.toLowerCase().endsWith("qcow2.gz")) && (!url.toLowerCase().endsWith("ova")) &&
|
|
(!url.toLowerCase().endsWith("ova.zip")) && (!url.toLowerCase().endsWith("ova.bz2")) && (!url.toLowerCase().endsWith("ova.gz")) &&
|
|
(!url.toLowerCase().endsWith("tar")) && (!url.toLowerCase().endsWith("tar.zip")) && (!url.toLowerCase().endsWith("tar.bz2")) &&
|
|
(!url.toLowerCase().endsWith("tar.gz")) && (!url.toLowerCase().endsWith("vmdk")) && (!url.toLowerCase().endsWith("vmdk.gz")) &&
|
|
(!url.toLowerCase().endsWith("vmdk.zip")) && (!url.toLowerCase().endsWith("vmdk.bz2")) && (!url.toLowerCase().endsWith("img")) &&
|
|
(!url.toLowerCase().endsWith("img.gz")) && (!url.toLowerCase().endsWith("img.zip")) && (!url.toLowerCase().endsWith("img.bz2")) &&
|
|
(!url.toLowerCase().endsWith("raw")) && (!url.toLowerCase().endsWith("raw.gz")) && (!url.toLowerCase().endsWith("raw.bz2")) &&
|
|
(!url.toLowerCase().endsWith("raw.zip"))) {
|
|
throw new InvalidParameterValueException("Please specify a valid " + format.toLowerCase());
|
|
}
|
|
|
|
if ((format.equalsIgnoreCase("vhd")
|
|
&& (!url.toLowerCase().endsWith("vhd")
|
|
&& !url.toLowerCase().endsWith("vhd.zip")
|
|
&& !url.toLowerCase().endsWith("vhd.bz2")
|
|
&& !url.toLowerCase().endsWith("vhd.gz")))
|
|
|| (format.equalsIgnoreCase("vhdx")
|
|
&& (!url.toLowerCase().endsWith("vhdx")
|
|
&& !url.toLowerCase().endsWith("vhdx.zip")
|
|
&& !url.toLowerCase().endsWith("vhdx.bz2")
|
|
&& !url.toLowerCase().endsWith("vhdx.gz")))
|
|
|| (format.equalsIgnoreCase("qcow2")
|
|
&& (!url.toLowerCase().endsWith("qcow2")
|
|
&& !url.toLowerCase().endsWith("qcow2.zip")
|
|
&& !url.toLowerCase().endsWith("qcow2.bz2")
|
|
&& !url.toLowerCase().endsWith("qcow2.gz")))
|
|
|| (format.equalsIgnoreCase("ova")
|
|
&& (!url.toLowerCase().endsWith("ova")
|
|
&& !url.toLowerCase().endsWith("ova.zip")
|
|
&& !url.toLowerCase().endsWith("ova.bz2")
|
|
&& !url.toLowerCase().endsWith("ova.gz")))
|
|
|| (format.equalsIgnoreCase("tar")
|
|
&& (!url.toLowerCase().endsWith("tar")
|
|
&& !url.toLowerCase().endsWith("tar.zip")
|
|
&& !url.toLowerCase().endsWith("tar.bz2")
|
|
&& !url.toLowerCase().endsWith("tar.gz")))
|
|
|| (format.equalsIgnoreCase("raw")
|
|
&& (!url.toLowerCase().endsWith("img")
|
|
&& !url.toLowerCase().endsWith("img.zip")
|
|
&& !url.toLowerCase().endsWith("img.bz2")
|
|
&& !url.toLowerCase().endsWith("img.gz")
|
|
&& !url.toLowerCase().endsWith("raw")
|
|
&& !url.toLowerCase().endsWith("raw.bz2")
|
|
&& !url.toLowerCase().endsWith("raw.zip")
|
|
&& !url.toLowerCase().endsWith("raw.gz")))
|
|
|| (format.equalsIgnoreCase("vmdk")
|
|
&& (!url.toLowerCase().endsWith("vmdk")
|
|
&& !url.toLowerCase().endsWith("vmdk.zip")
|
|
&& !url.toLowerCase().endsWith("vmdk.bz2")
|
|
&& !url.toLowerCase().endsWith("vmdk.gz")))
|
|
) {
|
|
throw new InvalidParameterValueException("Please specify a valid URL. URL:" + url + " is an invalid for the format " + format.toLowerCase());
|
|
}
|
|
|
|
}
|
|
|
|
@Override
|
|
public VMTemplateVO create(TemplateProfile profile) {
|
|
// persist entry in vm_template, vm_template_details and template_zone_ref tables, not that entry at template_store_ref is not created here, and created in createTemplateAsync.
|
|
VMTemplateVO template = persistTemplate(profile);
|
|
|
|
if (template == null) {
|
|
throw new CloudRuntimeException("Unable to persist the template " + profile.getTemplate());
|
|
}
|
|
|
|
// find all eligible image stores for this zone scope
|
|
List<DataStore> imageStores = storeMgr.getImageStoresByScope(new ZoneScope(profile.getZoneId()));
|
|
if (imageStores == null || imageStores.size() == 0) {
|
|
throw new CloudRuntimeException("Unable to find image store to download template " + profile.getTemplate());
|
|
}
|
|
|
|
Set<Long> zoneSet = new HashSet<Long>();
|
|
Collections.shuffle(imageStores); // For private templates choose a random store. TODO - Have a better algorithm based on size, no. of objects, load etc.
|
|
for (DataStore imageStore : imageStores) {
|
|
// skip data stores for a disabled zone
|
|
Long zoneId = imageStore.getScope().getScopeId();
|
|
if (zoneId != null) {
|
|
DataCenterVO zone = _dcDao.findById(zoneId);
|
|
if (zone == null) {
|
|
s_logger.warn("Unable to find zone by id " + zoneId + ", so skip downloading template to its image store " + imageStore.getId());
|
|
continue;
|
|
}
|
|
|
|
// Check if zone is disabled
|
|
if (Grouping.AllocationState.Disabled == zone.getAllocationState()) {
|
|
s_logger.info("Zone " + zoneId + " is disabled, so skip downloading template to its image store " + imageStore.getId());
|
|
continue;
|
|
}
|
|
|
|
// We want to download private template to one of the image store in a zone
|
|
if(isPrivateTemplate(template) && zoneSet.contains(zoneId)){
|
|
continue;
|
|
}else {
|
|
zoneSet.add(zoneId);
|
|
}
|
|
|
|
}
|
|
|
|
TemplateInfo tmpl = imageFactory.getTemplate(template.getId(), imageStore);
|
|
CreateTemplateContext<TemplateApiResult> context = new CreateTemplateContext<TemplateApiResult>(null, tmpl);
|
|
AsyncCallbackDispatcher<HypervisorTemplateAdapter, TemplateApiResult> caller = AsyncCallbackDispatcher.create(this);
|
|
caller.setCallback(caller.getTarget().createTemplateAsyncCallBack(null, null));
|
|
caller.setContext(context);
|
|
imageService.createTemplateAsync(tmpl, imageStore, caller);
|
|
}
|
|
_resourceLimitMgr.incrementResourceCount(profile.getAccountId(), ResourceType.template);
|
|
|
|
return template;
|
|
}
|
|
|
|
private boolean isPrivateTemplate(VMTemplateVO template){
|
|
|
|
// if public OR featured OR system template
|
|
if(template.isPublicTemplate() || template.isFeatured() || template.getTemplateType() == TemplateType.SYSTEM)
|
|
return false;
|
|
else
|
|
return true;
|
|
}
|
|
|
|
private class CreateTemplateContext<T> extends AsyncRpcContext<T> {
|
|
final TemplateInfo template;
|
|
|
|
public CreateTemplateContext(AsyncCompletionCallback<T> callback, TemplateInfo template) {
|
|
super(callback);
|
|
this.template = template;
|
|
}
|
|
}
|
|
|
|
protected Void createTemplateAsyncCallBack(AsyncCallbackDispatcher<HypervisorTemplateAdapter, TemplateApiResult> callback,
|
|
CreateTemplateContext<TemplateApiResult> context) {
|
|
TemplateApiResult result = callback.getResult();
|
|
TemplateInfo template = context.template;
|
|
if (result.isSuccess()) {
|
|
VMTemplateVO tmplt = _tmpltDao.findById(template.getId());
|
|
long accountId = tmplt.getAccountId();
|
|
if (template.getSize() != null) {
|
|
// publish usage event
|
|
String etype = EventTypes.EVENT_TEMPLATE_CREATE;
|
|
if (tmplt.getFormat() == ImageFormat.ISO) {
|
|
etype = EventTypes.EVENT_ISO_CREATE;
|
|
}
|
|
// get physical size from template_store_ref table
|
|
long physicalSize = 0;
|
|
DataStore ds = template.getDataStore();
|
|
TemplateDataStoreVO tmpltStore = _tmpltStoreDao.findByStoreTemplate(ds.getId(), template.getId());
|
|
if (tmpltStore != null) {
|
|
physicalSize = tmpltStore.getPhysicalSize();
|
|
} else {
|
|
s_logger.warn("No entry found in template_store_ref for template id: " + template.getId() + " and image store id: " + ds.getId() +
|
|
" at the end of registering template!");
|
|
}
|
|
Scope dsScope = ds.getScope();
|
|
if (dsScope.getScopeType() == ScopeType.ZONE) {
|
|
if (dsScope.getScopeId() != null) {
|
|
UsageEventUtils.publishUsageEvent(etype, template.getAccountId(), dsScope.getScopeId(), template.getId(), template.getName(), null, null,
|
|
physicalSize, template.getSize(), VirtualMachineTemplate.class.getName(), template.getUuid());
|
|
} else {
|
|
s_logger.warn("Zone scope image store " + ds.getId() + " has a null scope id");
|
|
}
|
|
} else if (dsScope.getScopeType() == ScopeType.REGION) {
|
|
// publish usage event for region-wide image store using a -1 zoneId for 4.2, need to revisit post-4.2
|
|
UsageEventUtils.publishUsageEvent(etype, template.getAccountId(), -1, template.getId(), template.getName(), null, null, physicalSize,
|
|
template.getSize(), VirtualMachineTemplate.class.getName(), template.getUuid());
|
|
}
|
|
_resourceLimitMgr.incrementResourceCount(accountId, ResourceType.secondary_storage, template.getSize());
|
|
}
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
@Override
|
|
@DB
|
|
public boolean delete(TemplateProfile profile) {
|
|
boolean success = true;
|
|
|
|
VMTemplateVO template = profile.getTemplate();
|
|
|
|
// find all eligible image stores for this template
|
|
List<DataStore> imageStores = templateMgr.getImageStoreByTemplate(template.getId(), profile.getZoneId());
|
|
if (imageStores == null || imageStores.size() == 0) {
|
|
// already destroyed on image stores
|
|
s_logger.info("Unable to find image store still having template: " + template.getName() + ", so just mark the template removed");
|
|
} else {
|
|
// Make sure the template is downloaded to all found image stores
|
|
for (DataStore store : imageStores) {
|
|
long storeId = store.getId();
|
|
List<TemplateDataStoreVO> templateStores = _tmpltStoreDao.listByTemplateStore(template.getId(), storeId);
|
|
for (TemplateDataStoreVO templateStore : templateStores) {
|
|
if (templateStore.getDownloadState() == Status.DOWNLOAD_IN_PROGRESS) {
|
|
String errorMsg = "Please specify a template that is not currently being downloaded.";
|
|
s_logger.debug("Template: " + template.getName() + " is currently being downloaded to secondary storage host: " + store.getName() +
|
|
"; cant' delete it.");
|
|
throw new CloudRuntimeException(errorMsg);
|
|
}
|
|
}
|
|
}
|
|
|
|
String eventType = "";
|
|
if (template.getFormat().equals(ImageFormat.ISO)) {
|
|
eventType = EventTypes.EVENT_ISO_DELETE;
|
|
} else {
|
|
eventType = EventTypes.EVENT_TEMPLATE_DELETE;
|
|
}
|
|
|
|
for (DataStore imageStore : imageStores) {
|
|
// publish zone-wide usage event
|
|
Long sZoneId = ((ImageStoreEntity)imageStore).getDataCenterId();
|
|
if (sZoneId != null) {
|
|
UsageEventUtils.publishUsageEvent(eventType, template.getAccountId(), sZoneId, template.getId(), null, null, null);
|
|
}
|
|
|
|
s_logger.info("Delete template from image store: " + imageStore.getName());
|
|
AsyncCallFuture<TemplateApiResult> future = imageService.deleteTemplateAsync(imageFactory.getTemplate(template.getId(), imageStore));
|
|
try {
|
|
TemplateApiResult result = future.get();
|
|
success = result.isSuccess();
|
|
if (!success) {
|
|
s_logger.warn("Failed to delete the template " + template + " from the image store: " + imageStore.getName() + " due to: " + result.getResult());
|
|
break;
|
|
}
|
|
|
|
// remove from template_zone_ref
|
|
List<VMTemplateZoneVO> templateZones = templateZoneDao.listByZoneTemplate(sZoneId, template.getId());
|
|
if (templateZones != null) {
|
|
for (VMTemplateZoneVO templateZone : templateZones) {
|
|
templateZoneDao.remove(templateZone.getId());
|
|
}
|
|
}
|
|
} catch (InterruptedException e) {
|
|
s_logger.debug("delete template Failed", e);
|
|
throw new CloudRuntimeException("delete template Failed", e);
|
|
} catch (ExecutionException e) {
|
|
s_logger.debug("delete template Failed", e);
|
|
throw new CloudRuntimeException("delete template Failed", e);
|
|
}
|
|
}
|
|
}
|
|
if (success) {
|
|
// delete all cache entries for this template
|
|
List<TemplateInfo> cacheTmpls = imageFactory.listTemplateOnCache(template.getId());
|
|
for (TemplateInfo tmplOnCache : cacheTmpls) {
|
|
s_logger.info("Delete template from image cache store: " + tmplOnCache.getDataStore().getName());
|
|
tmplOnCache.delete();
|
|
}
|
|
|
|
// find all eligible image stores for this template
|
|
List<DataStore> iStores = templateMgr.getImageStoreByTemplate(template.getId(), null);
|
|
if (iStores == null || iStores.size() == 0) {
|
|
// Mark template as Inactive.
|
|
template.setState(VirtualMachineTemplate.State.Inactive);
|
|
_tmpltDao.update(template.getId(), template);
|
|
|
|
// Decrement the number of templates and total secondary storage
|
|
// space used by the account
|
|
Account account = _accountDao.findByIdIncludingRemoved(template.getAccountId());
|
|
_resourceLimitMgr.decrementResourceCount(template.getAccountId(), ResourceType.template);
|
|
_resourceLimitMgr.recalculateResourceCount(template.getAccountId(), account.getDomainId(), ResourceType.secondary_storage.getOrdinal());
|
|
|
|
}
|
|
}
|
|
return success;
|
|
|
|
}
|
|
|
|
@Override
|
|
public TemplateProfile prepareDelete(DeleteTemplateCmd cmd) {
|
|
TemplateProfile profile = super.prepareDelete(cmd);
|
|
VMTemplateVO template = profile.getTemplate();
|
|
Long zoneId = profile.getZoneId();
|
|
|
|
if (template.getTemplateType() == TemplateType.SYSTEM) {
|
|
throw new InvalidParameterValueException("The DomR template cannot be deleted.");
|
|
}
|
|
|
|
if (zoneId != null && (storeMgr.getImageStore(zoneId) == null)) {
|
|
throw new InvalidParameterValueException("Failed to find a secondary storage in the specified zone.");
|
|
}
|
|
|
|
return profile;
|
|
}
|
|
|
|
@Override
|
|
public TemplateProfile prepareDelete(DeleteIsoCmd cmd) {
|
|
TemplateProfile profile = super.prepareDelete(cmd);
|
|
Long zoneId = profile.getZoneId();
|
|
|
|
if (zoneId != null && (storeMgr.getImageStore(zoneId) == null)) {
|
|
throw new InvalidParameterValueException("Failed to find a secondary storage in the specified zone.");
|
|
}
|
|
|
|
return profile;
|
|
}
|
|
}
|