diff options
| author |   Scott Seabolt <js9808@att.com> | 2018-02-07 00:38:53 -0500 |
|---|---|---|
| committer |   Patrick Brady <pb071s@att.com> | 2018-02-07 20:10:02 +0000 |
| commit | 0eb95a9471d50a3bf1eb92e3c3d90fcad4f7f37c (patch) | |
| tree | c057c657a37e1438ef6d124d7f68ad04c4257303 /docs | |
| parent | 7ae61f4b2841a6ef8bb0d708218cc6a0c9b9d0ef (diff) | |
Updated APPC LCM API Guide
APPC LCM API Guide updated for Beijing Release
Issue-ID: APPC-357
Change-Id: I36e5b2c01fe6d808d0a71b74173fdbe60b3567a6
Signed-off-by: Scott Seabolt <js9808@att.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/APPC LCM API Guide/APPC LCM API Guide.rst | 1199 |
1 files changed, 903 insertions, 296 deletions
diff --git a/docs/APPC LCM API Guide/APPC LCM API Guide.rst b/docs/APPC LCM API Guide/APPC LCM API Guide.rst index e8b522b13..92a5d09d8 100644 --- a/docs/APPC LCM API Guide/APPC LCM API Guide.rst +++ b/docs/APPC LCM API Guide/APPC LCM API Guide.rst @@ -46,7 +46,7 @@ A virtual application is composed of the following layers of network technology: A Life Cycle Management (LCM) command may affect one or more of these layers. -An LCM command is sent as a request to the APPC using an HTTP POST request or in a message on a message bus (DMaaP or UEB). A request may result in either a single synchronous response or multiple asynchronous responses: +An LCM command is sent as a request to the APPC using an HTTP POST request or in a message on a message bus (DMaaP). A request may result in either a single synchronous response or multiple asynchronous responses: - An **asynchronous** command, which is sent as an authorized and valid request, results in at least two discrete response events: - an accept response, to indicate that the request is accepted for processing @@ -74,7 +74,7 @@ Asynchronous Flow ^^^^^^^^^^^^^^^^^ - The APPC Client Library is called via an asynchronous API using a full command object, which is mapped to a JSON representation. -- The APPC client calls the UEB/DMaaP client and sends the JSON command to a configured topic. +- The APPC client calls the message bus client and sends the JSON command to a configured topic. - The APPC client pulls response messages from the configured topic. - On receiving the response for the command, APPC client runs the relevant callback method of the consumer ResponseHandler. @@ -82,7 +82,7 @@ Synchronous Flow ^^^^^^^^^^^^^^^^ - The APPC Client Library is called via a synchronous API using a full command object, which is mapped to a JSON representation. -- The APPC client calls the UEB/DMaaP client and sends the JSON command to a configured topic. +- The APPC client calls the message bus client and sends the JSON command to a configured topic. - The APPC client pulls response messages from the configured topic. - On receiving the final response for the command, the APPC client returns the response object with a final status. @@ -108,29 +108,38 @@ Table 1 Request / Response Message Fields +----------------------+----------------------------------------------------------------------------------------------------------------+---------------------+ | cambria. partition | Indicates the specific topic partition that the message is intended for. For example: | No | | | | | -| | - For incoming messages, this value should be APP-C. | | +| | - For incoming messages, this value should be ``APPC``. | | | | | | +----------------------+----------------------------------------------------------------------------------------------------------------+---------------------+ -| correlation- id | Correlation ID used for associating responses in APPC Client Library. Built as: <request-id>-<sub-request-id> | Yes | +| correlation- id | Correlation ID used for associating responses in APPC Client Library. | Yes | +| | Built as: ``<request-id>-<sub-request-id>`` | | +----------------------+----------------------------------------------------------------------------------------------------------------+---------------------+ -| rpc-name | The target Remote Processing Call (RPC) name which should match the LCM command name. For example: configure | Yes | +| rpc-name | The target Remote Processing Call (RPC) name which should match the LCM command name. For example:``configure``| Yes | | | | | | | The convention for RPC names and the target URL is that multi-word command names should have a dash between | | | | words, e.g., | | -| | /restconf/operations/appc-provider-lcm:config-modify | | +| | /restconf/operations/appc-provider-lcm:action-status | | +----------------------+----------------------------------------------------------------------------------------------------------------+---------------------+ | type | Message type: request, response or error | Yes | +----------------------+----------------------------------------------------------------------------------------------------------------+---------------------+ | body | Contains the input or output LCM command content, which is either the request or response | | -| | The body field format is identical to the equivalent HTTP Rest API command based on the specific RPC name | Yes | +| | The body field format is identical to the equivalent HTTP Rest API command based on the specific RPC name. | Yes | +| | For example:: | | | | | | +| | { | | +| | "input" : { | | +| | "common-header" : {...} | | +| | "action" : "configure", | | +| | "action-identifiers" : {...}, | | +| | "payload": "..." | | +| | } | | +----------------------+----------------------------------------------------------------------------------------------------------------+---------------------+ Generic Request Format ---------------------- -The LCM API general request format is applicable for both POST HTTP API and for the message body received via the EUB/DMaaP bus. +The LCM API general request format is applicable for both POST HTTP API and for the message body received via the message bus. LCM Request ^^^^^^^^^^^ @@ -142,9 +151,9 @@ The LCM request conforms to the following structure:: "input": { "common-header": {"timestamp": "<TIMESTAMP>", "api-ver": "<API_VERSION>", - "originator-id": "<ECOMP_SYSTEM_ID>", - "request-id": "<ECOMP_REQUEST_ID>", - "sub-request-id": "<ECOMP_SUBREQUEST_ID>", + "originator-id": "<SYSTEM_ID>", + "request-id": "<REQUEST_ID>", + "sub-request-id": "<SUBREQUEST_ID>", "flags": { "mode": "<EXCLUSIVE|NORMAL>", "force": "<TRUE|FALSE>", @@ -153,8 +162,8 @@ The LCM request conforms to the following structure:: }, "action": "<COMMAND_ACTION>", "action-identifiers": { - "vnf-id": "<ECOMP_VNF_ID>", - "vnfc-name": "<ECOMP_VNFC_NAME>", + "vnf-id": "<VNF_ID>", + "vnfc-name": "<VNFC_NAME>", "vserver-id": "VSERVER_ID" }, ["payload": "<PAYLOAD>"] @@ -175,9 +184,9 @@ Table 2 LCM Request Fields | | | | | | APPC will reject the request if timestamp is in the future (due to clock error), or timestamp is too old (compared to TTL flag) | | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+ -| api-ver |Identifies the API version, in X.YY format, where X denotes the major version increased with each APPC release, and YY is the minor release version. For example: | Yes | +| api-ver | Identifies the API version, in X.YY format, where X denotes the major version increased with each APPC release, and YY is the minor release version. | Yes | | | | | -| | - 5.00 for this version | | +| | 2.00 should be used for all LCM API requests | | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+ | originator-id | An identifier of the calling system limited to a length of 40 characters. | Yes | | | | | @@ -189,45 +198,36 @@ Table 2 LCM Request Fields +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+ | sub-request-id | Uniquely identifies a specific LCM or control action, limited to a length of 40 characters. Persists throughout the life cycle of a single request. | No | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+ -| flags | Generic flags that apply to all LCM actions: | No | +| flags | Generic flags that apply to all LCM actions: | No | | | | | | | - "MODE" : | | | | | | -| | - "EXCLUSIVE" - accept no queued requests on this VNF while processing, or | | +| | - "EXCLUSIVE" - reject requests on this VNF while another request is in progress, or | | | | | | -| | - "NORMAL" - queue other requests until complete | | +| | - "NORMAL" - allow requests (pending additional validations) on this VNF if there is another request is in progress. | | | | | | -| | - "FORCE" : "TRUE"\|"FALSE" - run action even if target is in an unstable state (for example, if VNF is busy processing another LCM command or if a previous command failed and VNF was indicated as not STABLE), or not. | | +| | - "FORCE" : | | +| | - TRUE – forces APP-C to process the request regardless of whether there is another request for the VNF or VM in progress. | | +| | - FALSE – default value. Will return an error if there is another action in progress on the same VNF or VM, unless the two actions are allowed in parallel based on a Request Management Model stored in APP-C. | | +| | The model allows some non-disruptive actions such as Lock, Unlock, CheckLock, and ActionStatus to be performed in conjunction with other actions. | | | | | | -| | The specific behavior of forced actions varies, but implies cancellation of the previous action and an override by the new action. The default value is FALSE. | | -| | | | -| | Force flag are used to bypass APPC’s working state management for the VNF(VNF working State Management) : | | -| | | | -| | APPC maintains working state (in the VNF\_STATE\_MANAGEMENT table present in the APPC-DB) for the VNF depending on the last action performed on it: | | -| | | | -| | There are below 3 states appc have for VNF while performing non-read only operation (Read-Only operations are : Lock, Unlock, CheckLock, Sync, Audit etc. ) : | | -| | | | -| | 1) Stable – If the last action performed on a VNF is Successful (returning Success). | | -| | | | -| | 2) Unstable – This is the intermediate state for any VNF on which operation is being performed. | | -| | | | -| | 3) Unknown – This is the status when the last action performed on a VNF is not successful. | | -| | | | -| | APPC have validation that it will not allow any operations on VNF which is in Unstable or Unknown state. To skip this check end-user can pass Force-flag=true in the request. | | -| | | | -| | - "TTL": <0....N> - The timeout value for the action to run, between action received by APPC and action initiated. | | +| | - "TTL": <0....N> - The timeout value is used to determine if the request timeout has been exceeded (i.e., if the TTL value is less than the current time minus the timestamp, the request is rejected). The value is in seconds. | | | | | | | | If no TTL value provided, the default/configurable TTL value is to be used. | | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+ -| action | The action to be taken by APPC, for example: Test, Start, Terminate. | Yes | +| action | The action to be taken by APPC, for example: Test, Start | Yes | | | | | -| | ***NOTE:** The specific value for the action parameter is provided for each* command. | | +| | These are case-sensitive; e.g.,”Restart” is correct; “restart” is incorrect. | | +| | | | +| | ***NOTE:** The specific value for the action parameter is provided for each command. | | ++---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+ +| action-identifiers | A block containing the action arguments. These are used to specify the object upon which APPC LCM command is to operate. At least one action-identifier must be specified (note that vnf-id is mandatory). For actions that are at the VM level, the action-identifiers provided would be vnf-id and vserver-id. | Yes | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+ -| action- identifiers | A block containing the action arguments. These are used to specify the object upon which APPC LCM command is to operate. At least one action-identifier must be specified (note that vnf-id is mandatory). For actions that are at the VM level, the action-identifiers provided would be vnf-id and vserver-id. | Yes | +| service-instance-id | Identifies a specific service instance that the command refers to. When multiple APPC instances are used and applied to a subset of services, this will become significant. The field is mandatory when the vnf-id is empty. Currently not used. | No | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+ | vnf-id | Identifies the VNF instance to which this action is to be applied. Required for actions. | Yes | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+ -| vnfc-name | Identifies the VNFC instance to which this action is to be applied. Required if the action applied to a specific VNFC. | No | +| vnfc-name | Identifies the VNFC instance to which this action is to be applied. Required if the action applied to a specific VNFC. Currently not used. | No | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+ | vserver-id | Identifies a specific VM instance to which this action is to be applied. Required if the action applied to a specific VM. (Populate the vserver-id field with the UUID of the VM) | No | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+ @@ -235,17 +235,52 @@ Table 2 LCM Request Fields +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+ | payload | An action-specific open-format field. | No | | | | | -| | The payload can be any valid JSON string value. JSON escape characters need to be added when an inner JSON string is included within the payload, for example: "{\\" vnf -host- ip | | +| | The payload can be any valid JSON string value. JSON escape characters need to be added when an inner JSON string is included within the payload, for example: ``"{\\"vnf-host-ip-address\\": \\"<VNF-HOST-IP-ADDRESS>\\"}"``. | | +| | | | | | | | -| | -address\\": \\"<VNF-HOST-IP-ADDRESS>\\"}". | | | | | | | | The payload is typically used to provide parametric data associated with the command, such as a list of configuration parameters. | | | | | | | | Note that not all LCM commands need have a payload. | | | | | | -| | ***NOTE:** See discussion below on the use of payloads for self-service actions.* | | +| | ***NOTE:** See discussion below on the use of payloads for self-service actions. | | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+ +Request Processing and Validation Logic +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +When a new request is received, APPC applies the following validation logic. For any failure, the request is rejected and an error (300 range) is returned. + +1. If the request has timeout out (i.e., the difference between current + time and the request timestamp value is greater than TTL value in + request), a timeout error is returned. + +2. If the request is a duplicate of an existing request in progress + (same request-id, sub-request-id, originator-id), a duplicate error + is returned. + +3. If there is a Lock on the vnf-id, reject any new action if it is not + associated with the locking request-id, a lockout error is returned. + +4. If the Force flag = Y, then allow the new action regardless of + whether there is an action in progress. + +5. If the Mode flag = Exclusive on a request in progress, any new + request is rejected until the request in progress is completed. + +6. If request is received and there are one or more requests in + progress, then the new request is evaluated to determine if there is + any overlap in scope with the existing requests (for example, a new + VNF level request would overlap with another request in progress). + + a. If there is no overlap between the new request and requests in + progress, the new request is accepted. For example, a Start + request on VM1 and a Stop request on VM2 can be running in + parallel. + + b. If there is overlap, then only special cases are allowed in + parallel (for example, Audit and HealthCheck are allowed). + Generic Response Format ----------------------- @@ -253,7 +288,7 @@ Generic Response Format This section describes the generic response format. -The response format is applicable for both POST HTTP API and for the message body received via the EUB/DMaaP bus. +The response format is applicable for both POST HTTP API and for the message body received via the message bus. LCM Response @@ -266,22 +301,22 @@ The LCM response conforms to the following structure:: { "output": { "common-header": { - "api-ver": "<API\_VERSION>", + "api-ver": "<API_VERSION>", "flags": { - "ttl": <TTL\_VALUE>, - "force": "<TRUE\|FALSE>", - "mode": "<EXCLUSIVE\|NORMAL>" + "ttl": <TTL_VALUE>, + "force": "<TRUE|FALSE>", + "mode": "<EXCLUSIVE|NORMAL>" }, - "originator-id": "<ECOMP\_SYSTEM\_ID>", - "request-id": "<ECOMP\_REQUEST\_ID>", - "sub-request-id": "<ECOMP\_SUBREQUEST\_ID>", + "originator-id": "<SYSTEM_ID>", + "request-id": "<REQUEST_ID>", + "sub-request-id": "<SUBREQUEST_ID>", "timestamp": "2016-08-08T23:09:00.11Z", }, "payload": "<PAYLOAD>", [Additional fields], "status": { - "code": <RESULT\_CODE>, - "message": "<RESULT\_MESSAGE>" + "code": <RESULT_CODE>, + "message": "<RESULT_MESSAGE>" } } } @@ -292,13 +327,13 @@ Table 3 LCM Response Fields +----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+ | **Field** | **Description** | **Required?** | +======================+===========================================================================================================================================================================================================================+=====================+ -| output | The block that defines the details of the output of the command processing. Contains the common-header details. | Yes | +| output | The block that defines the details of the output of the command processing. Contains the ``common-header`` details. | Yes | +----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+ | common- header | The block that contains the generic details about a request. | Yes | +----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+ -| api-ver | Identifies the API version, in X.YY format, where X denotes the major version increased with each APPC release, and YY is the minor release version. For example: | Yes | +| api-ver | Identifies the API version, in X.YY format, where X denotes the major version increased with each APPC release, and YY is the minor release version. | Yes | | | | | -| | - 5.00 for this version | | +| | - 2.00 should be used for all LCM API requests | | +----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+ | originator-id | An identifier of the calling system limited to a length of 40 characters. | Yes | | | | | @@ -310,15 +345,15 @@ Table 3 LCM Response Fields +----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+ | sub-request-id | Uniquely identifies a specific LCM or control action, limited to a length of 40 characters. Persists throughout the life cycle of a single request. | No | +----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+ -| timestamp | The time of the request, in ISO 8601 format, ZULU offset. For example: 2016-08-03T08:50:18.97Z. | Yes | +| timestamp | The time of the request, in ISO 8601 format, ZULU offset. For example: ``2016-08-03T08:50:18.97Z``. | Yes | +----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+ -| status | The status describes the outcome of the command processing. Contains a code and a message providing success or failure details. | Yes | +| status | The status describes the outcome of the command processing. Contains a ``code`` and a ``message`` providing success or failure details. | Yes | | | | | | | ***NOTE:** See* status *for code values.* | | +----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+ | payload | An open-format field. | No | | | | | -| | The payload can be any valid JSON string value. JSON escape characters need to be added when an inner JSON string is included within the payload, for example: "{\\"upload\_config\_id\\": \\"<value\\"}". | | +| | The payload can be any valid JSON string value. JSON escape characters need to be added when an inner JSON string is included within the payload, for example: ``"{\\"upload\_config\_id\\": \\"<value\\"}"``. | | | | | | | | The payload is typically used to provide parametric data associated with the response to the command. | | | | | | @@ -337,7 +372,7 @@ Table 3 LCM Response Fields Status Codes ------------ -The status code is returned in the response message as the code parameter, and the description as the message parameter. +The status code is returned in the response message as the ``code`` parameter, and the description as the message parameter. The different responses are categorized as follows: @@ -419,6 +454,10 @@ The different responses are categorized as follows: | | | | | | | ${vnfId} | +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| | 315 | MULTIPLE REQUESTS USING SEARCH CRITERIA: ${parameters} | ++-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| | 316 | POLICY VALIDATION FAILURE - Request rejected as per the request validation policy | ++-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+ | SUCCESS | 400 | The request was processed successfully | +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+ | FAILURE | 401 | DG FAILURE - ${ detailedErrorMsg } | @@ -433,12 +472,11 @@ The different responses are categorized as follows: +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+ | | 406 | UNSTABLE VNF FAILURE - VNF ${vnfId} is not stable to accept the command | +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| | 450 | Requested action is not supported on the VNF | +| | 450 | REQUEST NOT SUPPORTED | +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+ | PARTIAL SUCCESS | 500 | PARTIAL SUCCESS | +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+ | PARTIAL FAILURE | 501 - | PARTIAL FAILURE | -| | | | | | 599 | | +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+ @@ -504,56 +542,76 @@ Commands, or actions, can be performed at one or more of the following scope lev +-----------------+----------------------------------------------------------------------------------------+ -**VNF’s Types Supported** - -Commands, or actions, may be currently supported on all VNF types or a limited set of VNF types. Note that the intent in the 1710 release is to support all actions on all VNF types which have been successfully onboarded in a self-service mode. - -**Any -** Currently supported on any vnf-type. - -**Any (requires self-service onboarding) –** Currently supported on any vnf-type which has been onboarded using the APPC self-service onboarding process. See further discussion on self-service onboarding below. - - -+------------------------+---------------+---------------------+----------------+--------------+----------------------------------------------------------------+ -| **Command** | **VNF** | **VF-Module** | **VNFC** | **VM** | **VNF/VM Types Supported** | -+========================+===============+=====================+================+==============+================================================================+ -| Audit | Yes | | | | Any (requires self-service onboarding) | -+------------------------+---------------+---------------------+----------------+--------------+----------------------------------------------------------------+ -| CheckLock | Yes | | | | Any (APPC internal command) | -+------------------------+---------------+---------------------+----------------+--------------+----------------------------------------------------------------+ -| Configure | Yes | | Yes | | Any (requires self-service onboarding) | -+------------------------+---------------+---------------------+----------------+--------------+----------------------------------------------------------------+ -| ConfigModify | Yes | | Yes | | Any (requires self-service onboarding) | -+------------------------+---------------+---------------------+----------------+--------------+----------------------------------------------------------------+ -| ConfigBackup | Yes | | | | Chef and Ansible only (requires self-service onboarding) | -+------------------------+---------------+---------------------+----------------+--------------+----------------------------------------------------------------+ -| ConfigRestore | Yes | | | | Chef and Ansible only (requires self-service onboarding) | -+------------------------+---------------+---------------------+----------------+--------------+----------------------------------------------------------------+ -| Evacuate | | | | Yes | Any (uses OpenStack Evacuate command) | -+------------------------+---------------+---------------------+----------------+--------------+----------------------------------------------------------------+ -| HealthCheck | Yes | | | | Any (requires self-service onboarding) | -+------------------------+---------------+---------------------+----------------+--------------+----------------------------------------------------------------+ -| Lock | Yes | | | | Any (APPC internal command) | -+------------------------+---------------+---------------------+----------------+--------------+----------------------------------------------------------------+ -| Migrate | | | | Yes | Any (uses OpenStack Migrate command) | -+------------------------+---------------+---------------------+----------------+--------------+----------------------------------------------------------------+ -| Rebuild | | | | Yes | Any (uses OpenStack Rebuild command) | -+------------------------+---------------+---------------------+----------------+--------------+----------------------------------------------------------------+ -| Restart | Yes | | | Yes | Any (uses OpenStack Start and Stop commands) | -+------------------------+---------------+---------------------+----------------+--------------+----------------------------------------------------------------+ -| Snapshot | | | | Yes | Any (uses OpenStack Snapshot command) | -+------------------------+---------------+---------------------+----------------+--------------+----------------------------------------------------------------+ -| Start | Yes | Yes | | Yes | Any (uses OpenStack Start command) | -+------------------------+---------------+---------------------+----------------+--------------+----------------------------------------------------------------+ -| StartApplication | Yes | | | | Chef and Ansible only (requires self-service onboarding) | -+------------------------+---------------+---------------------+----------------+--------------+----------------------------------------------------------------+ -| Stop | Yes | Yes | | Yes | Any (uses OpenStack Stop command) | -+------------------------+---------------+---------------------+----------------+--------------+----------------------------------------------------------------+ -| StopApplication | Yes | | | | Chef and Ansible only (requires self-service onboarding) | -+------------------------+---------------+---------------------+----------------+--------------+----------------------------------------------------------------+ -| Sync | Yes | | | | Any (requires self-service onboarding) | -+------------------------+---------------+---------------------+----------------+--------------+----------------------------------------------------------------+ -| Unlock | Yes | | | | Any (APPC internal command) | -+------------------------+---------------+---------------------+----------------+--------------+----------------------------------------------------------------+ +**VNF/VM Types Supported** + +Commands, or actions, may be currently supported on all VNF types or a limited set of VNF types. Note that the intent is to support all actions on all VNF types which have been successfully onboarded in a self-service mode. + + - **Any** Currently supported on any vnf-type. + + - **Any (requires self-service onboarding)** Currently supported on any vnf-type which has been onboarded using the APPC self-service onboarding process. See further discussion on self-service onboarding below. + + ++------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+ +| **Command** | **VNF** | **VF-Module** | **VNFC** | **VM** | **VNF/VM Types Supported** | ++========================+===========+==================+================+==========+============================================================+ +| ActionStatus | Yes | | | | Any | ++------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+ +| AttachVolume | | | | Yes | Any (uses OpenStack command) | ++------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+ +| Audit | Yes | | | | Any (requires self-service onboarding) | ++------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+ +| CheckLock | Yes | | | | Any | ++------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+ +| Configure | Yes | | Yes | | Any (requires self-service onboarding) | ++------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+ +| ConfigBackup | Yes | | | | Chef and Ansible only (requires self-service onboarding) | ++------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+ +| ConfigModify | Yes | | Yes | | Any (requires self-service onboarding) | ++------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+ +| ConfigRestore | Yes | | | | Chef and Ansible only (requires self-service onboarding) | ++------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+ +| DetachVolume | | | | Yes | Any (uses OpenStack command) | ++------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+ +| Evacuate | | | | Yes | Any (uses OpenStack command) | ++------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+ +| HealthCheck | Yes | | | | Any (requires self-service onboarding) | ++------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+ +| Lock | Yes | | | | Any | ++------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+ +| Migrate | | | | Yes | Any (uses OpenStack command) | ++------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+ +| QuiesceTraffic | Yes | | | | Chef and Ansible only (requires self-service onboarding) | ++------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+ +| Rebuild | | | | Yes | Any (uses OpenStack command) | ++------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+ +| Restart | | | | Yes | Any (uses OpenStack command) | ++------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+ +| ResumeTraffic | Yes | | | | Chef and Ansible only (requires self-service onboarding) | ++------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+ +| Snapshot | | | | Yes | Any (uses OpenStack command) | ++------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+ +| Start | | | | Yes | Any (uses OpenStack command) | ++------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+ +| StartApplication | Yes | | | | Chef and Ansible only (requires self-service onboarding) | ++------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+ +| Stop | | | | Yes | Any (uses OpenStack command) | ++------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+ +| StopApplication | Yes | | | | Chef and Ansible only (requires self-service onboarding) | ++------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+ +| Sync | Yes | | | | Any (requires self-service onboarding) | ++------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+ +| Unlock | Yes | | | | Any | ++------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+ +| UpgradeBackout | Yes | | | | Chef and Ansible only (requires self-service onboarding) | ++------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+ +| UpgradeBackup | Yes | | | | Chef and Ansible only (requires self-service onboarding) | ++------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+ +| UpgradePostCheck | Yes | | | | Chef and Ansible only (requires self-service onboarding) | ++------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+ +| UpgradePreCheck | Yes | | | | Chef and Ansible only (requires self-service onboarding) | ++------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+ +| UpgradeSoftware | Yes | | | | Chef and Ansible only (requires self-service onboarding) | ++------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+ @@ -569,7 +627,7 @@ The APPC architecture is designed for VNF self-service onboarding (i.e., a VNF o - Ansible (does not require any changes to the VNF software) -The self-service onboarding process is done using an APPC Design GUI which interacts with an APPC instance which is dedicated to self-service onboarding. The steps in the onboarding process using the APPC Design GUI are: +The self-service onboarding process is done using an APPC Design GUI (also referred to as CDT) which interacts with an APPC instance which is dedicated to self-service onboarding. The steps in the onboarding process using the APPC Design GUI are: - Define the VNF capabilities (set of actions that the VNF can support). @@ -585,7 +643,7 @@ The self-service onboarding process is done using an APPC Design GUI which inter artifacts to SDC which distributes them to all APPC instances in the same environment (e.g., production). -For more details, see the APPC Self-Service VNF Onboarding Guide. +For more details, see the APPC CDT Onboarding User Guide. @@ -594,6 +652,110 @@ LCM Commands The LCM commands that are valid for the current release. +ActionStatus +------------ + +The ActionStatus command returns that state of any action request that has been previously submitted to an APPC instance for a specified VNF. This enables the client to know the status of a previous request and helps them decide if they should reissue a request. + ++--------------------------+----------------------------------------------------------+ +| **Target URL** | /restconf /operations/ appc-provider-lcm:action-status | ++--------------------------+----------------------------------------------------------+ +| **Action** | ActionStatus | ++--------------------------+----------------------------------------------------------+ +| **Action-Identifiers** | vnf-id | ++--------------------------+----------------------------------------------------------+ +| **Payload Parameters** | See below | ++--------------------------+----------------------------------------------------------+ +| **Revision History** | New in Beijing | ++--------------------------+----------------------------------------------------------+ + +| + ++-----------------------------+------------------------------------------------------------+--------------------+-------------------------------------+ +| **Payload Parameter** | **Description** | **Required** | **Example** | ++=============================+============================================================+====================+=====================================+ +| request-id | Request id from the previously submitted request | Yes | "request-id": "123456789" | ++-----------------------------+------------------------------------------------------------+--------------------+-------------------------------------+ +| sub-request ID | Sub-Request id from the previously submitted request | optional | "sub-request-id": "123456789" | ++-----------------------------+------------------------------------------------------------+--------------------+-------------------------------------+ +| originator-id | Originator id from the previously submitted request | optional | "originator-id": "123456789" | ++-----------------------------+------------------------------------------------------------+--------------------+-------------------------------------+ + + +ActionStatus Response: +^^^^^^^^^^^^^^^^^^^^^^ + +A successful response contains a payload with the following: + ++-----------------------------+-----------------------------------------------------------------------+--------------------+------------------------------+ +| **Payload Parameter** | **Description** | **Required** | **Example** | ++=============================+=======================================================================+====================+==============================+ +| status-reason | Contains more details about status | No | | ++-----------------------------+-----------------------------------------------------------------------+--------------------+------------------------------+ +| status | IN_PROGRESS – The request has been accepted and is in progress | No | "status": "SUCCESSFUL" | +| | | | | +| | SUCCESSFUL – The request returned success message | | | +| | | | | +| | FAILED – The request failed and returned an error message | | | +| | | | | +| | ABORTED – the request aborted | | | +| | | | | +| | NOT_FOUND – The request is not found | | | ++-----------------------------+-----------------------------------------------------------------------+--------------------+------------------------------+ + +If the ActionStatus request was rejected or could not be processed, it returns a valid error code or error message (but no payload).Example below: + + ``"message": "MULTIPLE REQUESTS FOUND - using search criteria: + request- id=c09ac7d1-de62-0016-2000-e63701125559 AND + vnf-id=ctsf0007v", "code": 315`` + +AttachVolume +------------ + +The AttachVolume command attaches a cinder volume to a VM via an Openstack command. + +Cinder is a Block Storage service for OpenStack. It's designed to present storage resources to end users that can be consumed by the OpenStack Compute Project (Nova). The short description of Cinder is that it virtualizes the management of block storage devices and provides end users with a self service API to request and consume those resources without requiring any knowledge of where their storage is actually deployed or on what type of device. + + NOTE: The command implementation is based on Openstack + functionality. For further details, see + http://developer.openstack.org/api-ref/compute/. + ++--------------------------+----------------------------------------------------------+ +| **Target URL** | /restconf /operations/ appc-provider-lcm:attach-volume | ++--------------------------+----------------------------------------------------------+ +| **Action** | AttachVolume | ++--------------------------+----------------------------------------------------------+ +| **Action-Identifiers** | vnf-id, vserver-id | ++--------------------------+----------------------------------------------------------+ +| **Payload Parameters** | See table | ++--------------------------+----------------------------------------------------------+ +| **Revision History** | New in Beijing | ++--------------------------+----------------------------------------------------------+ + +| + ++-----------------------------+-----------------------------------------------------------------------------------------------------------------------------+--------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| **Payload Parameter** | **Description** | **Required** | **Example** | ++=============================+=============================================================================================================================+====================+================================================================================================================================+ +| volumeId | The UUID of the volume to attach. | Yes | "volumeId": "a26887c6-c47b-4654- abb5-dfadf7d3f803", | ++-----------------------------+-----------------------------------------------------------------------------------------------------------------------------+--------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| vm-id | The unique identifier (UUID) of the resource. For backwards- compatibility, this can be the self- link URL of the VM. | Yes | "vm-id": http://135.25.246.162:8774/v2/64a f07e991424b8e9e54eca27d5c0d48/ servers/b074cd1b-8d53-412e-a102- 351cc51ac10a" | ++-----------------------------+-----------------------------------------------------------------------------------------------------------------------------+--------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| Identity-url | The identity URL used to access the resource | No | "identity-url": "http://135.25.246.162:5000/v2.0" | ++-----------------------------+-----------------------------------------------------------------------------------------------------------------------------+--------------------+--------------------------------------------------------------------------------------------------------------------------------+ + +AttachVolume Response: +^^^^^^^^^^^^^^^^^^^^^^ + +Success: A successful AttachVolume returns a success status code 400. + +Failure: A failed AttachVolume returns a failure code 401 and the failure message. Failure messages can include: + +- badRequest +- unauthorized +- forbidden +- itemNotFound + Audit ----- @@ -620,7 +782,7 @@ The Audit action does not require any payload parameters. +------------------------------+------------------------------------------------------+ | **Payload Parameters** | See below | +------------------------------+------------------------------------------------------+ -| **Revision History** | Unchanged in this version. | +| **Revision History** | Unchanged in this release. | +------------------------------+------------------------------------------------------+ | @@ -628,19 +790,19 @@ The Audit action does not require any payload parameters. +----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+----------------------------------+ | **Parameter** | **Description** | **Required?** | **Example** | +======================+===========================================================================================================================================================+=====================+==================================+ -| publish-config | \* If the publish\_config field is set to Y in the payload, then always send the running configuration from the VNF using the Data Router | Yes | "publish-config": "<Y\|N>" | +| publish-config | \* If the publish\_config field is set to Y in the payload, then always send the running configuration from the VNF using the message bus | Yes | "publish-config": "<Y\|N>" | | | | | | | | \* If the publish\_config field is set to N in the payload, then: | | | | | | | | -| | - If the result of the audit is ‘match’ (latest APPC config and the running config match), do not send the running configuration in the Data Router | | | +| | - If the result of the audit is ‘match’ (latest APPC config and the running config match), do not send the running configuration | | | | | | | | -| | - If the result of the audit is ‘no match’, then send the running configuration on the Data Router | | | +| | - If the result of the audit is ‘no match’, then send the running configuration | | | +----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+----------------------------------+ Audit Response ^^^^^^^^^^^^^^ -The audit response returns an indication of success or failure of the audit. If a new configuration is uploaded to the APPC database, the payload contains the ‘upload\_config\_id’ and values for any records created. In addition, the configuration is sent to the ONAP Data Router bus which may be received by an external configuration storage system. +The audit response returns an indication of success or failure of the audit. If a new configuration is uploaded to the APPC database, the payload contains the ‘upload\_config\_id’ and values for any records created. In addition, the configuration is sent to the bus which may be received by an external configuration storage system. CheckLock @@ -665,7 +827,7 @@ The CheckLock action does not require any payload parameters. +------------------------------+--------------------------------------------------------+ | **Payload Parameters** | None | +------------------------------+--------------------------------------------------------+ -| **Revision History** | Unchanged in this version. | +| **Revision History** | Unchanged in this release. | +------------------------------+--------------------------------------------------------+ CheckLock Response @@ -724,7 +886,7 @@ A failed Configure action returns a failure response and the specific failure me +------------------------------+--------------------------------------------------------+ | **Payload Parameters** | See below | +------------------------------+--------------------------------------------------------+ -| **Revision History** | Unchanged in this version. | +| **Revision History** | Unchanged in this release. | +------------------------------+--------------------------------------------------------+ | @@ -733,25 +895,25 @@ A failed Configure action returns a failure response and the specific failure me | **Payload Parameter** | **Description** | **Required?** | **Example** | | | | | | +=================================+============================================================================================================================================================================================================================================================================================================+=====================+=================================================================+ -| request- parameters | The parameters required to process the request must include the host-ip-address to connect to the VNF, if Netconf. A template-name may also be included in the event that a specific configuration template needs to be identified. If the request is vnfc-specific, the vnfc-type must be included. | Yes | | +| request- parameters | vnf-host-ip-address: required if Netconf or other direct interface to the VNF. Optionally, it can be provided for all requests. | Yes | | | | | | "payload": | +| | vnfc-type: if request is vnfc specific | | "{\"request-parameters | +| | | | \": { | +| | template-name: if specific template needs to be specified (otherwise, the most recent default template is used). | | \"vnf-host-ip-address\": | +| | | | \”value\”, | +| | | | \”vnfc-type\”: \”value\”’ | +| | | | \”template-name\”: \”name\”, | +| | | | } | | | | | | -| | | | "{\"request-parameters | | | | | | -| | | | \": { | | | | | | -| | | | \"host-ip-address\": \”value\”, | | | | | | -| | | | \”vnfc-type\”: \”value\”’, | | | | | | -| | | | \”template-name\”: \”name\” | | | | | | -| | | | } | | | | | | -| | | | \"configuration- parameters\": {\"<CONFIG- PARAMS>\"} | | | | | | -+---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+-----------------------------------------------------------------+ -| configuration- parameters | A set of instance specific configuration parameters should be specified. If provided, APPC replaces variables in the configuration template with the values supplied. | No | | ++---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+ | +| configuration- parameters | A set of instance specific configuration parameters should be specified. If provided, APPC replaces variables in the configuration template with the values supplied. | No | \"configuration- parameters\": {\"<CONFIG- PARAMS>\"} | +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+-----------------------------------------------------------------+ @@ -767,56 +929,53 @@ ConfigModify Modifies the configuration on a VNF or VNFC in service. -A successful ConfigModify request returns a success response. - -A failed ConfigModify action returns a failure response code and the specific failure message in the response block. - -**NOTE:** See also `Configure <#_bookmark35>`__ - -+------------------------------+-----------------------------------------------------------+ -| **Target URL** | /restconf/operations/appc-provider-lcm:configmodify | -+------------------------------+-----------------------------------------------------------+ -| **Action** | ConfigModify | -+------------------------------+-----------------------------------------------------------+ -| **Action-Identifiers** | Vnf-id | -+------------------------------+-----------------------------------------------------------+ -| **Payload Parameters** | See below | -+------------------------------+-----------------------------------------------------------+ -| **Revision History** | Unchanged in this version. | -+------------------------------+-----------------------------------------------------------+ - -| - -+---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+-----------------------------------------------------------------+ -| **Payload Parameter** | **Description** | **Required?** | **Example** | -+=================================+============================================================================================================================================================================================================================================================================================================+=====================+=================================================================+ -| request- parameters | The parameters required to process the request must include the host-ip-address to connect to the VNF, if Netconf. A template-name may also be included in the event that a specific configuration template needs to be identified. If the request is vnfc-specific, the vnfc-type must be included. | Yes | "payload": | -| | | | | -| | | | "{\"request-parameters | -| | | | | -| | | | \": { | -| | | | | -| | | | \"host-ip-address\": \”value\”, | -| | | | | -| | | | \”vnfc-type\”: \”value\”’ | -| | | | | -| | | | \”template-name\”: \”name\”, | -| | | | | -| | | | } | -| | | | | -| | | | \"configuration- parameters\": {\"<CONFIG- PARAMS>\"} | -+---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+-----------------------------------------------------------------+ -| configuration- parameters | A set of instance specific configuration parameters should be specified. If provided, APPC replaces variables in the configuration template with the values supplied. | No | | -+---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+-----------------------------------------------------------------+ - -If successful, this request returns a success response. - -A failed Configure action returns a failure response and the specific failure message in the response block. +This command is executed either directly on the VNF (such as for Netconf) or using an Ansible playbook or Chef cookbook. + +Request Structure: + ++--------------------------+--------------------------------------------------------+ +| **Target URL** | /restconf/operations/appc-provider-lcm:config-modify | ++--------------------------+--------------------------------------------------------+ +| **Action** | ConfigModify | ++--------------------------+--------------------------------------------------------+ +| **Action-Identifiers** | vnf-id | ++--------------------------+--------------------------------------------------------+ +| **Payload Parameters** | request-parameters, configuration-parameters | ++--------------------------+--------------------------------------------------------+ +| **Revision History** | Unchanged in this release. | ++--------------------------+--------------------------------------------------------+ + +Request Payload Parameters: + ++-------------------------+----------------------------------------+-----------------+-------------------------------------------------------+ +| **Payload Parameter** | **Description** | **Required?** | **Example** | ++=========================+========================================+=================+=======================================================+ +| request-parameters | vnf-host-ip-address: optional if | No | "payload": | +| | Netconf or other direct interface | | "{\\"request-parameters | +| | to the VNF. If not provided, it is | | \\": { | +| | obtained from A&AI | | \\"vnf-host-ip-address\\": | +| | | | \\”value\\ | +| | vnfc-type: if request is vnfc | | }, | +| | specific | | | +| | | | {\\"configuration- parameters\\": {\\"name1\\": | +| | | | \\”value1\\”,\\"name2\\": | +| | | | \\”value2\\” | +| | | | } | +| | | | } | ++-------------------------+----------------------------------------+-----------------+ | +| configuration- | A set of instance specific | No | | +| parameters | configuration parameters should | | | +| | be specified. | | | ++-------------------------+----------------------------------------+-----------------+-------------------------------------------------------+ ConfigModify Response ^^^^^^^^^^^^^^^^^^^^^ -The ConfigModify response returns an indication of success or failure of the request. If successful, the return payload contains the ‘upload\_config\_id’ and values for any records created. In addition, the configuration is sent to the ONAP Data Router bus which may be received by an external configuration storage system. +**Success:** A successful ConfigModify returns a success status code 400. + +Note: The return payload contains the ‘upload_config_id’ and values associated with the configuration stored in the APPC DB. In addition, the configuration is sent to the message bus which may be received by an external configuration storage system. + +**Failure:** A failed ConfigModify returns a failure code 401 and the failure message. ConfigBackup ------------ @@ -836,7 +995,7 @@ A failed ConfigBackup action returns a failure response code and the specific fa +------------------------------+-----------------------------------------------------------+ | **Payload Parameters** | See below | +------------------------------+-----------------------------------------------------------+ -| **Revision History** | New in this version. | +| **Revision History** | Unchanged in this release. | +------------------------------+-----------------------------------------------------------+ | @@ -844,19 +1003,14 @@ A failed ConfigBackup action returns a failure response code and the specific fa +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+-----------------------------------------------------------------+ | **Payload Parameter** | **Description** | **Required?** | **Example** | +=================================+====================================================================================================================================================================================+=====================+=================================================================+ -| request- parameters | The parameters required to process the request must include the host-ip-address to connect to the VNF (for Chef and Ansible, this will be the url to connect to the server). | Yes | "payload": | -| | | | | -| | | | "{\"request-parameters | +| request-parameters | Not used. This request is limited to Ansible and Chef only. | No | "payload": | +| | | | \"configuration-parameters\": {\"<CONFIG-PARAMS>\"} | | | | | | -| | | | \": { | | | | | | -| | | | \"host-ip-address\": \”value\” | | | | | | -| | | | } | | | | | | -| | | | \"configuration- parameters\": {\"<CONFIG- PARAMS>\"} | -+---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+-----------------------------------------------------------------+ -| configuration- parameters | A set of instance specific configuration parameters should be specified, as required by the Chef cookbook or Ansible playbook. | No | | ++---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+ | +| configuration-parameters | A set of instance specific configuration parameters should be specified, as required by the Chef cookbook or Ansible playbook. | No | | +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+-----------------------------------------------------------------+ ConfigBackup Response @@ -880,9 +1034,9 @@ A failed ConfigRestore action returns a failure response code and the specific f +------------------------------+------------------------------------------------------------------------------------------+ | **Action-Identifiers** | Vnf-id | +------------------------------+------------------------------------------------------------------------------------------+ -| **Payload Parameters** | `request-parameters <#_bookmark24>`__, `configuration-parameters <#_bookmark26>`__ | +| **Payload Parameters** | See below | +------------------------------+------------------------------------------------------------------------------------------+ -| **Revision History** | New in this version. | +| **Revision History** | Unchanged in this release. | +------------------------------+------------------------------------------------------------------------------------------+ | @@ -890,19 +1044,10 @@ A failed ConfigRestore action returns a failure response code and the specific f +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+-----------------------------------------------------------------+ | **Parameter** | **Description** | **Required?** | **Example** | +=================================+====================================================================================================================================================================================+=====================+=================================================================+ -| request- parameters | The parameters required to process the request must include the host-ip-address to connect to the VNF (for Chef and Ansible, this will be the url to connect to the server). | Yes | "payload": | -| | | | | -| | | | "{\"request-parameters | -| | | | | -| | | | \": { | -| | | | | -| | | | \"host-ip-address\\": \”value\” | -| | | | | -| | | | } | -| | | | | -| | | | \"configuration- parameters\": {\"<CONFIG- PARAMS>\"} | -+---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+-----------------------------------------------------------------+ -| configuration- parameters | A set of instance specific configuration parameters should be specified, as required by the Chef cookbook or Ansible playbook. | No | | +| request-parameters | Not used. This request is limited to Ansible and Chef only. | No | "payload": | +| | | | \"configuration-parameters\": {\"<CONFIG- PARAMS>\"} | ++---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+ | +| configuration-parameters | A set of instance specific configuration parameters should be specified, as required by the Chef cookbook or Ansible playbook. | No | | +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+-----------------------------------------------------------------+ ConfigRestore Response @@ -910,6 +1055,54 @@ ConfigRestore Response The ConfigRestore response returns an indication of success or failure of the request. + +DetachVolume +------------ + +The DetachVolume command detaches a cinder volume from a VM via an Openstack command. + +Cinder is a Block Storage service for OpenStack. It's designed to present storage resources to end users that can be consumed by the OpenStack Compute Project (Nova). The short description of Cinder is that it virtualizes the management of block storage devices and provides end users with a self-service API to request and consume those resources without requiring any knowledge of where their storage is actually deployed or on what type of device. + +NOTE: The command implementation is based on Openstack functionality. For further details, see http://developer.openstack.org/api-ref/compute/. + ++--------------------------+----------------------------------------------------------+ +| **Target URL** | /restconf /operations/ appc-provider-lcm:detach-volume | ++--------------------------+----------------------------------------------------------+ +| **Action** | DetachVolume | ++--------------------------+----------------------------------------------------------+ +| **Action-Identifiers** | vnf-id, vserver-id | ++--------------------------+----------------------------------------------------------+ +| **Payload Parameters** | See table | ++--------------------------+----------------------------------------------------------+ +| **Revision History** | New in Beijing | ++--------------------------+----------------------------------------------------------+ + +Request Payload Parameters: + ++-----------------------------+-----------------------------------------------------------------------------------------------------------------------------+--------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| **Payload Parameter** | **Description** | **Required** | **Example** | ++=============================+=============================================================================================================================+====================+================================================================================================================================+ +| volumeId | The UUID of the volume to detach. | Yes | "volumeId": "a26887c6-c47b-4654- abb5-dfadf7d3f803", | ++-----------------------------+-----------------------------------------------------------------------------------------------------------------------------+--------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| vm-id | The unique identifier (UUID) of the resource. For backwards- compatibility, this can be the self- link URL of the VM. | Yes | "vm-id": http://135.25.246.162:8774/v2/64a f07e991424b8e9e54eca27d5c0d48/ servers/b074cd1b-8d53-412e-a102- 351cc51ac10a" | ++-----------------------------+-----------------------------------------------------------------------------------------------------------------------------+--------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| Identity-url | The identity URL used to access the resource | No | "identity-url": "http://135.25.246.162:5000/v2.0" | ++-----------------------------+-----------------------------------------------------------------------------------------------------------------------------+--------------------+--------------------------------------------------------------------------------------------------------------------------------+ + +DetachVolume Response: +^^^^^^^^^^^^^^^^^^^^^^ + +**Success:** A successful DetachVolume returns a success status code 400. + +**Failure:** A failed DetachVolume returns a failure code 401 and the failure message. Failure messages can include: + +- badRequest +- unauthorized +- forbidden +- itemNotFound +- conflict + + Evacuate -------- @@ -934,7 +1127,7 @@ A successful Evacuate action returns a success response. A failed Evacuate actio +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | **Payload Parameters** | `vm-id <#_bookmark40>`__, `identity-url <#_bookmark41>`__, `tenant-id <#_bookmark42>`__, `rebuild-vm <#_bookmark43>`__, `targethost-id <#_bookmark44>`__ | +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| **Revision History** | Unchanged in this version. | +| **Revision History** | Unchanged in this release. | +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | @@ -943,31 +1136,22 @@ A successful Evacuate action returns a success response. A failed Evacuate actio | **Parameter** | **Description** | **Required?** | **Example** | +======================+==================================================================================================================================================================================+=====================+=======================================+ | vm-id | The unique identifier (UUID) of the resource. For backwards- compatibility, this can be the self- link URL of the VM. | Yes | "payload": | -| | | | | | | | | "{\"vm-id\": \"<VM-ID> | -| | | | | | | | | \", | -| | | | | | | | | \"identity-url\": | -| | | | | | | | | \"<IDENTITY-URL>\", | -| | | | | | | | | \"tenant-id\\": \"<TENANT-ID> | -| | | | | | | | | \", | -| | | | | | | | | \"rebuild-vm\": \"false\", | -| | | | | | | | | \"targethost-id\": | -| | | | | | | | | \"nodeblade7\"}" | -+----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---------------------------------------+ ++----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+ | | identity- url | The identity URL used to access the resource | No | | -+----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---------------------------------------+ ++----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+ | | tenant-id | The id of the provider tenant that owns the resource | No | | -+----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---------------------------------------+ ++----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+ | | rebuild- vm | A boolean flag indicating if a Rebuild is to be performed after an Evacuate. The default action is to do a Rebuild. It can be switched off by setting the flag to "false". | No | | -+----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---------------------------------------+ ++----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+ | | targethost- id | A target hostname indicating the host the VM is evacuated to. By default, the cloud determines the target host. | No | | +----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---------------------------------------+ @@ -976,9 +1160,7 @@ HealthCheck This command runs a VNF health check and returns the result. -A health check is VNF-specific. For a complex VNF, APPC initiates further subordinate health checks. - -HealthCheck is a VNF level command which interrogates the VNF in order to determine the health of the VNF and the VNFCs. The HealthCheck will be implemented differently for each VNF. +The VNF level HealthCheck is a check over the entire scope of the VNF. The VNF must be 100% healthy, ready to take requests and provide services, with all VNF required capabilities ready to provide services and with all active and standby resources fully ready with no open MINOR, MAJOR or CRITICAL alarms. +------------------------------+-----------------------------------------------------------+ @@ -988,22 +1170,62 @@ HealthCheck is a VNF level command which interrogates the VNF in order to determ +------------------------------+-----------------------------------------------------------+ | **Action-Identifiers** | Vnf-id | +------------------------------+-----------------------------------------------------------+ -| **Payload Parameters** | `vnf-host-ip-address <#_bookmark46>`__ | +| **Payload Parameters** | See below | +------------------------------+-----------------------------------------------------------+ -| **Revision History** | Changed in this version. | +| **Revision History** | Unchanged in this release | +------------------------------+-----------------------------------------------------------+ | -+-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------+-------------------------------------+ -| **Paramete** | **Description** | **Required?** | **Example** | -+=============================+================================================================================================================================================================+==================+=====================================+ -| vnf- host-ip- address | The IP address used to connect to the VNF, using a protocol such as SSH. For example, for a vSCP VNF, the floating IP address of the SMP should be used. | Yes | "payload": | -| | | | | -| | | | "{\"vnf-host-ip-address\": | -| | | | | -| | | | \"10.222.22.2\"}" | -+-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------+-------------------------------------+ ++---------------------+-----------------------------------+---------------------+-------------------------------------+ +| **Parameter** | **Description** | **Required?** | **Example** | ++=====================+===================================+=====================+=====================================+ +| host-ip-address | Required only if REST | No | | +| | service. This is the ip | | | +| | address associated with the | | | +| | VM running the REST | | | +| | service. | | | ++---------------------+-----------------------------------+---------------------+ | +| port-number | Required only if REST | No | "payload": | +| | service. This is the port | | "{\\"host-ip-address\\": | +| | number associated with the | | \\"10.222.22.2\\", | +| | REST service. | | \\”port-number\\”: \\”32\\”}" | +| | | | | ++---------------------+-----------------------------------+---------------------+-------------------------------------+ + + +HealthCheck Response +^^^^^^^^^^^^^^^^^^^^ + +The Healthcheck returns a 200 OK if the test completes. A JSON object is returned indicating state (healthy, unhealthy), scope identifier, time-stamp and one or more blocks containing info and fault information. + + Examples:: + + 200 + { + "identifier": "scope represented", + "state": "healthy", + "time": "01-01-1000:0000" + + } + + 200 + { + "identifier": "scope represented", + "state": "unhealthy", + {[ + "info": "System threshold exceeded details", + "fault": + { + "cpuOverall": 0.80, + "cpuThreshold": 0.45 + } + ]}, + "time": "01-01-1000:0000" + } + +If the VNF is unable to run the HealthCheck, it returns a standard http error code and message. APPC returns the error code 401 and the http error message. + Lock ---- @@ -1029,7 +1251,7 @@ APPC locks the target VNF during any VNF command processing. If a lock action is +------------------------------+---------------------------------------------------+ | **Payload Parameters** | None | +------------------------------+---------------------------------------------------+ -| **Revision History** | Unchanged in this version. | +| **Revision History** | Unchanged in this release. | +------------------------------+---------------------------------------------------+ Migrate @@ -1049,6 +1271,9 @@ A failed Migrate action returns a failure and the failure messages in the respon **NOTE:** The command implementation is based on Openstack functionality. For further details, see http://developer.openstack.org/api-ref/compute/. + ++--------------------------------+-----------------------------------------------------------------------------------------------+ +| **Input Block** | api-ver should be set to 2.00 for current version of Migrate | +--------------------------------+-----------------------------------------------------------------------------------------------+ | **Target URL** | /restconf/operations/appc-provider-lcm:migrate | +--------------------------------+-----------------------------------------------------------------------------------------------+ @@ -1058,7 +1283,7 @@ A failed Migrate action returns a failure and the failure messages in the respon +--------------------------------+-----------------------------------------------------------------------------------------------+ | \ **Payload Parameters** | `vm-id <#_bookmark52>`__, `identity-url <#_bookmark54>`__, `tenant-id <#_bookmark55>`__ | +--------------------------------+-----------------------------------------------------------------------------------------------+ -| **Revision History** | Unchanged in this version. | +| **Revision History** | Unchanged in this release. | +--------------------------------+-----------------------------------------------------------------------------------------------+ Payload Parameters @@ -1067,19 +1292,64 @@ Payload Parameters | **Parameter** | **Description** | **Required?** | **Example** | +=====================+=========================================================================+=====================+====================================+ | vm-id | The unique identifier (UUID) of | Yes | | -| | the resource. For backwards- compatibility, this can be the self- | | "payload": | -| | link URL of the VM. | | | +| | the resource. For backwards- compatibility, this can be the self- | | | +| | link URL of the VM. | | "payload": | | | | | "{\\"vm-id\": \\"<VM-ID>\\", | | | | | \\"identity-url\\": | -| | | | | | | | | \\"<IDENTITY-URL>\\", | -+---------------------+-------------------------------------------------------------------------+---------------------+ + -| identity- url | The identity url used to access the resource | No | \\"tenant-id\\": \\"<TENANT- | -| | | | ID>\\"}" | -+---------------------+-------------------------------------------------------------------------+---------------------+ + ++---------------------+-------------------------------------------------------------------------+---------------------+ \\"tenant-id\\": \\"<TENANT- | +| identity- url | The identity url used to access the resource | No | ID>\\"}" | +| | | | | ++---------------------+-------------------------------------------------------------------------+---------------------+ | | tenant-id | The id of the provider tenant that owns the resource | No | | +---------------------+-------------------------------------------------------------------------+---------------------+------------------------------------+ + +QuiesceTraffic +-------------- + +The QuiesceTraffic LCM action gracefully stops the traffic on the VNF (i.e., no service interruption for traffic in progress). All application processes are assumed to be running but no traffic is being processed. + +This command is executed using an Ansible playbook or Chef cookbook. + +Request Structure: + ++--------------------------+----------------------------------------------------------+ +| **Target URL** | /restconf/operations/appc-provider-lcm:quiesce-traffic | ++--------------------------+----------------------------------------------------------+ +| **Action** | QuiesceTraffic | ++--------------------------+----------------------------------------------------------+ +| **Action-identifiers** | vnf-id | ++--------------------------+----------------------------------------------------------+ +| **Payload Parameters** | operations-timeout | ++--------------------------+----------------------------------------------------------+ +| **Revision History** | New in Beijing | ++--------------------------+----------------------------------------------------------+ + +Request Payload Parameters: + ++-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+------------------------------------------------+ +| **Parameter** | **Description** | **Required?** | **Example** | ++=======================+======================================================================================================================================================================================================+=====================+================================================+ +| operations- timeout | This is the maximum time in seconds that the command will run before APPC returns a timeout error. If the APPC template has a lower timeout value, the APPC template timeout value is applied. | Yes | "payload": | +| | | | "{\\"operations-timeout\\": \\"3600\\"}” | ++-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+------------------------------------------------+ + +QuiesceTraffic Response +^^^^^^^^^^^^^^^^^^^^^^^ + +The response does not include any payload parameters. + +**Success:** A successful quiesce returns a success status code 400 after all traffic has been quiesced. + + If a quiesce command is executed and the traffic has been previously quiesced, it should return a success status. + +**Failure:** A failed quiesce returns a failure code 401 and the failure message from the Ansible or Chef server in the response payload block. + + A specific error message is returned if there is a timeout error. + + + Rebuild ------- @@ -1087,12 +1357,15 @@ Recreates a target VM instance to a known, stable state. Rebuild calls an OpenStack command immediately and therefore does not expect any prerequisite operations to be performed, such as shutting off a VM. -APPC only supports the rebuild operation for a VM that boots from image (snapshot), i.e., APPC rejects a rebuild request if it determines the VM boots from volume (disk). +Rebuild VM uses the latest snapshot by default; if there are no snapshots it uses the (original) Glance image for the rebuild. APPC rejects a rebuild request if it determines the VM boots from a Cinder Volume. A successful rebuild returns a success response and the rebuild details in the response payload block. A failed rebuild returns a failure and the failure messages in the response payload block. **NOTE:** The command implementation is based on Openstack functionality. For further details, see http://developer.openstack.org/api-ref/compute/. + ++------------------------------+-----------------------------------------------------------------------------------------------+ +| **Input Block** | api-ver should be set to 2.00 for current version of Rebuild | +------------------------------+-----------------------------------------------------------------------------------------------+ | **Target URL** | /restconf/operations/appc-provider-lcm:rebuild | +------------------------------+-----------------------------------------------------------------------------------------------+ @@ -1102,67 +1375,100 @@ A successful rebuild returns a success response and the rebuild details in the r +------------------------------+-----------------------------------------------------------------------------------------------+ | **Payload Parameters** | `vm-id <#_bookmark52>`__, `identity-url <#_bookmark54>`__, `tenant-id <#_bookmark55>`__ | +------------------------------+-----------------------------------------------------------------------------------------------+ -| **Revision History** | Unchanged in this version. | +| **Revision History** | Unchanged in this release. | +------------------------------+-----------------------------------------------------------------------------------------------+ + +Payload Parameters + ++-----------------+-----------------------------------------------+-----------------+-----------------------------------------+ +| **Parameter** | **Description** | **Required?** | **Example** | ++=================+===============================================+=================+=========================================+ +| vm-id | The unique identifier (UUID) of | Yes | | +| | the resource. For backwards- | | | +| | compatibility, this can be the self- | | "payload": | +| | link URL of the VM. | | "{\\"vm-id\\": \\"<VM-ID> | +| | | | \\", | +| | | | \\"identity-url\\": | +| | | | \\"<IDENTITY-URL>\\", | +| | | | \\"tenant-id\\": \\"<TENANT- ID>\\"}" | ++-----------------+-----------------------------------------------+-----------------+ | +| identity- url | The identity url used to access the | No | | +| | resource | | | ++-----------------+-----------------------------------------------+-----------------+ | +| tenant-id | The id of the provider tenant that owns | No | | +| | the resource | | | ++-----------------+-----------------------------------------------+-----------------+-----------------------------------------+ + + + Restart ------- -Use the Restart command to restart a VNF or a single VM. The generic VNF Restart uses a simple restart logic where all VM’s are stopped and re-started. - -The generic Restart operation is invoked either for the VM or the VNF level. +Use the Restart command to restart a VM. +------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| **Input Block** | api-ver must be set to 2.00 for *VNF Restart* | +| **Input Block** | api-ver should be set to 2.00 for current version of Restart | +------------------------------+-----------------------------------------------------------------------------------------------------------------+ | **Target URL** | /restconf/operations/appc-provider-lcm:restart | +------------------------------+-----------------------------------------------------------------------------------------------------------------+ | **Action** | Restart | +------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| **Action-identifiers** | Vnf-id is required; if restart is for a single VM, then vserver-id is also required. | +| **Action-identifiers** | vnf-id and vserver-id are required. | +------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| **Payload Parameters** | For *VNF* Restart: `host Identity <#_bookmark57>`__, `vnf-host-ip-address <#_bookmark58>`__ | -| | | -| | For *VM* Restart: `vm-id <#_bookmark52>`__, `identity-url <#_bookmark54>`__, `tenant-id <#_bookmark55>`__ | +| **Payload Parameters** | See table below | +------------------------------+-----------------------------------------------------------------------------------------------------------------+ -| **Revision History** | Revised in this version. | +| **Revision History** | Unchanged in this release | +------------------------------+-----------------------------------------------------------------------------------------------------------------+ -Payload Parameters for **VNF Restart** - -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---------------------------------------+ -| **Parameter** | **Description** | **Required?** | **Example** | -+=============================+===================================================================================================================================================================+=====================+=======================================+ -| Cloud Identity | The identity URL of the OpenStack host on which the VNF resource was created. If not provided, this information will be retrieved from the properties file. | No | "payload": | -| | | | "{\\" vnf-host-ip-address \\": | -| | | | | -| | | | \\"<VNF\_FLOATING\_IP\_ADDRESS> | -| | | | \\", | -| | | | \\" hostIdentity \\": | -| | | | \\"<OpenStack IP Address>\\" | -| | | | }" | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---------------------------------------+ -| vnf- host-ip- address | The IP address used to connect to the VNF, using a protocol such as SSH. For example, for a vSCP VNF, the floating IP address of the SMP should be used. | Yes | | -+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---------------------------------------+ - Payload Parameters for **VM Restart** +---------------------+-------------------------------------------------------------------------+---------------------+------------------------------------+ | **Parameter** | **Description** | **Required?** | **Example** | +=====================+=========================================================================+=====================+====================================+ | vm-id | The unique identifier (UUID) of | Yes | | -| | the resource. For backwards- compatibility, this can be the self- | | "payload": | -| | link URL of the VM. | | | +| | the resource. For backwards- compatibility, this can be the self- | | | +| | link URL of the VM. | | "payload": | | | | | "{\\"vm-id\\": \\"<VM-ID>\\", | | | | | \\"identity-url\\": | -| | | | | +---------------------+-------------------------------------------------------------------------+---------------------+ \\"<IDENTITY-URL>\\", | | identity- url | The identity url used to access the resource | No | \"tenant-id\": \"<TENANT- | | | | | ID>\"}" | -+---------------------+-------------------------------------------------------------------------+---------------------+ + ++---------------------+-------------------------------------------------------------------------+---------------------+ | | tenant-id | The id of the provider tenant that owns the resource | No | | +---------------------+-------------------------------------------------------------------------+---------------------+------------------------------------+ +ResumeTraffic +------------- + +The ResumeTraffic LCM action resumes processing traffic on a VNF that has been previously quiesced. + +This command is executed using an Ansible playbook or Chef cookbook. + +Request Structure: The payload does not have any parameters. + ++--------------------------+---------------------------------------------------------+ +| **Target URL** | /restconf/operations/appc-provider-lcm:resume-traffic | ++--------------------------+---------------------------------------------------------+ +| **Action** | ResumeTraffic | ++--------------------------+---------------------------------------------------------+ +| **Action-identifiers** | vnf-id | ++--------------------------+---------------------------------------------------------+ +| **Payload Parameters** | | ++--------------------------+---------------------------------------------------------+ +| **Revision History** | New in Beijing | ++--------------------------+---------------------------------------------------------+ + +ResumeTraffic Response +^^^^^^^^^^^^^^^^^^^^^^ + +**Success:** A successful ResumeTraffic returns a success status code 400 after traffic has been resumed. + +If a ResumeTraffic command is executed and the traffic is currently being processed, it should return a success status + +**Failure:** A failed ResumeTraffic returns a failure code 401 and the failure message from the Ansible or Chef server in the response payload block. + + Snapshot -------- @@ -1172,6 +1478,8 @@ The Snapshot command returns a customized response containing a reference to the This command can be applied to any VNF type. The only restriction is that the particular VNF should be built based on the generic heat stack. +Note: Snapshot is not reliable unless the VM is in a stopped, paused, or quiesced (no traffic being processed) status. It is up to the caller to ensure that the VM is in one of these states. + **NOTE:** The command implementation is based on Openstack functionality. For further details, see http://developer.openstack.org/api-ref/compute/. +------------------------------+-----------------------------------------------------------------------------------------------------+ @@ -1183,7 +1491,7 @@ This command can be applied to any VNF type. The only restriction is that the pa +------------------------------+-----------------------------------------------------------------------------------------------------+ | **Payload Parameters** | `vm-id <#_bookmark52>`__, `identity-url <#_bookmark54>`__, `tenant-id <#_bookmark55>`__ | +------------------------------+-----------------------------------------------------------------------------------------------------+ -| **Revision History** | Unchanged in this version. | +| **Revision History** | Unchanged in this release. | +------------------------------+-----------------------------------------------------------------------------------------------------+ Payload Parameters @@ -1192,19 +1500,15 @@ Payload Parameters | **Parameter** | **Description** | **Required?** | **Example** | +=====================+=========================================================================+=====================+====================================+ | vm-id | The unique identifier (UUID) of | Yes | | -+---------------------+-------------------------------------------------------------------------+---------------------+------------------------------------+ | | the resource. For backwards- compatibility, this can be the self- | | "payload": | -| | link URL of the VM. | | | -| | | | "{\\"vm-id\": \\"<VM-ID> | -| | | | | +| | link URL of the VM. | | "{\\"vm-id\": \\"<VM-ID> | | | | | \\", | -| | link URL of the VM. | | \\"identity-url\\": | -| | | | | +| | | | \\"identity-url\\": | | | | | \\"<IDENTITY-URL>\\", | -+---------------------+-------------------------------------------------------------------------+---------------------+ + -| identity- url | The identity url used to access the resource | No | \\"tenant-id\\": \\"<TENANT- | -| | | | ID>\\"}" | -+---------------------+-------------------------------------------------------------------------+---------------------+------------------------------------+ ++---------------------+-------------------------------------------------------------------------+---------------------+ \\"tenant-id\\": \\"<TENANT- | +| identity- url | The identity url used to access the resource | No | ID>\\"}" | +| | | | | ++---------------------+-------------------------------------------------------------------------+---------------------+ | | tenant-id | The id of the provider tenant that owns the resource | No | | +---------------------+-------------------------------------------------------------------------+---------------------+------------------------------------+ @@ -1235,13 +1539,34 @@ Use the Start command to start a VNF, VF-Module, or VM that is stopped or not ru +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ | **Action** | Start | +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| **Action-identifiers** | Vnf-id is required; vf-module-id or vserver-id is also required if the action is at vf-module or vm level, respectively. | +| **Action-identifiers** | vnf-id and vserver-id are required | +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| **Payload Parameters** | None | +| **Payload Parameters** | See below | +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| **Revision History** | Revised in this version. | +| **Revision History** | Unchanged in this release | +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ +Payload Parameters + ++-----------------+-----------------------------------------------+-----------------+-----------------------------------------+ +| **Parameter** | **Description** | **Required?** | **Example** | ++=================+===============================================+=================+=========================================+ +| vm-id | The unique identifier (UUID) of | Yes | | +| | the resource. For backwards- | | "payload": | +| | compatibility, this can be the self- | | "{\\"vm-id\\": \\"<VM-ID> | +| | link URL of the VM. | | \\", | +| | | | \\"identity-url\\": | +| | | | \\"<IDENTITY-URL>\\", | +| | | | \\"tenant-id\\": \\"<TENANT- ID>\\"}" | ++-----------------+-----------------------------------------------+-----------------+-----------------------------------------+ +| identity- url | The identity url used to access the | No | | +| | resource | | | ++-----------------+-----------------------------------------------+-----------------+-----------------------------------------+ +| tenant-id | The id of the provider tenant that owns | No | | +| | the resource | | | ++-----------------+-----------------------------------------------+-----------------+-----------------------------------------+ + + StartApplication ---------------- @@ -1260,7 +1585,7 @@ A failed StartApplication action returns a failure response code and the specifi +------------------------------+---------------------------------------------------------------+ | **Payload Parameters** | See below | +------------------------------+---------------------------------------------------------------+ -| **Revision History** | New in this version. | +| **Revision History** | Unchanged in this release. | +------------------------------+---------------------------------------------------------------+ | @@ -1269,13 +1594,12 @@ A failed StartApplication action returns a failure response code and the specifi | **Payload Parameter** | **Description** | **Required?** | **Example** | +=================================+====================================================================================================================================================================================+=====================+=================================================================+ | request- parameters | The parameters required to process the request must include the host-ip-address to connect to the VNF (for Chef and Ansible, this will be the url to connect to the server). | Yes | "payload": | -| | | | | | | | | "{\\"request-parameters | | | | | \\": { | | | | | \\"host-ip-address\\": \\”value\\” | | | | | } | | | | | \\"configuration- parameters\\": {\\"<CONFIG- PARAMS>\\"} | -+---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+-----------------------------------------------------------------+ ++---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+ | | configuration- parameters | A set of instance specific configuration parameters should be specified, as required by the Chef cookbook or Ansible playbook. | No | | +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+-----------------------------------------------------------------+ @@ -1287,7 +1611,7 @@ The StartApplication response returns an indication of success or failure of the Stop ---- -Use the Stop command to start a VNF, VF-Module, or VM that is stopped or not running. +Use the Stop command to stop a VM. **NOTE:** The command implementation is based on Openstack functionality. For further details, see http://developer.openstack.org/api-ref/compute/. @@ -1296,13 +1620,34 @@ Use the Stop command to start a VNF, VF-Module, or VM that is stopped or not run +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ | **Action** | Stop | +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| **Action-identifiers** | Vnf-id is required; vf-module-id or vserver-id is also required if the action is at vf-module or vm level, respectively. | +| **Action-identifiers** | vnf-id and vserver-id are required. | +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| **Payload Parameters** | None | +| **Payload Parameters** | See below | +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| **Revision History** | Revised in this version. | +| **Revision History** | Unchanged in this release | +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ +Payload Parameters + ++-----------------+-----------------------------------------------+-----------------+-----------------------------------------+ +| **Parameter** | **Description** | **Required?** | **Example** | ++=================+===============================================+=================+=========================================+ +| vm-id | The unique identifier (UUID) of | Yes | | +| | the resource. For backwards- | | "payload": | +| | compatibility, this can be the self- | | "{\\"vm-id\\": \\"<VM-ID> | +| | link URL of the VM. | | \\", | +| | | | \\"identity-url\\": | +| | | | \\"<IDENTITY-URL>\\", | +| | | | \\"tenant-id\\": \\"<TENANT- ID>\\"}" | ++-----------------+-----------------------------------------------+-----------------+-----------------------------------------+ +| identity- url | The identity url used to access the | No | | +| | resource | | | ++-----------------+-----------------------------------------------+-----------------+-----------------------------------------+ +| tenant-id | The id of the provider tenant that owns | No | | +| | the resource | | | ++-----------------+-----------------------------------------------+-----------------+-----------------------------------------+ + + StopApplication --------------- @@ -1321,7 +1666,7 @@ A failed StopApplication action returns a failure response code and the specific +------------------------------+--------------------------------------------------------------+ | **Payload Parameters** | See below | +------------------------------+--------------------------------------------------------------+ -| **Revision History** | New in this version. | +| **Revision History** | Unchanged in this release | +------------------------------+--------------------------------------------------------------+ | @@ -1364,7 +1709,7 @@ This command can be applied to any VNF type. The only restriction is that the VN +------------------------------+---------------------------------------------------+ | **Payload Parameters** | None | +------------------------------+---------------------------------------------------+ -| **Revision History** | Unchanged in this version. | +| **Revision History** | Unchanged in this release. | +------------------------------+---------------------------------------------------+ Unlock @@ -1391,6 +1736,268 @@ Note: APPC locks the target VNF during any command processing. If an Unlock acti +------------------------------+-----------------------------------------------------+ | **Payload Parameters** | None | +------------------------------+-----------------------------------------------------+ -| **Revision History** | Unchanged in this version. | +| **Revision History** | Unchanged in this release. | +------------------------------+-----------------------------------------------------+ + +UpgradeBackout +-------------- + +The UpgradeBackout LCM action does a backout after an UpgradeSoftware is completed (either successfully or unsuccessfully). + +This command is executed using an Ansible playbook or Chef cookbook. + +Request Structure: The request payload includes an upgrade identifier. + ++--------------------------+----------------------------------------------------------+ +| **Target URL** | /restconf/operations/appc-provider-lcm:upgrade-backout | ++--------------------------+----------------------------------------------------------+ +| **Action** | UpgradeBackout | ++--------------------------+----------------------------------------------------------+ +| **Action-identifiers** | vnf-id | ++--------------------------+----------------------------------------------------------+ +| **Payload Parameters** | existing-software-version, new-software-version | ++--------------------------+----------------------------------------------------------+ +| **Revision History** | New in Beijing | ++--------------------------+----------------------------------------------------------+ + +Request Payload Parameters: + ++-----------------------+-------------------------------------+---------------------+-----------------------------------------------------------------------------------------------+ +| **Parameter** | **Description** | **Required?** | **Example** | ++=======================+=====================================+=====================+===============================================================================================+ +| existing-software- | The existing software version | Yes | "payload": | +| version | prior to the upgrade | | "{\\"existing-software-version\\": \\"3.1\\", "{\\"new-software-version\\": \\"3.2\\"}” | ++-----------------------+-------------------------------------+---------------------+ | +| new-software- | The new software | Yes | | +| version | version after the | | | +| | upgrade | | | ++-----------------------+-------------------------------------+---------------------+-----------------------------------------------------------------------------------------------+ + +UpgradeBackout Response +^^^^^^^^^^^^^^^^^^^^^^^ + +**Success:** A successful backout returns a success status code 400. + +**Failure:** A failed backout returns a failure code 401 and the failure message from the Ansible or Chef server in the response payload block. + +UpgradeBackup +------------- + +The UpgradeBackup LCM action does a full backup of the VNF data prior to an upgrade. The backup is done on the Ansible or Chef server in a location that is specified in the playbook or cookbook. If there is an existing backup, it is overwritten by the new backup. + +This command is executed using an Ansible playbook or Chef cookbook. + +Request Structure: The payload does not have any parameters required. + ++--------------------------+---------------------------------------------------------+ +| **Target URL** | /restconf/operations/appc-provider-lcm:upgrade-backup | ++--------------------------+---------------------------------------------------------+ +| **Action** | UpgradeBackup | ++--------------------------+---------------------------------------------------------+ +| **Action-identifiers** | vnf-id | ++--------------------------+---------------------------------------------------------+ +| **Payload Parameters** | existing-software-version, new-software-version | ++--------------------------+---------------------------------------------------------+ +| **Revision History** | New in Beijing. | ++--------------------------+---------------------------------------------------------+ + +Request Payload Parameters: + ++-----------------------+-------------------------------------+---------------------+-----------------------------------------------------------------------------------------------+ +| **Parameter** | **Description** | **Required?** | **Example** | ++=======================+=====================================+=====================+===============================================================================================+ +| existing-software- | The existing software version | Yes | "payload": | +| version | prior to the upgrade | | "{\\"existing-software-version\\": \\"3.1\\", "{\\"new-software-version\\": \\"3.2\\"}” | ++-----------------------+-------------------------------------+---------------------+ | +| new-software- | The new software | Yes | | +| version | version after the | | | ++-----------------------+-------------------------------------+---------------------+-----------------------------------------------------------------------------------------------+ + +UpgradeBackup Response +^^^^^^^^^^^^^^^^^^^^^^ + +**Success:** A successful backup returns a success status code 400. + +**Failure:** A failed backup returns a failure code 401 and the failure message from the Ansible or Chef server in the response payload block. + +UpgradePostCheck +---------------- + +The UpgradePostCheck LCM action checks that the VNF upgrade has been successful completed and all processes are running properly. + +This command is executed using an Ansible playbook or Chef cookbook. + +Request Structure: + ++--------------------------+-------------------------------------------------------------+ +| **Target URL** | /restconf/operations/appc-provider-lcm:upgrade-post-check | ++--------------------------+-------------------------------------------------------------+ +| **Action** | UpgradePostCheck | ++--------------------------+-------------------------------------------------------------+ +| **Action-identifiers** | vnf-id | ++--------------------------+-------------------------------------------------------------+ +| **Payload Parameters** | existing-software-version, new-software-version | ++--------------------------+-------------------------------------------------------------+ +| **Revision History** | New in Beijing | ++--------------------------+-------------------------------------------------------------+ + +Request Payload Parameters: + ++-----------------------+-------------------------------------+---------------------+-----------------------------------------------------------------------------------------------+ +| **Parameter** | **Description** | **Required?** | **Example** | ++=======================+=====================================+=====================+===============================================================================================+ +| existing- software- | The existing software version | Yes | "payload": | +| version | prior to the upgrade | | "{\\"existing-software-version\\": \\"3.1\\", "{\\"new-software-version\\": \\"3.2\\"}” | ++-----------------------+-------------------------------------+---------------------+ | +| new-software- | The new software | Yes | | +| version | version after the | | | ++-----------------------+-------------------------------------+---------------------+-----------------------------------------------------------------------------------------------+ + +UpgradePostCheck Response +^^^^^^^^^^^^^^^^^^^^^^^^^ + +**Success:** If the UpgradePostCheck run successfully, it returns a success status code 400. The response payload contains the results of the check (Completed or Failed). + +Response Payload Parameters: + ++---------------+-----------------------------+-------------+------------------------------------------------------------------------------+ +| **Parameter** | **Description** |**Required?**| **Example** | ++===============+=============================+=============+==============================================================================+ +| Upgrade- | Returns the status | Yes | | +| Status | of the upgradw | | "payload": | +| | post-check. Indicates | | "{\\"upgrade-status\\": \\"Completed\\"}” | +| | Completed or Failed | | "payload": "{\\"upgrade-status\\": | +| | | | \\"Failed\\",\\"message\\": \\"Version 3.2 is not running properly\\" }” | ++---------------+-----------------------------+-------------+ | +| Message | If Not Available, | | | +| | message contains | | | +| | explanation. | | | ++---------------+-----------------------------+-------------+------------------------------------------------------------------------------+ + +**Failure:** If the UpgradePostCheck could not be run, it returns a failure code 401 and the failure message from the Ansible or Chef server in the response payload block. + +UpgradePreCheck +--------------- + +The UpgradePreCheck LCM action checks that the VNF has the correct software version needed for a software upgrade. This command can be executed on a running VNF (i.e. processing traffic). + +This command is executed using an Ansible playbook or Chef cookbook. + +Request Structure: + ++--------------------------+------------------------------------------------------------+ +| **Target URL** | /restconf/operations/appc-provider-lcm:upgrade-pre-check | ++--------------------------+------------------------------------------------------------+ +| **Action** | UpgradePreCheck | ++--------------------------+------------------------------------------------------------+ +| **Action-identifiers** | vnf-id | ++--------------------------+------------------------------------------------------------+ +| **Payload Parameters** | existing-software-version, new-software-version | ++--------------------------+------------------------------------------------------------+ +| **Revision History** | New in Beijing | ++--------------------------+------------------------------------------------------------+ + +Request Payload Parameters: + ++-----------------------+-------------------------------------+---------------------+-----------------------------------------------------------------------------------------------+ +| **Parameter** | **Description** | **Required?** | **Example** | ++=======================+=====================================+=====================+===============================================================================================+ +| existing-software- | The existing software version | Yes | "payload": | +| version | prior to the upgrade | | "{\\"existing-software-version\\": \\"3.1\\", "{\\"new-software-version\\": \\"3.2\\"}” | ++-----------------------+-------------------------------------+---------------------+ | +| new-software- | The new software | Yes | | +| version | version after the | | | +| | upgrade | | | ++-----------------------+-------------------------------------+---------------------+-----------------------------------------------------------------------------------------------+ + +UpgradePreCheck Response +^^^^^^^^^^^^^^^^^^^^^^^^ + +**Success:** If the UpgradePreCheck runs successfully, it returns a success status code 400. The response payload contains the results of the check (Available or Not Available for upgrade). + +Response Payload Parameters: + ++-----------------+---------------------------+---------------------+----------------------------------------------------------------------------------------------------------------------------------+ +| **Parameter** | **Description** | **Required?** | **Example** | ++=================+===========================+=====================+==================================================================================================================================+ +| upgrade-status | Returns the status | Yes | | +| | of the upgrade pre- | | "payload": | +| | check. Indicates | | "{\\"upgrade-status\\": \\"Available\\"}” | +| | Available or Not | | | +| | Available | | "payload": | +| | | | "{\\"upgrade-status\\": \\"Not Available\\",\\"message\\": \\"Current software version 2.9 cannot be upgraded to 3.1\\" }” | ++-----------------+---------------------------+---------------------+ | +| message | If Not Available, | | | +| | message contains | | | +| | explanation. | | | ++-----------------+---------------------------+---------------------+----------------------------------------------------------------------------------------------------------------------------------+ + +**Failure:** If an UpgradePreCheck fails to run, it returns a failure code 401 and the failure message from the Ansible or Chef server in the response payload block. + +UpgradeSoftware +--------------- + +The UpgradeSoftware LCM action upgrades the target VNF to a new version. It is expected that the VNF is in a quiesced status (not processing traffic). + +This command is executed using an Ansible playbook or Chef cookbook. + +Request Structure: The request payload includes the new-software-version. + ++--------------------------+-----------------------------------------------------------+ +| **Target URL** | /restconf/operations/appc-provider-lcm:upgrade-software | ++--------------------------+-----------------------------------------------------------+ +| **Action** | UpgradeSoftware | ++--------------------------+-----------------------------------------------------------+ +| **Action-identifiers** | vnf-id | ++--------------------------+-----------------------------------------------------------+ +| **Payload Parameters** | existing-software-version, new-software-version | ++--------------------------+-----------------------------------------------------------+ +| **Revision History** | New in Beijing | ++--------------------------+-----------------------------------------------------------+ + + Request Payload Parameters: + ++-----------------------+-------------------------------------+---------------------+-----------------------------------------------------------------------------------------------+ +| **Parameter** | **Description** | **Required?** | **Example** | ++=======================+=====================================+=====================+===============================================================================================+ +| existing- software- | The existing software version | Yes | "payload": | +| version | prior to the upgrade | | "{\\"existing-software-version\\": \\"3.1\\", "{\\"new-software-version\\": \\"3.2\\"}” | ++-----------------------+-------------------------------------+---------------------+ | +| new-software | The new software | Yes | | +| version | version after the | | | +| | upgrade | | | ++-----------------------+-------------------------------------+---------------------+-----------------------------------------------------------------------------------------------+ + +UpgradeSoftware Response +^^^^^^^^^^^^^^^^^^^^^^^^ + +**Success:** A successful upgrade returns a success status code 400. + +If an UpgradeSoftware command is executed and the software has been previously upgraded to this version, it should return a success status. + +**Failure:** A failed upgrade returns a failure code 401 and the failure message from the Ansible or Chef server in the response payload block. A failure does not assume that the software upgrade has been rolled back. + +Notes regarding the Upgrade commands +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Ansible playbooks / Chef cookbooks: + +- All Ansible playbooks/cookbooks for the Upgrade commands will be + stored in the same directory on the server. The directory name will + be of the format: + + {existing-software-version\_new-software-version}. + + The path to the directory is the same for all upgrades (for example: vnf-type/softwareupgrade). + +- The playbooks for upgrades should use a standard naming convention + (for example: SoftwareUpgrade\_{existing-software-version\_new-software-version}). + +APPC template: The APPC templates for the Upgrade commands can be common across upgrades for the vnf-type if the path and filenames are standardized. + +- The template will contain the directory path/playbook name which + would be parameterized. + + {vnf-type}/UpgradeSoftware/${existing\_software\_version}\_${new-software-version}/ + SoftwareUpgrade\_{existing-software-version\_new-software-version}. + |