5G - PNF SW Upgrade (Casablanca carry-over items)
This is a continuation of the use case started in Casablanca: 5G - PNF Software Update
Background (R3 Casablanca)
In Casablanca, the UC leveraged the Ansible adaptor of ONAP controller to implement three S/W upgrade related operations for 5G PNFs. As an important feature the new workflow supports an External Controller (EC) in the execution of these operations. All these operations have shared the same LCM APIs with VNF S/W upgrade with PNF specific parameters passed in the API payloads. The corresponding DGs of LCM APIs are updated. The operations are:
/operations/LCM:upgrade-pre-check
/operations/LCM:upgrade-software
/operations/LCM:upgrade-post-check
Dublin Scope
For Dublin, the target of this UC includes:
3GPP Software Management API alignment
South-bound of SDNC: Extend upgrade-software operation by leveraging sub-operations from 3GPP (like download/install/activate).
North-bound of SDNC: Rollback/fallback API support for 5G PNF
Workflow support for PNF in-place SW upgrade in SO (stretch goal)
Presentations and Discussion Slides:
Related Meeting Links
[usecase] Platform Evolution for Use Case Realization w/ SO, AAI, DCAE, SDC, VID, SDNC, https://zoom.us/j/723094623
Development Status
Proposed Dublin scope presented Dec 20, 2018 to the 5G UC meeting.
Project | PTL/Contancts | JIRA | Description | Status |
|---|---|---|---|---|
APPC SDNC CCSDK | @Takamune Cho @Dan Timoney |
| ||
VF-C | @Yan Yang @Xiang Li[CMCC] | No Impact | ||
SO VID | @Seshu Kumar Mudiganti @ittay |
| ||
Integration | @Yang Xu | No impact | ||
External Controller | @Enbo Wang @wangyaoguang | Support for 3GPP API calls for sw download, install and activate. |
Project Impacts | Description | JIRA Links |
SDNC/CCSDK | Add SDNC LCM action - rollback | |
Complete rollback LCM action for PNF S/W upgrade | ||
Create a DG for PNF S/W upgrade | ||
Provide corresponding Ansible playbook for rollback operation | ||
Extend PNF upgrade-software operation by leveraging sub-operations from 3GPP (like downloadNESw/installNESw/activateNESw) | ||
External Controller | Support swFallback/downloadNESw/installNESw/activateNESw operations | NA |
Requirements Impact
CCSDK → Changes in lcm.yang file
SDN-C → (1) New ansible playbooks, (2) New DG for rollback
EC → New substeps such as sw download, install and activate
API Changes
Yang model changes to current LCM:rollback action in CCSDK (mandatory fields in rollback action will be optional to make the LCM:rollback action more generic, optional output payload field is added)
Definition of rollback input and output payloads for 5G PNF specific rollback
Possible payload changes into existing API /operations/LCM:upgrade-software
sw download, install and activate APIs in southbound of SDNC (to EC) as part of Ansible playbook for LCM:upgrade-software API.
API Details
(1) Provided by SDN-C/CCSDK:
LCM API Abbre. | HTTP Method | URI | Yang Model Section | Request Example | Response Example |
|---|---|---|---|---|---|
rollback | Post | /operations/LCM:rollback | rpc rollback {
description "An operation to rollback to particular snapshot of a virtual network function (or VM)";
input {
uses common-header;
leaf action {
type action;
mandatory true;
}
uses action-identifiers;
leaf payload {
type payload;
mandatory false;
}
leaf identity-url {
type string;
mandatory false;
}
leaf snapshot-id {
type string;
mandatory false;
}
}
output {
uses common-header;
uses status;
leaf payload {
type payload;
mandatory false;
}
}
} | {
"input": {
"action": "Rollback",
"action-identifiers": {
"vnf-id": "5gDU0001"
},
"common-header": {
"api-ver": "2.00",
"flags": {
"force": "FALSE",
"mode": "NORMAL",
"ttl": 65000
},
"originator-id": "MSO",
"request-id": "a1171d12-2ae9-496b-a2df-99784572914d",
"sub-request-id": "a1171d12-2ae9-496b-a2df-99784572914d",
"timestamp": "2019-03-15T09:07:58.255Z"
},
"payload": "{\"pnf-flag\":\"true\", \"ipaddress-v4-oam\": \"192.168.35.83\", \"filter\": \"\\\\'$..[?(@.nEIdentification == \\\\\\\"5gDU0001\\\\\\\")]\\\\'\"}"
}
}
| 400: Success {
"output": {
"common-header": {
"api-ver": "2.00",
"originator-id": "MSO",
"request-id": "a1171d12-2ae9-496b-a2df-99784572914d",
"sub-request-id": "a1171d12-2ae9-496b-a2df-99784572914d"
},
"payload": "{\"nEList\": [{\"nEIdentification\": \"5gDU0001\", \"swFallbackStatus\": \"fallbackSuccessful\"}], \"result\": \"Success\"}",
"status": {
"code": 400,
"message": "Ansible Request 2e0690ed-6b7a-43b1-a061-8e4ac7534609 finished with Result = success, Message = FINISHED"
}
}
} |
precheck* | /operations/LCM:upgrade-pre-check | rpc upgrade-pre-check {
description "An operation to check that the VNF has the correct software version needed for a software upgrade.";
input {
uses common-header;
leaf action {
type action;
mandatory true;
}
uses action-identifiers;
leaf payload {
type payload;
mandatory true;
}
}
output {
uses common-header;
uses status;
leaf payload {
type payload;
mandatory true;
}
}
} | {
"input": {
"action": "UpgradePreCheck",
"action-identifiers": {
"vnf-id": "5gDU0001"
},
"common-header": {
"api-ver": "2.00",
"flags": {
"force": "FALSE",
"mode": "NORMAL",
"ttl": 65000
},
"originator-id": "MSO",
"request-id": "a1171d12-2ae9-496b-a2df-99784572914d",
"sub-request-id": "a1171d12-2ae9-496b-a2df-99784572914d",
"timestamp": "2019-03-15T09:07:58.255Z"
},
"payload": "{\"pnf-flag\":\"true\", \"pnf-name\": \"5gDU0001\",\"pnfId\": \"5gDU0001\", \"ipaddress-v4-oam\": \"192.168.35.83\",\"oldSwVersion\": \"v1\", \"targetSwVersion\": \"v2\", \"ruleName\": \"r001\", \"Id\": \"10\", \"additionalData\":\"{}\"}"
}
}
| 400: Success {
"output": {
"common-header": {
"api-ver": "2.00",
"originator-id": "MSO",
"request-id": "a1171d12-2ae9-496b-a2df-99784572914d",
"sub-request-id": "a1171d12-2ae9-496b-a2df-99784572914d"
},
"payload": "{\"result\": \"Success\"}",
"status": {
"code": 400,
"message": "Ansible Request f0f45105-1a51-4592-a31b-f178d5eb4638 finished with Result = success, Message = FINISHED"
}
}
}
| |
postcheck* | /operations/LCM:upgrade-post-check | rpc upgrade-post-check {
description "An operation to check the VNF upgrade has been successful completed and all processes are running properly.";
input {
uses common-header;
leaf action {
type action;
mandatory true;
}
uses action-identifiers;
leaf payload {
type payload;
mandatory true;
}
}
output {
uses common-header;
uses status;
leaf payload {
type payload;
mandatory true;
}
}
} | {
"input": {
"action": "UpgradePostCheck",
"action-identifiers": {
"vnf-id": "5gDU0001"
},
"common-header": {
"api-ver": "2.00",
"flags": {
"force": "FALSE",
"mode": "NORMAL",
"ttl": 65000
},
"originator-id": "MSO",
"request-id": "a1171d12-2ae9-496b-a2df-99784572914d",
"sub-request-id": "a1171d12-2ae9-496b-a2df-99784572914d",
"timestamp": "2019-02-23T09:07:58.255Z"
},
"payload": "{\"pnf-flag\":\"true\", \"pnf-name\": \"5gDU0001\",\"pnfId\": \"5gDU0001\", \"ipaddress-v4-oam\": UpgradePostCheck\"192.168.35.83\",\"oldSwVersion\": \"v1\", \"targetSwVersion\": \"v2\", \"ruleName\": \"r102\", \"Id\": \"10\", \"additionalData\":\"{}\"}"
}
}
| 400: Success {
"output": {
"common-header": {
"api-ver": "2.00",
"originator-id": "MSO",
"request-id": "a1171d12-2ae9-496b-a2df-99784572914d",
"sub-request-id": "a1171d12-2ae9-496b-a2df-99784572914d"
},
"payload": "{\"result\": \"Success\"}",
"status": {
"code": 400,
"message": "Ansible Request c1c14dee-a80d-40b8-800a-9216a27c7d1c finished with Result = success, Message = FINISHED"
}
}
}
| |
upgrade-software* | /operations/LCM:upgrade-software | rpc upgrade-software {
description "An operation to upgrade the target VNF to a new version and expected that the VNF is in a quiesced status .";
input {
uses common-header;
leaf action {
type action;
mandatory true;
}
uses action-identifiers;
leaf payload {
type payload;
mandatory true;
}
}
output {
uses common-header;
uses status;
}
} | {
"input": {
"action": "UpgradeSoftware",
"action-identifiers": {
"vnf-id": "5gDU0001"
},
"common-header": {
"api-ver": "2.00",
"flags": {
"force": "FALSE",
"mode": "NORMAL",
"ttl": 65000
},
"originator-id": "MSO",
"request-id": "a1171d12-2ae9-496b-a2df-99784572914d",
"sub-request-id": "a1171d12-2ae9-496b-a2df-99784572914d",
"timestamp": "2019-03-15T09:07:58.255Z"
},
"payload": "{\"pnf-flag\":\"true\", \"pnfId\": \"5gDU0001\", \"ipaddress-v4-oam\": \"192.168.35.83\", \"targetSwVersion\": \"\\\\'[{\\\\\\\"swLocation\\\\\\\": \\\\\\\"http://192.168.35.96:10080/ran_du_pkg1-v2.zip\\\\\\\", \\\\\\\"swFileSize\\\\\\\": 353, \\\\\\\"swFileCompression\\\\\\\": \\\\\\\"ZIP\\\\\\\", \\\\\\\"swFileFormat\\\\\\\": \\\\\\\"zip\\\\\\\"}, {\\\\\\\"swLocation\\\\\\\": \\\\\\\"http://192.168.35.96:10080/ran_du_pkg2-v2.zip\\\\\\\", \\\\\\\"swFileSize\\\\\\\": 353, \\\\\\\"swFileCompression\\\\\\\": \\\\\\\"ZIP\\\\\\\", \\\\\\\"swFileFormat\\\\\\\": \\\\\\\"zip\\\\\\\"}]\\\\'\"}"
}
}
| 400: Success {
"output": {
"common-header": {
"api-ver": "2.00",
"originator-id": "MSO",
"request-id": "a1171d12-2ae9-496b-a2df-99784572914d",
"sub-request-id": "a1171d12-2ae9-496b-a2df-99784572914d"
},
"status": {
"code": 400,
"message": "Ansible Request a3962a33-86ba-4346-8ef2-e2890d1ba734 finished with Result = success, Message = FINISHED"
}
}
} |
*: These lcm APIs inherit from R3.
The grammar of filter parameter of rollback API is JsonPath.
New optional parameters of payload for request of upgrade-software API:
swToBeDownloaded: Used to substitute the targetSwVersion parameter for aligning with 3GPP operation.
neIdentifier: Used to substitute the pnfId parameter for aligning with 3GPP operation.
swToBeInstalled: Used to manually specify the software to be installed for aligning with 3GPP operation.
swVersionToBeActivated: Used to manually specify the software version to be activated for aligning with 3GPP operation.
(2) Provided by External Controller.
Test Cases and Status
Master Integration Test Page: Dublin Release Integration Testing Status
# | Test Case Description | Test Status |
|---|---|---|
1 PreCheck test | Ensure LCM:upgrade-pre-check can be executed (north-bound of SDNC) | PASS |
2 SwUpgrade test | Ensure LCM:upgrade-software can be executed (north-bound of SDNC) | PASS |
3 PostCheck test | Ensure LCM:upgrade-post-check can be executed (north-bound of SDNC) | PASS |
4 SwRollback test | Ensure LCM:rollback can be executed (north-bound of SDNC) | PASS |
5 SwDownload | Ensure software download API can be executed (south-bound of SDNC to EC) | PASS |
6 SwInstall | Ensure software install API can be executed (south-bound of SDNC to EC) | PASS |
7 SwActivate | Ensure software activate API can be executed (south-bound of SDNC to EC) | PASS |
Test Details
Preparation
1. Modify the file /opt/onap/sdnc/data/properties/lcm-dg.properties in sdnc container as follows:
-lcm.pnf.upgrade-pre-check.playbookname=ansible_precheck_pnf |
And then restart the sdnc container.
2. Add the following line in the file in /opt/ansible-server/Playbooks/Ansible_inventory in ansible-server container:
192.168.35.83 ansible_connection=ssh ansible_ssh_user=ubuntu ansible_ssh_private_key_file=/home/ansible/.ssh/ssh_key_file |
Where ssh_key_file is private key of SSH user ubuntu at host 192.168.35.83.
Host 192.168.35.83 is the EMS Simulator.
3. Add topics SDNC-LCM-READ and SDNC-LCM-WRITE to DMaaP if they don't exist.
Login Message Router container, and run the following commands:
cd /opt/kafka/bin ./kafka-topics.sh --zookeeper message-router-zookeeper:2181 --create --topic SDNC-LCM-READ --partitions 1 --replication-factor 1 --if-not-exists ./kafka-topics.sh --zookeeper message-router-zookeeper:2181 --create --topic SDNC-LCM-WRITE --partitions 1 --replication-factor 1 --if-not-exists |
Test Result 1: Using DMaaP Listener
Test Case ID | UpgradePreCheck1 |
|---|---|
Test Case Name | Verify UpgradePreCheck API of SDNC |
Release | Dublin |
Pre-conditions | Initial State |
Testing Steps | 1. Go to terminal 1: 2. Go to terminal 2: The content of file upgrade-pre-check-input.json is as follows: 3. Back to terminal 1, and wait a minute to get the output: |
Conclusion (Pass /Fail) | PASS |
Test Case ID | UpgradeSoftware1 |
|---|---|
Test Case Name | Verify UpgradeSoftware API of SDNC |
Release | Dublin |
Pre-conditions | PreChecked |
Testing Steps | 1. Go to terminal 1: 2. Go to terminal 2: The content of file upgrade-software-input.json is as follows: 3. Back to terminal 1, and wait a minute to get the output: |
Conclusion (Pass /Fail) | PASS |
Test Case ID | UpgradePostCheck1 |
|---|---|
Test Case Name | Verify UpgradePostCheck API of SDNC |
Release | Dublin |
Pre-conditions | Upgraded |
Testing Steps | 1. Go to terminal 1: 2. Go to terminal 2: The content of file upgrade-post-check-input.json is as follows: 3. Back to terminal 1, and wait a minute to get the output: |
Conclusion (Pass /Fail) | PASS |
Test Case ID | Rollback1 |
|---|---|
Test Case Name | Verify Rollback API of SDNC |
Release | Dublin |
Pre-conditions | Upgrade Success or Upgrade Failure |
Testing Steps | 1. Go to terminal 1: 2. Go to terminal 2: The content of file rollback-input.json is as follows: 3. Back to terminal 1, and wait a minute to get the output: |
Conclusion (Pass /Fail) | PASS |
Test Result 2: Directly Calling SDNC Northbound APIs
Test Case ID | UpgradePreCheck2 |
|---|---|
Test Case Name | Verify UpgradePreCheck API of SDNC |
Release | Dublin |
Pre-conditions | Initial State |
Testing Steps | The content of file upgrade-pre-check-input.json is as follows: |
Conclusion (Pass /Fail) | PASS |
Test Case ID | UpgradeSoftware2 |
|---|---|
Test Case Name | Verify UpgradeSoftware API of SDNC |
Release | Dublin |
Pre-conditions | PreChecked |
Testing Steps | The content of file upgrade-software-input.json is as follows: |
Conclusion (Pass /Fail) |