9e2f9f98fb04e04596bfa678bac543c4bce5efe1
[doc.git] / docs / guides / onap-user / instantiate / instantiation / so2 / index.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0
2 .. International License. http://creativecommons.org/licenses/by/4.0
3 .. Copyright 2019 ONAP Contributors.  All rights reserved.
4
5 .. _doc_guide_user_ser_inst_so2:
6
7
8 Macro mode Service Instantiation via ONAP SO API
9 ================================================
10
11 Using Macro mode, you have to build and send one and only one
12 request to ONAP SO.
13
14 In that request you need to indicate all object instances
15 that you want to be instantiated.
16
17 Reminder : ONAP SO in Macro mode will perform the VNF parameters/values
18 assignment based on CDS Blueprint templates
19 that are supposed to be defined during Design and Onboard steps.
20 That means ONAP should have all information
21 to be able to get all necessary values by itself (there is no longer need
22 for a user to provide those values via the "SDNC preload" operation).
23
24 Additional info in:
25
26 .. toctree::
27    :maxdepth: 1
28    :titlesonly:
29
30    CDS Documentation <../../../../../submodules/ccsdk/cds.git/docs/index.rst>
31    CDS vDNS E2E Automation <https://wiki.onap.org/display/DW/vDNS+CDS+Dublin>
32
33
34 Request Example :
35
36 ::
37
38   curl -X POST \
39     'http://{{k8s}}:30277/onap/so/infra/serviceInstantiation/v7/serviceInstances' \
40     -H 'Content-Type: application/json' \
41     -H 'cache-control: no-cache' \
42     -d '{
43     "requestDetails": {
44       "subscriberInfo": {
45         "globalSubscriberId": "Demonstration"
46       },
47       "requestInfo": {
48         "suppressRollback": false,
49         "productFamilyId": "a9a77d5a-123e-4ca2-9eb9-0b015d2ee0fb",
50         "requestorId": "adt",
51         "instanceName": "{{cds-instance-name}}",
52         "source": "VID"
53       },
54       "cloudConfiguration": {
55         "lcpCloudRegionId": "fr1",
56         "tenantId": "6270eaa820934710960682c506115453"
57       },
58       "requestParameters": {
59         "subscriptionServiceType": "vFW",
60         "userParams": [
61           {
62             "Homing_Solution": "none"
63           },
64           {
65             "service": {
66               "instanceParams": [
67
68               ],
69               "instanceName": "{{cds-instance-name}}",
70               "resources": {
71                 "vnfs": [
72                   {
73                     "modelInfo": {
74                   "modelName": "{{vnf-modelinfo-modelname}}",
75                   "modelVersionId": "{{vnf-modelinfo-modeluuid}}",
76                   "modelInvariantUuid": "{{vnf-modelinfo-modelinvariantuuid}}",
77                   "modelVersion": "1.0",
78                   "modelCustomizationId": "{{vnf-modelinfo-modelcustomizationuuid}}",
79                   "modelInstanceName": "{{vnf-modelinfo-modelinstancename}}"
80                     },
81                     "cloudConfiguration": {
82                       "lcpCloudRegionId": "fr1",
83                       "tenantId": "6270eaa820934710960682c506115453"
84                     },
85                     "platform": {
86                       "platformName": "test"
87                     },
88                     "lineOfBusiness": {
89                       "lineOfBusinessName": "someValue"
90                     },
91                     "productFamilyId": "a9a77d5a-123e-4ca2-9eb9-0b015d2ee0fb",
92                     "instanceName": "{{vnf-modelinfo-modelinstancename}}",
93                     "instanceParams": [
94                       {
95                         "onap_private_net_id": "olc-private",
96                         "onap_private_subnet_id": "olc-private",
97                         "pub_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCwj7uJMyKiP1ogEsZv5kKDFw9mFNhxI+woR3Tuv8vjfNnqdB1GfSnvTFyNbdpyNdR8BlljkiZ1SlwJLEkvPk0HpOoSVVek/QmBeGC7mxyRcpMB2cNQwjXGfsVrforddXOnOkj+zx1aNdVGMc52Js3pex8B/L00H68kOcwP26BI1o77Uh+AxjOkIEGs+wlWNUmXabLDCH8l8IJk9mCTruKEN9KNj4NRZcaNC+XOz42SyHV9RT3N6efp31FqKzo8Ko63QirvKEEBSOAf9VlJ7mFMrGIGH37AP3JJfFYEHDdOA3N64ZpJLa39y25EWwGZNlWpO/GW5bNjTME04dl4eRyd",
98                         "image_name": "Ubuntu 14.04",
99                         "flavor_name":"s1.cw.small-1"
100                       }
101                     ],
102                     "vfModules": [
103                       {
104                         "modelInfo": {
105                           "modelName": "{{vnf-vfmodule-0-modelinfo-modelname}}",
106                           "modelVersionId": "{{vnf-vfmodule-0-modelinfo-modeluuid}}",
107                          "modelInvariantUuid": "{{vnf-vfmodule-0-modelinfo-modelinvariantuuid}}",
108                           "modelVersion": "1",
109                           "modelCustomizationId": "{{vnf-vfmodule-0-modelinfo-modelcustomizationuuid}}"
110                          },
111                         "instanceName": "{{vnf-vfmodule-0-modelinfo-modelname}}",
112                         "instanceParams": [
113                                                    {
114                             "sec_group": "olc-open",
115                             "public_net_id": "olc-net"
116                           }
117                         ]
118                       },
119                       {
120                         "modelInfo": {
121                           "modelName": "{{vnf-vfmodule-1-modelinfo-modelname}}",
122                           "modelVersionId": "{{vnf-vfmodule-1-modelinfo-modeluuid}}",
123                           "modelInvariantUuid": "{{vnf-vfmodule-1-modelinfo-modelinvariantuuid}}",
124                           "modelVersion": "1",
125                           "modelCustomizationId": "{{vnf-vfmodule-1-modelinfo-modelcustomizationuuid}}"
126                          },
127                         "instanceName": "{{vnf-vfmodule-1-modelinfo-modelname}}",
128                         "instanceParams": [
129                           {
130                             "sec_group": "olc-open",
131                             "public_net_id": "olc-net"
132                           }
133                         ]
134                       },
135                       {
136                         "modelInfo": {
137                           "modelName": "{{vnf-vfmodule-2-modelinfo-modelname}}",
138                           "modelVersionId": "{{vnf-vfmodule-2-modelinfo-modeluuid}}",
139                           "modelInvariantUuid": "{{vnf-vfmodule-2-modelinfo-modelinvariantuuid}}",
140                           "modelVersion": "1",
141                           "modelCustomizationId": "{{vnf-vfmodule-2-modelinfo-modelcustomizationuuid}}"
142                          },
143                         "instanceName": "{{vnf-vfmodule-2-modelinfo-modelname}}",
144                         "instanceParams": [
145                           {
146                             "sec_group": "olc-open",
147                             "public_net_id": "olc-net"
148                           }
149                         ]
150                       },
151                       {
152                         "modelInfo": {
153                           "modelName": "{{vnf-vfmodule-3-modelinfo-modelname}}",
154                           "modelVersionId": "{{vnf-vfmodule-3-modelinfo-modeluuid}}",
155                           "modelInvariantUuid": "{{vnf-vfmodule-3-modelinfo-modelinvariantuuid}}",
156                           "modelVersion": "1",
157                           "modelCustomizationId": "{{vnf-vfmodule-3-modelinfo-modelcustomizationuuid}}"
158                         },
159                         "instanceName": "{{vnf-vfmodule-3-modelinfo-modelname}}",
160                         "instanceParams": [
161                           {
162                             "sec_group": "olc-open",
163                             "public_net_id": "olc-net"
164                           }
165                         ]
166                       }
167                     ]
168                   }
169                 ]
170               },
171               "modelInfo": {
172                 "modelVersion": "1.0",
173           "modelVersionId": "{{service-uuid}}",
174           "modelInvariantId": "{{service-invariantUUID}}",
175           "modelName": "{{service-name}}",
176                 "modelType": "service"
177               }
178             }
179           }
180         ],
181         "aLaCarte": false
182       },
183       "project": {
184         "projectName": "Project-Demonstration"
185       },
186       "owningEntity": {
187         "owningEntityId": "24ef5425-bec4-4fa3-ab03-c0ecf4eaac96",
188         "owningEntityName": "OE-Demonstration"
189       },
190       "modelInfo": {
191         "modelVersion": "1.0",
192           "modelVersionId": "{{service-uuid}}",
193           "modelInvariantId": "{{service-invariantUUID}}",
194           "modelName": "{{service-name}}",
195        "modelType": "service"
196       }
197     }
198   }'