Merge "Add documentation for 5G PNF Software upgrade"
[integration.git] / docs / docs_CCVPN.rst
1 CCVPN
2 ----------------------------
3
4 Sevice used for CCVPN 
5 ~~~~~~~~~~~~
6
7 - SOTNVPNInfraService, SDWANVPNInfraService and SIteService: https://wiki.onap.org/display/DW/CCVPN+Service+Design
8 - WanConnectionService ( Another way to describe CCVPN in a single service form which based on ONF CIM ): https://wiki.onap.org/display/DW/CCVPN+Wan+Connection+Service+Design
9
10 Description
11 ~~~~~~~~~~~
12 Cross-domain, cross-layer VPN (CCVPN) is one of the use cases of the ONAP Casablanca release. This release demonstrates cross-operator ONAP orchestration and interoperability with third party SDN controllers and enables cross-domain, cross-layer and cross-operator service creation and assurance.
13
14 The demonstration includes two ONAP instances, one deployed by Vodafone and one by China Mobile, both of which orchestrate the respective operator underlay OTN networks and overlay SD-WAN networks and peer to each other for cross-operator VPN service delivery.
15
16 The CCVPN Use Case Wiki Page can be found here: https://wiki.onap.org/display/DW/CCVPN%28Cross+Domain+and+Cross+Layer+VPN%29+USE+CASE.
17
18 The projects covered by this use case include: SDC, A&AI, UUI, SO, SDNC, OOF, Policy, DCAE(Holmes), External API, MSB
19
20 How to Use
21 ~~~~~~~~~~
22 Design time
23 SOTNVPNInfraService, SDWANVPNInfraService and SIteService service Design steps can be found here: https://wiki.onap.org/display/DW/CCVPN+Service+Design
24 WanConnectionService ( Another way to describe CCVPN in a single service form which based on ONF CIM ): https://wiki.onap.org/display/DW/CCVPN+Wan+Connection+Service+Design
25
26 Run Time:
27 All opertion will be triggerd by UUI, inlcuding service creation and termination, link management and topology network display.
28
29
30 More details can be fonud here: https://wiki.onap.org/display/DW/CCVPN+Test+Guide
31
32 Test Status and Plans
33 ~~~~~~~~~~~~~~~~~~~~~
34 All test case covered by this use case: https://wiki.onap.org/display/DW/CCVPN+Integration+Test+Case
35
36 And the test status can be found: https://wiki.onap.org/display/DW/CCVPN++-Test+Status
37
38 Known Issues and Resolutions
39 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
40 1) AAI-1923. Link Management, UUI can't delete the link to external onap otn domain. 
41
42 For the manual steps provided by A&AI team, we should follow the steps as follow
43 the only way to delete is using the forceDeleteTool shell script in the graphadmin container.
44 First we will need to find the vertex id, you should be able to get the id by making the following GET request.
45
46 GET /aai/v14/network/ext-aai-networks/ext-aai-network/createAndDelete/esr-system-info/test-esr-system-info-id-val-0?format=raw
47
48 ::
49
50 {
51 "results": [
52 {
53 "id": "20624",
54 "node-type": "pserver",
55 "url": "/aai/v13/cloud-infrastructure/pservers/pserver/pserverid14503-as988q",
56 "properties": {
57 }
58 }
59 ]
60 }
61
62 Same goes for the ext-aai-network:
63
64 GET /aai/v14/network/ext-aai-networks/ext-aai-network/createAndDelete?format=raw
65
66 Retrieve the id from the above output as that will be the vertex id that you want to remove.
67
68 Run the following command multiple times for both the esr-system-info and ext-aai-network:
69
70 ::
71
72 kubectl exec -it $(kubectl get pods -lapp=aai-graphadmin -n onap --template 'range .items.metadata.name"\n"end' | head -1) -n onap gosu aaiadmin /opt/app/aai-graphadmin/scripts/forceDeleteTool.sh -action DELETE_NODE -userId YOUR_ID_ANY_VALUE -vertexId VERTEX_ID
73
74 From the above, remove the YOUR_ID_ANY_VALUE and VERTEX_ID with your info.
75
76 2) SDC-1955. Site service Distribution
77
78 To overcome the Service distribution, the SO catalog has to be populated with the model information of the services and resources.
79 a) Refering to the Csar that is generated in the SDC designed as per the detailes mentioned in the below link: https://wiki.onap.org/display/DW/CCVPN+Service+Design
80 b) Download the Csar from SDC thus generated.
81 c) copy the csar to SO sdc controller pod and bpmn pod
82   kubectl -n onap get pod|grep so
83   kubectl -n onap exec -it dev-so-so-sdc-controller-c949f5fbd-qhfbl  /bin/sh
84
85   mkdir null/ASDC
86   mkdir null/ASDC/1
87   kubectl -n onap cp service-Sdwanvpninfraservice-csar.csar  dev-so-so-bpmn-infra-58796498cf-6pzmz:null/ASDC/1/service-Sdwanvpninfraservice-csar.csar
88   kubectl -n onap cp service-Sdwanvpninfraservice-csar.csar  dev-so-so-bpmn-infra-58796498cf-6pzmz:ASDC/1/service-Sdwanvpninfraservice-csar.csar
89
90 d) populate model information to SO db 
91   the db script example can be seen in https://wiki.onap.org/display/DW/Manual+steps+for+CCVPN+Integration+Testing
92
93 The same would also be applicable for the integration of the client to create the service and get the details.
94 Currently the testing has been performed using the postman calls to the corresponding APIs.
95
96 3) SDC-1955 & SDC-1958. Site serivce parsing Error
97
98 UUI: stored the csar which created based on beijing release under a fixed directory, If site serive can't parsed by SDC tosca parser, UUI will parse this default csar and get the input parameter
99 a) Make an available csar file for CCVPN use case.
100 b) Replace uuid of available files with what existing in SDC.
101 c) Put available csar files in UUI local path (/home/uui).
102
103 4) SO-1248. Csar needs to be manually placed into the bpmn corresponding directory
104
105 After SDC distribution success, copy all csar files from so-sdc-controller:
106     connect to so-sdc-controller( eg: kubectl.exe exec -it -n onap dev-so-so-sdc-controller-77df99bbc9-stqdz /bin/sh )
107     find out all csar files ( eg: find / -name '*.csar' )
108     the csar files should be in this path: /app/null/ASDC/ ( eg: /app/null/ASDC/1/service-Sotnvpninfraservice-csar.csar )
109     exit from the so-sdc-controller ( eg: exit )
110     copy all csar files to local derectory ( eg: kubectl.exe cp onap/dev-so-so-sdc-controller-6dfdbff76c-64nf9:/app/null/ASDC/tmp/service-DemoService-csar.csar service-DemoService-csar.csar -c so-sdc-controller )
111     
112 Copy csar files, which got from so-sdc-controller, to so-bpmn-infra
113     connect to so-bpmn-infra ( eg: kubectl.exe -n onap exec -it dev-so-so-bpmn-infra-54db5cd955-h7f5s -c so-bpmn-infra /bin/sh )
114     check the /app/ASDC deretory, if doesn't exist, create it ( eg: mkdir /app/ASDC -p )
115     exit from the so-bpmn-infra ( eg: exit )
116     copy all csar files to so-bpmn-infra ( eg: kubectl.exe cp service-Siteservice-csar.csar onap/dev-so-so-bpmn-infra-54db5cd955-h7f5s:/app/ASDC/1/service-Siteservice-csar.csar )
117
118 5) Manual steps in closed loop Scenario:
119 Following steps were undertaken for the closed loop testing.
120 a. Give controller ip, username and password, trust store and key store file in restconf collector collector.properties
121 b. Updated DMAAP ip in cambria.hosts in DmaapConfig.json in restconf collector and run restconf collector
122 c. Followed the steps provided in this link(https://wiki.onap.org/display/DW/Holmes+User+Guide+-+Casablanca#HolmesUserGuide-Casablanca-Configurations) to push CCVPN rules to holmes
123 d. Followed the steps provided in this link(https://wiki.onap.org/display/DW/ONAP+Policy+Framework%3A+Installation+of+Amsterdam+Controller+and+vCPE+Policy) as reference to push CCVPN policies to policy module and updated sdnc.url, username and password in environment(/opt/app/policy/config/controlloop.properties.environment)
124 As per wiki (Policy on OOM), push-policied.sh script is used to install policies. but I observed that CCVPN policy is not added in this script. So merged CCVPN policy using POLICY-1356 JIRA ticket. but policy is pushed by using push-policy_casablanca.sh script during integration test.
125 It is found that the changes made were overwritten and hence had to patch the DG manually. This will be tracked by the JIRA SDNC-540.
126
127 all above manual steps can be found  https://wiki.onap.org/display/DW/Manual+steps+for+CCVPN+Integration+Testing