2 * ============LICENSE_START=======================================================
4 * ================================================================================
5 * Copyright (C) 2017-2018 AT&T Intellectual Property. All rights reserved.
6 * ================================================================================
7 * Copyright (C) 2017 Amdocs
8 * ================================================================================
9 * Modifications Copyright (C) 2018 Orange
10 * =============================================================================
11 * Licensed under the Apache License, Version 2.0 (the "License");
12 * you may not use this file except in compliance with the License.
13 * You may obtain a copy of the License at
15 * http://www.apache.org/licenses/LICENSE-2.0
17 * Unless required by applicable law or agreed to in writing, software
18 * distributed under the License is distributed on an "AS IS" BASIS,
19 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
20 * See the License for the specific language governing permissions and
21 * limitations under the License.
23 * ECOMP is a trademark and service mark of AT&T Intellectual Property.
24 * ============LICENSE_END=========================================================
28 * Yang model for the Application Controller (APP-C) component of ECOMP
30 * This model is used to define the data and services of the Application Controller
31 * component of ECOMP. The APP-C controller initiates the processing of directed
32 * graphs, which define the actual process implementations used. The name of the
33 * directed graph is set by properties and cannot be changed dynamically.
35 * The services exposed by this provider are:
38 * Used to request a restart of a virtual network function (a VM).
41 * Used to request a rebuild of a virtual network function (a VM).
45 module appc-provider-lcm {
48 namespace "org:onap:appc:lcm";
49 prefix appc-provider-lcm;
52 "Defines the services and request/response requirements for the ECOMP APP-C component.";
55 * Note, the revision changes the package name of the generated java code. Do not
56 * change the revision unless you also update all references to the bindings.
58 revision "2016-01-08" {
60 "APP-C interface version 1.0.48";
63 /**********************************************************************************
64 * Data type definitions
66 * The following data type definitions are used to define common data structures,
67 * define constraints, or to impart special meanings to data objects related to the
68 * APP-C controller functions.
69 **********************************************************************************/
72 description "Define a common definition of a time stamp (expressed as a formatted
73 string) as follows yyyy-MM-ddTHH:mm:ss.SSSSSSSSZ";
76 pattern "[0-9]{4}-[0-9]{1,2}-[0-9]{1,2}T[0-9]{1,2}:[0-9]{1,2}:[0-9]{1,2}.[0-9]{1,6}Z";
82 description "The payload can be any valid JSON string value. Json escape characters need to be added when required to include an inner json within the payload to make it a valid json string value";
98 enum "SoftwareUpload";
107 enum "ConfigScaleOut";
108 enum "ConfigRestore";
110 enum "ConfigBackupDelete";
112 enum "StopApplication";
113 enum "StartApplication";
114 enum "QuiesceTraffic";
115 enum "ResumeTraffic";
116 enum "UpgradePreCheck";
117 enum "UpgradeSoftware";
118 enum "UpgradePostCheck";
119 enum "UpgradeBackup";
120 enum "UpgradeBackout";
126 enum "DistributeTraffic";
129 description "The action to be taken by APP-C, e.g. Restart, Rebuild, Migrate";
133 description "The state of a VM";
143 description "The status of a VM";
152 /**********************************************************************************
153 * Basic manipulation of a VNF (or VM) will typically include querying the current
154 * state, restarting, rebuilding, stopping, starting, etc. In all of these basic
155 * "state"-type operations, the services require the identification of the VNF to
156 * be operated on, and the region or LCP that contains that resource. This
157 * information is used across all of these services, so it has been defined as a
158 * common structure here and is referenced in the appropriate RPC definitions.
159 **********************************************************************************/
162 /**********************************************************************************
163 * All requests will include this standard header
165 * The standard request header is used to define a correlation identification for
166 * the request that is returned on all responses. This correlation identifier
167 * (called the service-request-id) is meaningful to the caller and is included on
168 * all responses from the services.
169 **********************************************************************************/
171 /**********************************************************************************
172 * All responses will include this standard header
174 * The standard response header includes the time of completion as well as a
175 * success|failure indication
176 **********************************************************************************/
178 grouping common-header {
179 description "A common header for all APP-C requests";
180 container common-header {
181 description "A common header for all APP-C requests";
183 description "timestamp is in ISO 8601 timestamp format ZULU offset";
189 description "api-ver is the API version identifier. A given release of APPC
190 should support all previous versions of APPC API (correlate with
191 general requirements)";
193 pattern "[2]\.\d\d" {
194 error-message "API Version 2.XX is supported at this end point";
201 description "originator-id an identifier of the calling system which can be
202 used addressing purposes, i.e. returning asynchronous response
203 to the proper destination over DMaaP (especially in case of multiple
204 consumers of APP-C APIs)";
210 description "UUID for the request ID. An OSS/BSS identifier for the request
211 that caused the current action. Multiple API calls may be made
212 with the same request-id The request-id shall be recorded throughout
213 the operations on a single request";
218 leaf sub-request-id {
219 description "Uniquely identifies a specific LCM action. It is persistent over
220 the life-cycle of a single request";
226 /**********************************************************************************
227 * Flags are generic flags that apply to any and all commands, all are optional
228 * force = TRUE/FALSE - Execute command even if target is in unstable (i.e. locked, transiting, etc)
229 * state. Specific behaviour of forced commands varies, but implies cancellation
230 * of previous command and an override by the new command. The FALSE value is
232 * ttl = <0....N> - The timeout value for command execution, expressed in seconds
233 * mode = EXCLUSIVE/NORMAL - defines execution mode as follows:
234 * - EXCLUSIVE ? on encountering an exclusive command, the APP-C will:
235 * * Cease accepting additional command requests
236 * * Complete execution of outstanding commands
237 * * Execute the exclusive command to completion
238 * * Optionally report the result of the command
239 * * Optionally resume command acceptance and processing
240 * - NORMAL - Obverse of EXCLUSIVE, the default one.
241 **********************************************************************************/
243 description "Flags are generic flags that apply to any and all commands, all are optional";
249 description "EXCLUSIVE (accept no queued requests on this VNF while processing)
250 or NORMAL (queue other requests until complete)";
258 description "TRUE/FALSE - Execute action even if target is in unstable (i.e.
259 locked, transiting, etc.) state";
263 description "<0....N> -Â The timeout value (expressed in seconds) for action
264 execution, between action being received by APPC and action initiation";
273 grouping action-identifiers {
274 description "A block containing the action arguments. These are used to specify
275 the object upon which APP-C LCM command is to operate";
276 container action-identifiers {
277 description "A block containing the action arguments. These are used to specify
278 the object upon which APP-C LCM command is to operate";
279 leaf service-instance-id {
280 description "identifies a specific service the command refers to. When multiple
281 APP-C instances are used and applied to a subset of services,
282 this will become significant . The field is mandatory when the
288 description "identifies the VNF to which this action is to be applied(vnf-id
289 uniquely identifies the service-instance referred to). Note that
290 some actions are applied to multiple VNFs in the same service.
291 When this is the case, vnf-id may be left out, but service-instance-id
292 must appear. The field is mandatory when service-instance-id is
298 description "identifies the VF module to which this action is to be applied.";
303 description "identifies the VNFC to which this action is to be applied. Some
304 actions apply only to a component within a VNF (e.g. RESTART is
305 sometimes applied to on VM only). In such a case, the name of
306 the VNFC is used to search for the component within the VNF";
311 description "identifies a specific VM within the given service/vnf to which
312 this action is to be applied";
321 description "The specific response codes are to be aligned with SDC reference doc
322 (main table removed to avoid duplication and digression from main table).
323 See SDC and ECOMP Distribution Consumer Interface Agreement";
325 description "The specific response codes are to be aligned with SDC reference doc
326 (main table removed to avoid duplication and digression from main table).
327 See SDC and ECOMP Distribution Consumer Interface Agreement";
329 description "Response code";
334 description "Response message";
341 typedef lcm-action-status {
348 enum "MULTIPLE_REQUESTS_FOUND";
350 description "The status of the requested LCM action";
353 /**********************************************************************************
354 * Define the restart service
355 **********************************************************************************/
357 description "An operation to restart a virtual network function (or VM)";
364 uses action-identifiers;
376 /**********************************************************************************
377 * Define the rebuild service
378 **********************************************************************************/
380 description "An operation to rebuild a virtual network function (or VM)";
387 uses action-identifiers;
399 /**********************************************************************************
400 * Define the migrate service
401 **********************************************************************************/
403 description "An operation to migrate a virtual network function (or VM)";
410 uses action-identifiers;
422 /**********************************************************************************
423 * Define the evacuate service
424 **********************************************************************************/
426 description "An operation to evacuate a virtual network function (or VM)";
433 uses action-identifiers;
445 /**********************************************************************************
446 * Define the snapshot service
447 **********************************************************************************/
449 description "An operation to create a snapshot of a virtual network function (or VM)";
456 uses action-identifiers;
474 /**********************************************************************************
475 * Define the VNF quiesce traffic service
476 **********************************************************************************/
477 rpc quiesce-traffic {
478 description "An operation to stop traffic gracefully on the VF.
479 It stops traffic gracefully without stopping the application";
486 uses action-identifiers;
498 /**********************************************************************************
499 * Define the VNF resume traffic service
500 **********************************************************************************/
502 description "An operation to resume traffic gracefully on the VF.
503 It resumes traffic gracefully without stopping the application";
510 uses action-identifiers;
522 /**********************************************************************************
523 * Define the VNF UpgradePreCheck service
524 **********************************************************************************/
525 rpc upgrade-pre-check {
526 description "An operation to check that the VNF has the correct software version needed for a software upgrade.";
533 uses action-identifiers;
549 /**********************************************************************************
550 * Define the VNF UpgradeSoftware service
551 **********************************************************************************/
552 rpc upgrade-software {
553 description "An operation to upgrade the target VNF to a new version and expected that the VNF is in a quiesced status .";
560 uses action-identifiers;
572 /**********************************************************************************
573 * Define the VNF UpgradePostCheck service
574 **********************************************************************************/
575 rpc upgrade-post-check {
576 description "An operation to check the VNF upgrade has been successful completed and all processes are running properly.";
583 uses action-identifiers;
599 /**********************************************************************************
600 * Define the VNF UpgradeBackup service
601 **********************************************************************************/
603 description "An operation to do full backup of the VNF data prior to an upgrade.";
610 uses action-identifiers;
622 /**********************************************************************************
623 * Define the VNF UpgradeBackout service
624 **********************************************************************************/
625 rpc upgrade-backout {
626 description "An operation does a backout after an UpgradeSoftware is completed (either successfully or unsuccessfully).";
633 uses action-identifiers;
645 /**********************************************************************************
646 * Define the rollback service
647 **********************************************************************************/
649 description "An operation to rollback to particular snapshot of a virtual network function (or VM)";
656 uses action-identifiers;
677 /**********************************************************************************
678 * Additional RPCs added here...
679 **********************************************************************************/
682 /**********************************************************************************
683 * Define the sync service
684 **********************************************************************************/
686 description "An operation to sync the configurations of a virtual network function (or VM)";
693 uses action-identifiers;
709 /**********************************************************************************
710 * Define the terminate service
711 **********************************************************************************/
713 description "An operation to terminate the configurations of a virtual network function (or VM)";
720 uses action-identifiers;
734 description "An operation to configure the configurations of a virtual network
742 uses action-identifiers;
759 description "Use the ModifyConfig command when a full configuration cycle is either not required
760 or is considered too costly. The ModifyConfig LCM action affects only a subset of the
761 total configuration data of a VNF. The set of configuration parameters to be affected
762 is a subset of the total configuration data of the target VNF type. The payload Stop
763 Application must contain the configuration parameters to be modified and their values.
764 A successful modify returns a success response. A failed modify returns a failure
765 response and the specific failure messages in the response payload Stop Application";
772 uses action-identifiers;
788 rpc config-scale-out {
789 description "An operation to Modify the configuration or other action to support
790 a ConfigScaleOut of a VNF.";
797 uses action-identifiers;
814 description "An operation to restore the configurations of a virtual network
822 uses action-identifiers;
838 /**********************************************************************************
839 * Define the test service
840 **********************************************************************************/
842 description "An operation to test the configurations of a virtual network function (or VM)";
849 uses action-identifiers;
861 /**********************************************************************************
862 * Define the stop service
863 **********************************************************************************/
865 description "An operation to stop the configurations of a virtual network function (or VM)";
872 uses action-identifiers;
885 description "An operation to start a virtual network function (or VM)";
892 uses action-identifiers;
904 /**********************************************************************************
905 * Define the audit service
906 **********************************************************************************/
908 description "An operation to audit the configurations of a virtual network function (or VM)";
915 uses action-identifiers;
931 /**********************************************************************************
932 * Define the SoftwareUpload vSCP service
933 **********************************************************************************/
934 rpc software-upload {
935 description "An operation to upload a new version of vSCP image to vSCP for updating it";
942 uses action-identifiers;
954 /**********************************************************************************
955 * Define the PreHealthCheck vSCP service
956 **********************************************************************************/
958 description "An operation to perform health check of vSCP prior its upgrading";
965 uses action-identifiers;
983 /**********************************************************************************
984 * Define the Upgrade vSCP service
985 **********************************************************************************/
987 description "An operation to perform upgrade of vSCP";
994 uses action-identifiers;
1007 /**********************************************************************************
1008 * Define the VNF lock service
1009 **********************************************************************************/
1011 description "An operation to perform VNF lock operation";
1018 uses action-identifiers;
1030 /**********************************************************************************
1031 * Define the VNF unlock service
1032 **********************************************************************************/
1034 description "An operation to perform VNF unlock operation";
1041 uses action-identifiers;
1053 /**********************************************************************************
1054 * Define the VNF check lock service
1055 **********************************************************************************/
1057 description "An operation to check VNF lock status";
1064 uses action-identifiers;
1074 description "TRUE/FALSE - returns TRUE when the given VNF was locked, otherwise returns FALSE";
1082 description "An operation to Backup configurations of a virtual network function
1090 uses action-identifiers;
1106 rpc config-backup-delete {
1107 description "An operation to Delete backup configurations of a virtual network
1115 uses action-identifiers;
1128 description "An operation to Export configurations of a virtual network function
1136 uses action-identifiers;
1143 rpc stop-application {
1144 description "An operation to Stop Application traffic to a virtual network function";
1151 uses action-identifiers;
1163 /**********************************************************************************
1164 * Define the VNF Start Application service
1165 **********************************************************************************/
1166 rpc start-application {
1167 description "An operation to perform VNF Start Application operation";
1174 uses action-identifiers;
1187 /**********************************************************************************
1188 * Gets the current state of the previously submitted LCM request
1189 **********************************************************************************/
1191 description "An operation to get the current state of the previously submitted LCM request";
1198 uses action-identifiers;
1213 /**********************************************************************************
1214 * Define the VNF Query service
1215 **********************************************************************************/
1217 description "An operation to query the status of a targe VNF.
1218 Returns information on each VM, including state (active or standby)
1219 and status (healthy or unhealthy)";
1226 uses action-identifiers;
1231 list query-results {
1233 description "Identifier of a VM";
1238 description "The state of the VM";
1243 description "the status of the VM";
1251 /**********************************************************************************
1252 * Define the Reboot service
1253 **********************************************************************************/
1255 description "An operation to reboot a specified virtual machine (VM)";
1262 uses action-identifiers;
1274 /**********************************************************************************
1275 * Define the VM attach volume service
1276 **********************************************************************************/
1278 description "An operation to attach a cinder volume to a VM";
1285 uses action-identifiers;
1297 /**********************************************************************************
1298 * Define the VM detach volume service
1299 **********************************************************************************/
1301 description "An operation to detach a cinder volume from a VM";
1308 uses action-identifiers;
1320 /**********************************************************************************
1321 * Define the traffic distribution service
1322 **********************************************************************************/
1323 rpc distribute-traffic {
1324 description "An operation to distribute traffic between VMs";
1331 uses action-identifiers;
1345 /**********************************************************************************
1346 * Additional RPCs added here...
1347 **********************************************************************************/