[vFW_CNF_CDS] Update of python-sdk for vFW_CNF use case
[demo.git] / service_mapping / README.md
1 Content
2 ---
3
4 The service_mapping direction contains a directory per VNF that adds service_mapping data for robot mondel onboarding and intantiation.
5 Each subdirectory has a name that must match the SERVICE Name used by robot.
6 In each subdirectory is one file service_mapping.json that is merged with the data in robot's testsuite/robot/assets/service_mapping.py
7 This way the data about basic vFW, vLB etc from previous releases can be merged with new Services/Use Cases without having to edit service_mapping.py in testsuite.
8 As new VNF Heat and other VIM artifacts are added the matching service_mapping.json can be added in the Demo repository.
9
10 The service mapping to heat template directory, deployment artifacts, VF to VNF mapping etc are in the below structure sa required by testsuite
11
12
13 GLOBAL_SERVICE_FOLDER_MAPPING - This metadata identifies the folders to be zipped and uploaded to SDC for model distribution for a given VNF
14 Example:
15 ````json
16 "GLOBAL_SERVICE_FOLDER_MAPPING": { 
17         "vCPE" : ["vCPE/infra", "vCPE/vbng", "vCPE/vbrgemu", "vCPE/vgmux", "vCPE/vgw"]
18 }
19 ```
20
21 GLOBAL_SERVICE_VNF_MAPPING - Map the service to the list of VNFs to be orchestrated
22 Example:
23 ````json
24 "GLOBAL_SERVICE_VNF_MAPPING": { 
25         "vLB"  : ["vLB"]
26 }
27 ```
28
29 GLOBAL_SERVICE_GEN_NEUTRON_NETWORK_MAPPING - Map the service to the list of Generic Neutron Networks to be orchestrated
30 Example:
31 ````json
32 "GLOBAL_SERVICE_GEN_NEUTRON_NETWORK_MAPPING": {
33         "vCPEvGMUX" : ["MUX_GW"]
34    }
35 ```
36
37 GLOBAL_SERVICE_DEPLOYMENT_ARTIFACT_MAPPING - Map the service to the list of Deployment Artifacts for Closed Loop Control
38 Example:
39 ````json
40 "GLOBAL_SERVICE_DEPLOYMENT_ARTIFACT_MAPPING": {
41         "vLB" :["tca_docker_k8s_v4.yaml"]
42    }
43 ```
44
45 GLOBAL_SERVICE_TEMPLATE_MAPPING - This metadata identifes the preloads that need to be done for a VNF as there may be more than one (vLB)
46 "template" maps to the parameters in the preload_paramenters.py - GLOBAL_PRELOAD_PARAMETERS[testcase][template] - i.e. GLOBAL_PRELOAD_PARAMETERS['Demo'][dnsscaling_preload.template']
47 Example:
48 ````json
49 "GLOBAL_SERVICE_TEMPLATE_MAPPING": {
50         "vCPE" : [{"isBase" : "true",  "template" : "vcpe_preload.template", "vnf_index": "0", "name_pattern": "base_clearwater"}]
51    }
52 ```
53
54 GLOBAL_VALIDATE_NAME_MAPPING - Used by the Heatbridge Validate Query to A&AI to locate the vserver name
55 Example:
56 ````json
57 "GLOBAL_VALIDATE_NAME_MAPPING": {
58         "vCPE" : "vgw_name_0"
59    }
60 ```