2 * ============LICENSE_START=======================================================
4 * ================================================================================
5 * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
6 * ================================================================================
7 * Copyright (C) 2017 Amdocs
8 * =============================================================================
9 * Licensed under the Apache License, Version 2.0 (the "License");
10 * you may not use this file except in compliance with the License.
11 * You may obtain a copy of the License at
13 * http://www.apache.org/licenses/LICENSE-2.0
15 * Unless required by applicable law or agreed to in writing, software
16 * distributed under the License is distributed on an "AS IS" BASIS,
17 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
18 * See the License for the specific language governing permissions and
19 * limitations under the License.
21 * ECOMP is a trademark and service mark of AT&T Intellectual Property.
22 * ============LICENSE_END=========================================================
26 * Yang model for the Application Controller (APP-C) component of ECOMP
28 * This model is used to define the data and services of the Application Controller
29 * component of ECOMP. The APP-C controller initiates the processing of directed
30 * graphs, which define the actual process implementations used. The name of the
31 * directed graph is set by properties and cannot be changed dynamically.
33 * The services exposed by this provider are:
36 * Used to request a restart of a virtual network function (a VM).
39 * Used to request a rebuild of a virtual network function (a VM).
43 module appc-provider-lcm {
46 namespace "org:onap:appc:lcm";
47 prefix appc-provider-lcm;
48 organization "Copyright 2017 AT&T Intellectual Property.";
50 "Dewayne Hafenstein <dh868g@att.us.com>";
53 "Defines the services and request/response requirements for the ECOMP APP-C component.";
56 * Note, the revision changes the package name of the generated java code. Do not
57 * change the revision unless you also update all references to the bindings.
59 revision "2016-01-08" {
61 "APP-C interface version 1.0.48";
64 /**********************************************************************************
65 * Data type definitions
67 * The following data type definitions are used to define common data structures,
68 * define constraints, or to impart special meanings to data objects related to the
69 * APP-C controller functions.
70 **********************************************************************************/
73 description "Define a common definition of a time stamp (expressed as a formatted
74 string) as follows yyyy-MM-ddTHH:mm:ss.SSSSSSSSZ";
77 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";
83 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";
99 enum "SoftwareUpload";
108 enum "ConfigScaleOut";
109 enum "ConfigRestore";
111 enum "ConfigBackupDelete";
113 enum "StopApplication";
114 enum "StartApplication";
115 enum "QuiesceTraffic";
116 enum "ResumeTraffic";
117 enum "UpgradePreCheck";
118 enum "UpgradeSoftware";
119 enum "UpgradePostCheck";
120 enum "UpgradeBackup";
121 enum "UpgradeBackout";
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;
545 /**********************************************************************************
546 * Define the VNF UpgradeSoftware service
547 **********************************************************************************/
548 rpc upgrade-software {
549 description "An operation to upgrade the target VNF to a new version and expected that the VNF is in a quiesced status .";
556 uses action-identifiers;
568 /**********************************************************************************
569 * Define the VNF UpgradePostCheck service
570 **********************************************************************************/
571 rpc upgrade-post-check {
572 description "An operation to check the VNF upgrade has been successful completed and all processes are running properly.";
579 uses action-identifiers;
591 /**********************************************************************************
592 * Define the VNF UpgradeBackup service
593 **********************************************************************************/
595 description "An operation to do full backup of the VNF data prior to an upgrade.";
602 uses action-identifiers;
614 /**********************************************************************************
615 * Define the VNF UpgradeBackout service
616 **********************************************************************************/
617 rpc upgrade-backout {
618 description "An operation does a backout after an UpgradeSoftware is completed (either successfully or unsuccessfully).";
625 uses action-identifiers;
637 /**********************************************************************************
638 * Define the rollback service
639 **********************************************************************************/
641 description "An operation to rollback to particular snapshot of a virtual network function (or VM)";
648 uses action-identifiers;
669 /**********************************************************************************
670 * Additional RPCs added here...
671 **********************************************************************************/
674 /**********************************************************************************
675 * Define the sync service
676 **********************************************************************************/
678 description "An operation to sync the configurations of a virtual network function (or VM)";
685 uses action-identifiers;
701 /**********************************************************************************
702 * Define the terminate service
703 **********************************************************************************/
705 description "An operation to terminate the configurations of a virtual network function (or VM)";
712 uses action-identifiers;
726 description "An operation to configure the configurations of a virtual network
734 uses action-identifiers;
751 description "Use the ModifyConfig command when a full configuration cycle is either not required
752 or is considered too costly. The ModifyConfig LCM action affects only a subset of the
753 total configuration data of a VNF. The set of configuration parameters to be affected
754 is a subset of the total configuration data of the target VNF type. The payload Stop
755 Application must contain the configuration parameters to be modified and their values.
756 A successful modify returns a success response. A failed modify returns a failure
757 response and the specific failure messages in the response payload Stop Application";
764 uses action-identifiers;
780 rpc config-scaleout {
781 description "An operation to scaleout the configurations of a virtual network
789 uses action-identifiers;
806 description "An operation to restore the configurations of a virtual network
814 uses action-identifiers;
830 /**********************************************************************************
831 * Define the test service
832 **********************************************************************************/
834 description "An operation to test the configurations of a virtual network function (or VM)";
841 uses action-identifiers;
853 /**********************************************************************************
854 * Define the stop service
855 **********************************************************************************/
857 description "An operation to stop the configurations of a virtual network function (or VM)";
864 uses action-identifiers;
877 description "An operation to start a virtual network function (or VM)";
884 uses action-identifiers;
896 /**********************************************************************************
897 * Define the audit service
898 **********************************************************************************/
900 description "An operation to audit the configurations of a virtual network function (or VM)";
907 uses action-identifiers;
923 /**********************************************************************************
924 * Define the SoftwareUpload vSCP service
925 **********************************************************************************/
926 rpc software-upload {
927 description "An operation to upload a new version of vSCP image to vSCP for updating it";
934 uses action-identifiers;
946 /**********************************************************************************
947 * Define the PreHealthCheck vSCP service
948 **********************************************************************************/
950 description "An operation to perform health check of vSCP prior its upgrading";
957 uses action-identifiers;
970 /**********************************************************************************
971 * Define the Upgrade vSCP service
972 **********************************************************************************/
974 description "An operation to perform upgrade of vSCP";
981 uses action-identifiers;
994 /**********************************************************************************
995 * Define the VNF lock service
996 **********************************************************************************/
998 description "An operation to perform VNF lock operation";
1005 uses action-identifiers;
1017 /**********************************************************************************
1018 * Define the VNF unlock service
1019 **********************************************************************************/
1021 description "An operation to perform VNF unlock operation";
1028 uses action-identifiers;
1040 /**********************************************************************************
1041 * Define the VNF check lock service
1042 **********************************************************************************/
1044 description "An operation to check VNF lock status";
1051 uses action-identifiers;
1061 description "TRUE/FALSE - returns TRUE when the given VNF was locked, otherwise returns FALSE";
1069 description "An operation to Backup configurations of a virtual network function
1077 uses action-identifiers;
1093 rpc config-backup-delete {
1094 description "An operation to Delete backup configurations of a virtual network
1102 uses action-identifiers;
1115 description "An operation to Export configurations of a virtual network function
1123 uses action-identifiers;
1130 rpc stop-application {
1131 description "An operation to Stop Application traffic to a virtual network function";
1138 uses action-identifiers;
1150 /**********************************************************************************
1151 * Define the VNF Start Application service
1152 **********************************************************************************/
1153 rpc start-application {
1154 description "An operation to perform VNF Start Application operation";
1161 uses action-identifiers;
1174 /**********************************************************************************
1175 * Gets the current state of the previously submitted LCM request
1176 **********************************************************************************/
1178 description "An operation to get the current state of the previously submitted LCM request";
1185 uses action-identifiers;
1200 /**********************************************************************************
1201 * Define the VNF Query service
1202 **********************************************************************************/
1204 description "An operation to query the status of a targe VNF.
1205 Returns information on each VM, including state (active or standby)
1206 and status (healthy or unhealthy)";
1213 uses action-identifiers;
1218 list query-results {
1220 description "Identifier of a VM";
1225 description "The state of the VM";
1230 description "the status of the VM";
1238 /**********************************************************************************
1239 * Define the Reboot service
1240 **********************************************************************************/
1242 description "An operation to reboot a specified virtual machine (VM)";
1249 uses action-identifiers;
1261 /**********************************************************************************
1262 * Define the VM attach volume service
1263 **********************************************************************************/
1265 description "An operation to attach a cinder volume to a VM";
1272 uses action-identifiers;
1284 /**********************************************************************************
1285 * Define the VM detach volume service
1286 **********************************************************************************/
1288 description "An operation to detach a cinder volume from a VM";
1295 uses action-identifiers;
1309 /**********************************************************************************
1310 * Additional RPCs added here...
1311 **********************************************************************************/