Skip to content

Commit 2afc1b7

Browse files
Pearl1594Pearl1594
committed
Add support to clone existing offerings and update them
1 parent 5bf869c commit 2afc1b7

9 files changed

Lines changed: 961 additions & 0 deletions

File tree

‎api/src/main/java/com/cloud/configuration/ConfigurationService.java‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@
2424
import org.apache.cloudstack.api.ApiConstants;
2525
import org.apache.cloudstack.api.command.admin.config.ResetCfgCmd;
2626
import org.apache.cloudstack.api.command.admin.config.UpdateCfgCmd;
27+
import org.apache.cloudstack.api.command.admin.network.CloneNetworkOfferingCmd;
2728
import org.apache.cloudstack.api.command.admin.network.CreateGuestNetworkIpv6PrefixCmd;
2829
import org.apache.cloudstack.api.command.admin.network.CreateManagementNetworkIpRangeCmd;
2930
import org.apache.cloudstack.api.command.admin.network.CreateNetworkOfferingCmd;
@@ -33,6 +34,8 @@
3334
import org.apache.cloudstack.api.command.admin.network.ListGuestNetworkIpv6PrefixesCmd;
3435
import org.apache.cloudstack.api.command.admin.network.UpdateNetworkOfferingCmd;
3536
import org.apache.cloudstack.api.command.admin.network.UpdatePodManagementNetworkIpRangeCmd;
37+
import org.apache.cloudstack.api.command.admin.offering.CloneDiskOfferingCmd;
38+
import org.apache.cloudstack.api.command.admin.offering.CloneServiceOfferingCmd;
3639
import org.apache.cloudstack.api.command.admin.offering.CreateDiskOfferingCmd;
3740
import org.apache.cloudstack.api.command.admin.offering.CreateServiceOfferingCmd;
3841
import org.apache.cloudstack.api.command.admin.offering.DeleteDiskOfferingCmd;
@@ -105,6 +108,33 @@ public interface ConfigurationService {
105108
*/
106109
ServiceOffering createServiceOffering(CreateServiceOfferingCmd cmd);
107110

111+
/**
112+
* Clones a service offering with optional parameter overrides
113+
*
114+
* @param cmd
115+
* the command object that specifies the source offering ID and optional parameter overrides
116+
* @return the newly created service offering cloned from source, null otherwise
117+
*/
118+
ServiceOffering cloneServiceOffering(CloneServiceOfferingCmd cmd);
119+
120+
/**
121+
* Clones a disk offering with optional parameter overrides
122+
*
123+
* @param cmd
124+
* the command object that specifies the source offering ID and optional parameter overrides
125+
* @return the newly created disk offering cloned from source, null otherwise
126+
*/
127+
DiskOffering cloneDiskOffering(CloneDiskOfferingCmd cmd);
128+
129+
/**
130+
* Clones a network offering with optional parameter overrides
131+
*
132+
* @param cmd
133+
* the command object that specifies the source offering ID and optional parameter overrides
134+
* @return the newly created network offering cloned from source, null otherwise
135+
*/
136+
NetworkOffering cloneNetworkOffering(CloneNetworkOfferingCmd cmd);
137+
108138
/**
109139
* Updates a service offering
110140
*

‎api/src/main/java/com/cloud/event/EventTypes.java‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -374,6 +374,7 @@ public class EventTypes {
374374

375375
// Service Offerings
376376
public static final String EVENT_SERVICE_OFFERING_CREATE = "SERVICE.OFFERING.CREATE";
377+
public static final String EVENT_SERVICE_OFFERING_CLONE = "SERVICE.OFFERING.CLONE";
377378
public static final String EVENT_SERVICE_OFFERING_EDIT = "SERVICE.OFFERING.EDIT";
378379
public static final String EVENT_SERVICE_OFFERING_DELETE = "SERVICE.OFFERING.DELETE";
379380

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -552,6 +552,7 @@ public class ApiConstants {
552552
public static final String USE_STORAGE_REPLICATION = "usestoragereplication";
553553

554554
public static final String SOURCE_CIDR_LIST = "sourcecidrlist";
555+
public static final String SOURCE_OFFERING_ID = "sourceofferingid";
555556
public static final String SOURCE_ZONE_ID = "sourcezoneid";
556557
public static final String SSL_VERIFICATION = "sslverification";
557558
public static final String START_ASN = "startasn";

‎api/src/main/java/org/apache/cloudstack/api/command/admin/network/CloneNetworkOfferingCmd.java‎

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
// Licensed to the Apache Software Foundation (ASF) under one
2+
// or more contributor license agreements. See the NOTICE file
3+
// distributed with this work for additional information
4+
// regarding copyright ownership. The ASF licenses this file
5+
// to you under the Apache License, Version 2.0 (the
6+
// "License"); you may not use this file except in compliance
7+
// with the License. You may obtain a copy of the License at
8+
//
9+
// http://www.apache.org/licenses/LICENSE-2.0
10+
//
11+
// Unless required by applicable law or agreed to in writing,
12+
// software distributed under the License is distributed on an
13+
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14+
// KIND, either express or implied. See the License for the
15+
// specific language governing permissions and limitations
16+
// under the License.
17+
package org.apache.cloudstack.api.command.admin.network;
18+
19+
import java.util.List;
20+
21+
import org.apache.cloudstack.api.APICommand;
22+
import org.apache.cloudstack.api.ApiConstants;
23+
import org.apache.cloudstack.api.ApiErrorCode;
24+
import org.apache.cloudstack.api.BaseCmd;
25+
import org.apache.cloudstack.api.Parameter;
26+
import org.apache.cloudstack.api.ServerApiException;
27+
import org.apache.cloudstack.api.response.NetworkOfferingResponse;
28+
29+
import com.cloud.offering.NetworkOffering;
30+
31+
@APICommand(name = "cloneNetworkOffering",
32+
description = "Clones a network offering. All parameters are copied from the source offering unless explicitly overridden. " +
33+
"Use 'addServices' and 'dropServices' to modify the service list without respecifying everything.",
34+
responseObject = NetworkOfferingResponse.class,
35+
requestHasSensitiveInfo = false,
36+
responseHasSensitiveInfo = false,
37+
since = "4.23.0")
38+
public class CloneNetworkOfferingCmd extends CreateNetworkOfferingCmd {
39+
40+
/////////////////////////////////////////////////////
41+
//////////////// API parameters /////////////////////
42+
/////////////////////////////////////////////////////
43+
44+
@Parameter(name = ApiConstants.SOURCE_OFFERING_ID,
45+
type = BaseCmd.CommandType.UUID,
46+
entityType = NetworkOfferingResponse.class,
47+
required = true,
48+
description = "The ID of the network offering to clone")
49+
private Long sourceOfferingId;
50+
51+
@Parameter(name = "addservices",
52+
type = CommandType.LIST,
53+
collectionType = CommandType.STRING,
54+
description = "Services to add to the cloned offering (in addition to source offering services). " +
55+
"If specified along with 'supportedservices', this parameter is ignored.")
56+
private List<String> addServices;
57+
58+
@Parameter(name = "dropservices",
59+
type = CommandType.LIST,
60+
collectionType = CommandType.STRING,
61+
description = "Services to remove from the cloned offering (that exist in source offering). " +
62+
"If specified along with 'supportedservices', this parameter is ignored.")
63+
private List<String> dropServices;
64+
65+
/////////////////////////////////////////////////////
66+
/////////////////// Accessors ///////////////////////
67+
/////////////////////////////////////////////////////
68+
69+
public Long getSourceOfferingId() {
70+
return sourceOfferingId;
71+
}
72+
73+
public List<String> getAddServices() {
74+
return addServices;
75+
}
76+
77+
public List<String> getDropServices() {
78+
return dropServices;
79+
}
80+
81+
/////////////////////////////////////////////////////
82+
/////////////// API Implementation///////////////////
83+
/////////////////////////////////////////////////////
84+
85+
@Override
86+
public void execute() {
87+
NetworkOffering result = _configService.cloneNetworkOffering(this);
88+
if (result != null) {
89+
NetworkOfferingResponse response = _responseGenerator.createNetworkOfferingResponse(result);
90+
response.setResponseName(getCommandName());
91+
this.setResponseObject(response);
92+
} else {
93+
throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to clone network offering");
94+
}
95+
}
96+
}
97+

‎api/src/main/java/org/apache/cloudstack/api/command/admin/offering/CloneDiskOfferingCmd.java‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
// Licensed to the Apache Software Foundation (ASF) under one
2+
// or more contributor license agreements. See the NOTICE file
3+
// distributed with this work for additional information
4+
// regarding copyright ownership. The ASF licenses this file
5+
// to you under the Apache License, Version 2.0 (the
6+
// "License"); you may not use this file except in compliance
7+
// with the License. You may obtain a copy of the License at
8+
//
9+
// http://www.apache.org/licenses/LICENSE-2.0
10+
//
11+
// Unless required by applicable law or agreed to in writing,
12+
// software distributed under the License is distributed on an
13+
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14+
// KIND, either express or implied. See the License for the
15+
// specific language governing permissions and limitations
16+
// under the License.
17+
package org.apache.cloudstack.api.command.admin.offering;
18+
19+
import org.apache.cloudstack.api.APICommand;
20+
import org.apache.cloudstack.api.ApiConstants;
21+
import org.apache.cloudstack.api.ApiErrorCode;
22+
import org.apache.cloudstack.api.BaseCmd;
23+
import org.apache.cloudstack.api.Parameter;
24+
import org.apache.cloudstack.api.ServerApiException;
25+
import org.apache.cloudstack.api.response.DiskOfferingResponse;
26+
27+
import com.cloud.offering.DiskOffering;
28+
29+
@APICommand(name = "cloneDiskOffering",
30+
description = "Clones a disk offering. All parameters from createDiskOffering are available. If not specified, values will be copied from the source offering.",
31+
responseObject = DiskOfferingResponse.class,
32+
requestHasSensitiveInfo = false,
33+
responseHasSensitiveInfo = false,
34+
since = "4.23.0")
35+
public class CloneDiskOfferingCmd extends CreateDiskOfferingCmd {
36+
37+
/////////////////////////////////////////////////////
38+
//////////////// API parameters /////////////////////
39+
/////////////////////////////////////////////////////
40+
41+
@Parameter(name = ApiConstants.SOURCE_OFFERING_ID,
42+
type = BaseCmd.CommandType.UUID,
43+
entityType = DiskOfferingResponse.class,
44+
required = true,
45+
description = "The ID of the disk offering to clone")
46+
private Long sourceOfferingId;
47+
48+
/////////////////////////////////////////////////////
49+
/////////////////// Accessors ///////////////////////
50+
/////////////////////////////////////////////////////
51+
52+
public Long getSourceOfferingId() {
53+
return sourceOfferingId;
54+
}
55+
56+
/////////////////////////////////////////////////////
57+
/////////////// API Implementation///////////////////
58+
/////////////////////////////////////////////////////
59+
60+
@Override
61+
public void execute() {
62+
DiskOffering result = _configService.cloneDiskOffering(this);
63+
if (result != null) {
64+
DiskOfferingResponse response = _responseGenerator.createDiskOfferingResponse(result);
65+
response.setResponseName(getCommandName());
66+
this.setResponseObject(response);
67+
} else {
68+
throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to clone disk offering");
69+
}
70+
}
71+
}
72+

‎api/src/main/java/org/apache/cloudstack/api/command/admin/offering/CloneServiceOfferingCmd.java‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
// Licensed to the Apache Software Foundation (ASF) under one
2+
// or more contributor license agreements. See the NOTICE file
3+
// distributed with this work for additional information
4+
// regarding copyright ownership. The ASF licenses this file
5+
// to you under the Apache License, Version 2.0 (the
6+
// "License"); you may not use this file except in compliance
7+
// with the License. You may obtain a copy of the License at
8+
//
9+
// http://www.apache.org/licenses/LICENSE-2.0
10+
//
11+
// Unless required by applicable law or agreed to in writing,
12+
// software distributed under the License is distributed on an
13+
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14+
// KIND, either express or implied. See the License for the
15+
// specific language governing permissions and limitations
16+
// under the License.
17+
package org.apache.cloudstack.api.command.admin.offering;
18+
19+
import org.apache.cloudstack.api.APICommand;
20+
import org.apache.cloudstack.api.ApiConstants;
21+
import org.apache.cloudstack.api.ApiErrorCode;
22+
import org.apache.cloudstack.api.Parameter;
23+
import org.apache.cloudstack.api.ServerApiException;
24+
import org.apache.cloudstack.api.response.ServiceOfferingResponse;
25+
26+
import com.cloud.offering.ServiceOffering;
27+
28+
@APICommand(name = "cloneServiceOffering",
29+
description = "Clones a service offering. All parameters from createServiceOffering are available. If not specified, values will be copied from the source offering.",
30+
responseObject = ServiceOfferingResponse.class,
31+
requestHasSensitiveInfo = false,
32+
responseHasSensitiveInfo = false,
33+
since = "4.23.0")
34+
public class CloneServiceOfferingCmd extends CreateServiceOfferingCmd {
35+
36+
/////////////////////////////////////////////////////
37+
//////////////// API parameters /////////////////////
38+
/////////////////////////////////////////////////////
39+
40+
@Parameter(name = ApiConstants.SOURCE_OFFERING_ID,
41+
type = CommandType.UUID,
42+
entityType = ServiceOfferingResponse.class,
43+
required = true,
44+
description = "The ID of the service offering to clone")
45+
private Long sourceOfferingId;
46+
47+
/////////////////////////////////////////////////////
48+
/////////////////// Accessors ///////////////////////
49+
/////////////////////////////////////////////////////
50+
51+
public Long getSourceOfferingId() {
52+
return sourceOfferingId;
53+
}
54+
55+
/////////////////////////////////////////////////////
56+
/////////////// API Implementation///////////////////
57+
/////////////////////////////////////////////////////
58+
59+
60+
@Override
61+
public void execute() {
62+
ServiceOffering result = _configService.cloneServiceOffering(this);
63+
if (result != null) {
64+
ServiceOfferingResponse response = _responseGenerator.createServiceOfferingResponse(result);
65+
response.setResponseName(getCommandName());
66+
this.setResponseObject(response);
67+
} else {
68+
throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to clone service offering");
69+
}
70+
}
71+
}
72+

0 commit comments

Comments
 (0)