New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
CLOUDSTACK-10024: Network migration support #2259
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,155 @@ | ||
// 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 org.apache.cloudstack.api.command.admin.network; | ||
|
||
import org.apache.log4j.Logger; | ||
|
||
import org.apache.cloudstack.acl.SecurityChecker.AccessType; | ||
import org.apache.cloudstack.api.ACL; | ||
import org.apache.cloudstack.api.APICommand; | ||
import org.apache.cloudstack.api.ApiConstants; | ||
import org.apache.cloudstack.api.ApiErrorCode; | ||
import org.apache.cloudstack.api.BaseAsyncCmd; | ||
import org.apache.cloudstack.api.Parameter; | ||
import org.apache.cloudstack.api.ResponseObject.ResponseView; | ||
import org.apache.cloudstack.api.ServerApiException; | ||
import org.apache.cloudstack.api.response.NetworkOfferingResponse; | ||
import org.apache.cloudstack.api.response.NetworkResponse; | ||
import org.apache.cloudstack.context.CallContext; | ||
|
||
import com.cloud.event.EventTypes; | ||
import com.cloud.exception.InvalidParameterValueException; | ||
import com.cloud.network.Network; | ||
import com.cloud.offering.NetworkOffering; | ||
import com.cloud.user.Account; | ||
import com.cloud.user.User; | ||
|
||
@APICommand(name = "migrateNetwork", description = "moves a network to another physical network", responseObject = NetworkResponse.class, responseView = ResponseView.Restricted, entityType = {Network.class}, | ||
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false) | ||
public class MigrateNetworkCmd extends BaseAsyncCmd { | ||
public static final Logger s_logger = Logger.getLogger(MigrateNetworkCmd.class.getName()); | ||
|
||
private static final String s_name = "migratenetworkresponse"; | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Please follow recent API implementation patterns, see RoleCmd as an example. The API name and response names can be refactored. |
||
|
||
///////////////////////////////////////////////////// | ||
//////////////// API parameters ///////////////////// | ||
///////////////////////////////////////////////////// | ||
@ACL(accessType = AccessType.OperateEntry) | ||
@Parameter(name=ApiConstants.NETWORK_ID, type=CommandType.UUID, entityType = NetworkResponse.class, | ||
required=true, description="the ID of the network") | ||
protected Long id; | ||
|
||
@Parameter(name = ApiConstants.NETWORK_OFFERING_ID, type = CommandType.UUID, entityType = NetworkOfferingResponse.class, description = "network offering ID") | ||
private Long networkOfferingId; | ||
|
||
@Parameter(name = ApiConstants.RESUME, type = CommandType.BOOLEAN, description = "true if previous network migration cmd failed") | ||
private Boolean resume; | ||
|
||
///////////////////////////////////////////////////// | ||
/////////////////// Accessors /////////////////////// | ||
///////////////////////////////////////////////////// | ||
|
||
public Long getId() { | ||
return id; | ||
} | ||
|
||
public Long getNetworkOfferingId() { | ||
return networkOfferingId; | ||
} | ||
|
||
public Boolean getResume() { | ||
return resume != null ? resume : false; | ||
} | ||
|
||
///////////////////////////////////////////////////// | ||
/////////////// API Implementation/////////////////// | ||
///////////////////////////////////////////////////// | ||
|
||
@Override | ||
public String getCommandName() { | ||
return s_name; | ||
} | ||
|
||
@Override | ||
public long getEntityOwnerId() { | ||
Network network = _networkService.getNetwork(id); | ||
if (network == null) { | ||
throw new InvalidParameterValueException("Networkd id=" + id + " doesn't exist"); | ||
} else { | ||
return _networkService.getNetwork(id).getAccountId(); | ||
} | ||
} | ||
|
||
@Override | ||
public void execute() { | ||
User callerUser = _accountService.getActiveUser(CallContext.current().getCallingUserId()); | ||
Account callerAccount = _accountService.getActiveAccountById(callerUser.getAccountId()); | ||
Network network = _networkService.getNetwork(id); | ||
if (network == null) { | ||
throw new InvalidParameterValueException("Couldn't find network by id"); | ||
} | ||
|
||
Network result = | ||
_networkService.migrateGuestNetwork(getId(), getNetworkOfferingId(), callerAccount, callerUser, getResume()); | ||
|
||
if (result != null) { | ||
NetworkResponse response = _responseGenerator.createNetworkResponse(ResponseView.Restricted, result); | ||
response.setResponseName(getCommandName()); | ||
setResponseObject(response); | ||
} else { | ||
throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to update network"); | ||
} | ||
} | ||
|
||
@Override | ||
public String getEventDescription() { | ||
StringBuilder eventMsg = new StringBuilder("Migrating network: " + getId()); | ||
if (getNetworkOfferingId() != null) { | ||
Network network = _networkService.getNetwork(getId()); | ||
if (network == null) { | ||
throw new InvalidParameterValueException("Network id=" + id + " doesn't exist"); | ||
} | ||
if (network.getNetworkOfferingId() != getNetworkOfferingId()) { | ||
NetworkOffering oldOff = _entityMgr.findById(NetworkOffering.class, network.getNetworkOfferingId()); | ||
NetworkOffering newOff = _entityMgr.findById(NetworkOffering.class, getNetworkOfferingId()); | ||
if (newOff == null) { | ||
throw new InvalidParameterValueException("Network offering id supplied is invalid"); | ||
} | ||
|
||
eventMsg.append(". Original network offering id: " + oldOff.getUuid() + ", new network offering id: " + newOff.getUuid()); | ||
} | ||
} | ||
|
||
return eventMsg.toString(); | ||
} | ||
|
||
@Override | ||
public String getEventType() { | ||
return EventTypes.EVENT_NETWORK_MIGRATE; | ||
} | ||
|
||
@Override | ||
public String getSyncObjType() { | ||
return BaseAsyncCmd.networkSyncObject; | ||
} | ||
|
||
@Override | ||
public Long getSyncObjId() { | ||
return id; | ||
} | ||
|
||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,144 @@ | ||
// 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 org.apache.cloudstack.api.command.admin.network; | ||
|
||
import org.apache.cloudstack.acl.SecurityChecker; | ||
import org.apache.cloudstack.api.ACL; | ||
import org.apache.cloudstack.api.APICommand; | ||
import org.apache.cloudstack.api.ApiConstants; | ||
import org.apache.cloudstack.api.ApiErrorCode; | ||
import org.apache.cloudstack.api.BaseAsyncCmd; | ||
import org.apache.cloudstack.api.Parameter; | ||
import org.apache.cloudstack.api.ResponseObject; | ||
import org.apache.cloudstack.api.ServerApiException; | ||
import org.apache.cloudstack.api.response.VpcOfferingResponse; | ||
import org.apache.cloudstack.api.response.VpcResponse; | ||
import org.apache.cloudstack.context.CallContext; | ||
import org.apache.log4j.Logger; | ||
|
||
import java.util.HashMap; | ||
import java.util.Map; | ||
|
||
import com.cloud.event.EventTypes; | ||
import com.cloud.network.vpc.Vpc; | ||
import com.cloud.user.Account; | ||
import com.cloud.user.User; | ||
|
||
@APICommand(name = "migrateVPC", description = "moves a vpc to another physical network", responseObject = VpcResponse.class, responseView = ResponseObject.ResponseView.Restricted, entityType = {Vpc.class}, | ||
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. There is no default There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The API does no define a |
||
public class MigrateVPCCmd extends BaseAsyncCmd { | ||
public static final Logger s_logger = Logger.getLogger(MigrateVPCCmd.class.getName()); | ||
|
||
private static final String s_name = "migratevpcresponse"; | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Same as above, refactor to use APINAME etc patterns as used in recent APIs. |
||
|
||
///////////////////////////////////////////////////// | ||
//////////////// API parameters ///////////////////// | ||
///////////////////////////////////////////////////// | ||
@ACL(accessType = SecurityChecker.AccessType.OperateEntry) | ||
@Parameter(name= ApiConstants.VPC_ID, type=CommandType.UUID, entityType = VpcResponse.class, | ||
required=true, description = "the ID of the vpc") | ||
protected Long id; | ||
|
||
@Parameter(name = ApiConstants.VPC_OFF_ID, type = CommandType.UUID, entityType = VpcOfferingResponse.class, required=true, description = "vpc offering ID") | ||
private Long vpcOfferingId; | ||
|
||
@Parameter(name = ApiConstants.TIER_NETWORK_OFFERINGS, type = CommandType.MAP, description = "network offering ids for each network in the vpc. Example: tierNetworkOfferings[0].networkId=networkId1&tierNetworkOfferings[0].networkOfferingId=newNetworkofferingId1&tierNetworkOfferings[1].networkId=networkId2&tierNetworkOfferings[1].networkOfferingId=newNetworkofferingId2") | ||
private Map<Integer, HashMap<String, String>> tierNetworkOfferings; | ||
|
||
@Parameter(name = ApiConstants.RESUME, type = CommandType.BOOLEAN, description = "true if previous network migration cmd failed") | ||
private Boolean resume; | ||
|
||
///////////////////////////////////////////////////// | ||
/////////////////// Accessors /////////////////////// | ||
///////////////////////////////////////////////////// | ||
|
||
public Long getId() { | ||
return id; | ||
} | ||
|
||
public Long getVpcOfferingId() { | ||
return vpcOfferingId; | ||
} | ||
|
||
public Boolean getResume() { | ||
return resume == null ? false : resume; | ||
} | ||
|
||
public Map<String, String> getTierNetworkOfferings() { | ||
HashMap<String, String> flatMap = new HashMap<>(); | ||
|
||
if (tierNetworkOfferings == null) { | ||
return flatMap; | ||
} | ||
|
||
for (HashMap<String, String> map : tierNetworkOfferings.values()) { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. a putall could be used here. |
||
flatMap.put(map.get("networkid"), map.get("networkofferingid")); | ||
} | ||
|
||
return flatMap; | ||
} | ||
|
||
///////////////////////////////////////////////////// | ||
/////////////// API Implementation/////////////////// | ||
///////////////////////////////////////////////////// | ||
|
||
@Override | ||
public String getCommandName() { | ||
return s_name; | ||
} | ||
|
||
@Override | ||
public void execute() { | ||
User callerUser = _accountService.getActiveUser(CallContext.current().getCallingUserId()); | ||
Account callerAccount = _accountService.getActiveAccountById(callerUser.getAccountId()); | ||
|
||
Vpc result = | ||
_networkService.migrateVpcNetwork(getId(), getVpcOfferingId(), getTierNetworkOfferings(), callerAccount, callerUser, getResume()); | ||
|
||
if (result != null) { | ||
VpcResponse response = _responseGenerator.createVpcResponse(ResponseObject.ResponseView.Restricted, result); | ||
response.setResponseName(getCommandName()); | ||
setResponseObject(response); | ||
} else { | ||
throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to migrate vpc"); | ||
} | ||
} | ||
|
||
@Override | ||
public String getEventDescription() { return "Migrating vpc: " + getId() + " to new vpc offering (" + vpcOfferingId + ")"; } | ||
|
||
@Override | ||
public String getEventType() { | ||
return EventTypes.EVENT_NETWORK_MIGRATE; | ||
} | ||
|
||
@Override | ||
public String getSyncObjType() { | ||
return BaseAsyncCmd.networkSyncObject; | ||
} | ||
|
||
@Override | ||
public Long getSyncObjId() { | ||
return id; | ||
} | ||
|
||
@Override | ||
public long getEntityOwnerId() { | ||
return CallContext.current().getCallingAccount().getId(); | ||
} | ||
|
||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There is no default
authorized
defined, please fix.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The API does no define a
since
as well.