docs/docs_scaleout.rst

   1 .. _docs_scaleout:
   2
   3 VF Module Scale Out Use Case
   4 ----------------------------
   5
   6 Source files
   7 ~~~~~~~~~~~~
   8 - Heat templates directory: https://git.onap.org/demo/tree/heat/vLB_CDS?h=dublin
   9
  10 Additional files
  11 ~~~~~~~~~~~~~~~~
  12 - DCAE blueprint: https://git.onap.org/integration/tree/docs/files/scaleout/k8s-tca-clamp-policy-05162019.yaml
  13 - TOSCA model template: https://git.onap.org/integration/tree/docs/files/scaleout/service-Vloadbalancercds-template.yml
  14 - Naming policy script: https://git.onap.org/integration/tree/docs/files/scaleout/push_naming_policy.sh
  15
  16 Description
  17 ~~~~~~~~~~~
  18 The scale out use case uses a VNF composed of three virtual functions. A traffic generator (vPacketGen), a load balancer (vLB), and a DNS (vDNS). Communication between the vPacketGen and the vLB, and the vLB and the vDNS occurs via two separate private networks. In addition, all virtual functions have an interface to the ONAP OAM private network, as shown in the topology below.
  19
  20 .. figure:: files/scaleout/topology.png
  21    :align: center
  22
  23 The vPacketGen issues DNS lookup queries that reach the DNS server via the vLB. vDNS replies reach the packet generator via the vLB as well. The vLB reports the average amount of traffic per vDNS instances over a given time interval (e.g. 10 seconds) to the DCAE collector via the ONAP OAM private network.
  24
  25 To run the use case, make sure that the security group in OpenStack has ingress/egress entries for protocol 47 (GRE). Users can test the VNF by running DNS queries from the vPakcketGen:
  26
  27 ::
  28
  29   dig @vLoadBalancer_IP host1.dnsdemo.onap.org
  30
  31 The output below means that the vLB has been set up correctly, has forwarded the DNS queries to a vDNS instance, and the vPacketGen has received the vDNS reply message.
  32
  33 ::
  34
  35     ; <<>> DiG 9.10.3-P4-Ubuntu <<>> @192.168.9.111 host1.dnsdemo.onap.org
  36     ; (1 server found)
  37     ;; global options: +cmd
  38     ;; Got answer:
  39     ;; ->>HEADER<<- opcode: QUERY, status: NOERROR, id: 31892
  40     ;; flags: qr aa rd; QUERY: 1, ANSWER: 1, AUTHORITY: 1, ADDITIONAL: 2
  41     ;; WARNING: recursion requested but not available
  42
  43     ;; OPT PSEUDOSECTION:
  44     ; EDNS: version: 0, flags:; udp: 4096
  45     ;; QUESTION SECTION:
  46     ;host1.dnsdemo.onap.org.            IN      A
  47
  48     ;; ANSWER SECTION:
  49     host1.dnsdemo.onap.org.     604800  IN      A       10.0.100.101
  50
  51     ;; AUTHORITY SECTION:
  52     dnsdemo.onap.org.   604800  IN      NS      dnsdemo.onap.org.
  53
  54     ;; ADDITIONAL SECTION:
  55     dnsdemo.onap.org.   604800  IN      A       10.0.100.100
  56
  57     ;; Query time: 0 msec
  58     ;; SERVER: 192.168.9.111#53(192.168.9.111)
  59     ;; WHEN: Fri Nov 10 17:39:12 UTC 2017
  60     ;; MSG SIZE  rcvd: 97
  61
  62
  63 The Scale Out Use Case
  64 ~~~~~~~~~~~~~~~~~~~~~~
  65 The Scale Out use case shows how users/network operators can add Virtual Network Function Components (VNFCs) as part of a VF Module that has been instantiated in the Service model, in order to increase capacity of the network. ONAP Dublin release supports scale out with manual trigger by directly calling SO APIs and closed-loop-enabled automation from Policy. For Dublin, the APPC controller is used to demonstrate accepting request from SO to execute the Scale Out operation. APPC can be used to scale different VNF types, not only the VNF described in this document.
  66
  67 The figure below shows all the interactions that take place during scale out operations.
  68
  69 .. figure:: files/scaleout/scaleout.png
  70    :align: center
  71
  72 There are four different message flows:
  73   - Gray: This is communication that happens internally to the VNF and it is described in the section above.
  74   - Green: Scale out with manual trigger.
  75   - Red: Closed-loop enabled scale out.
  76   - Black: Orchestration and VNF lifecycle management (LCM) operations.
  77
  78 The numbers in the figure represent the sequence of steps within a given flow. Note that interactions between the components in the picture and AAI, SDNC, and DMaaP are not shown for clarity's sake.
  79
  80 Scale out with manual trigger (green flow) and closed-loop enabled scale out (red flow) are mutually exclusive. When the manual trigger is used, VID directly triggers the appropriate workflow in SO (step 1 of the green flow in the figure above). See Section 4 for more details.
  81
  82 When closed-loop enabled scale out is used, Policy triggers the SO workflow. The closed loop starts with the vLB periodically reporting telemetry about traffic patterns to the VES collector in DCAE (step 1 of the red flow). When the amount of traffic exceeds a given threshold (which the user defines during closed loop creation in CLAMP - see Section 1-4), DCAE notifies Policy (step 2), which in turn triggers the appropriate action. For this use case, the action is contacting SO to augment resource capacity in the network (step 3).
  83
  84 At high level, once SO receives a call for scale out actions, it first creates a new VF module (step 1 of the black flow), then calls APPC to trigger some LCM actions (step 2). APPC runs VNF health check and configuration scale out as part of LCM actions (step 3). At this time, the VNF health check only reports the health status of the vLB, while the configuration scale out operation adds a new vDNS instance to the vLB internal state. As a result of configuration scale out, the vLB opens a connection towards the new vDNS instance.
  85
  86 At deeper level, the SO workflow works as depicted below:
  87
  88 .. figure:: files/scaleout/so-blocks.png
  89    :align: center
  90
  91 SO first contacts APPC to run VNF health check and proceeds on to the next block only if the vLB is healthy (not shown in the previous figure for simplicity's sake). Then, SO assigns resources, instantiates, and activates the new VF module. Finally, SO calls APPC again for configuration scale out and VNF health check. The VNF health check at the end of the workflow validates that the vLB health status hasn't been negatively affected by the scale out operation.
  92
  93
  94 PART 1 - Service Definition and Onboarding
  95 ------------------------------------------
  96 This use-case requires operations on several ONAP components to perform service definition and onboarding.
  97
  98
  99 1-1 Using CDS : VNF Configuration Modeling and Upload
 100 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 101 For Dublin, the scale out use case integrates with the Controller Design Studio (CDS) ONAP component to automate the generation of cloud configuration at VNF instantiation time. Users can model this configuration at VNF design time and onboard the blueprint to CDS via the CDS GUI. The blueprint includes naming policies and network configuration details (e.g. IP address families, network names, etc.) that CDS will use during VNF instantiation to generate resource names and assign network configuration to VMs through the cloud orchestrator.
 102
 103 Please look at the CDS documentation for details about how to create configuration models, blueprints, and use the CDS tool: https://wiki.onap.org/display/DW/Modeling+Concepts. For running the use case, users can use the standard model package that CDS provides out of the box, which can be found here: https://wiki.onap.org/pages/viewpage.action?pageId=64007442
 104
 105
 106 1-2 Using SDC : VNF Onboarding and Service Creation
 107 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 108 Once the configuration blueprint is uploaded to CDS, users can define and onboard a service using SDC. SDC requires users to onboard a VNF descriptor that contains the definition of all the resources (private networks, compute nodes, keys, etc.) with their parameters that compose a VNF. The VNF used to demonstrate the scale out use case supports Heat templates as VNF descriptor, and hence requires OpenStack as cloud layer. Users can use the Heat templates linked at the top of the page to create a zip file that can be uploaded to SDC during service creation. To create a zip file, the user must be in the same folder that contains the Heat templates and the Manifest file that describes the content of the package. To create a zip file from command line, type:
 109 ::
 110
 111     zip ../vLB.zip *
 112
 113 For a complete description of service design and creation, please refer to the SDC wiki page: https://wiki.onap.org/display/DW/Design
 114
 115 During the creation of the service in SDC, there are a few extra steps that need to be executed to make the VNF ready for scale out. These require users to login to the SDC Portal as service designer user (username: cs0008, password: demo123456!).
 116
 117 After importing the Vendor Software Package (VSP), as described in the SDC wiki page, users need to set property values in the Property Assignment window, as shown below:
 118
 119 .. figure:: files/scaleout/9.png
 120    :align: center
 121
 122 These properties include parameters in the Heat template (which will be overridden by CDS and then don't need to be changed) and other parameters that describe the VNF type or are used to link the service to the configuration in the CDS package.
 123
 124 Users can search for parameter names starting with "nf" to assign values that describe the VNF type, such as nf_type, nf_function, and nf_role. Users are free to choose the values they like. Users should also set "skip_post_instantiation" to "TRUE", as for Dublin CDS is not used for post-instantiation configuration.
 125
 126 .. figure:: files/scaleout/10.png
 127    :align: center
 128
 129 For CDS parameters, users can search for names starting with "sdnc". These parameters have to match the configuration blueprint in CDS. To use the standard blueprint shipped with CDS, please set the parameters as below. For further details, please refer to the CDS documentation.
 130
 131 .. figure:: files/scaleout/11.png
 132    :align: center
 133
 134
 135 After importing the VSP, users need to onboard the DCAE blueprint and the Policy Model used to design closed loops in CLAMP. From the "Composition" tab in the service menu, select the artifact icon on the right, as shown below:
 136
 137 .. figure:: files/scaleout/1.png
 138    :align: center
 139
 140 Upload the DCAE blueprint linked at the top of the page using the pop-up window.
 141
 142 .. figure:: files/scaleout/2.png
 143    :align: center
 144
 145 The blueprint will appear in the artifacts section on the right.
 146
 147 .. figure:: files/scaleout/3.png
 148    :align: center
 149
 150 To attach a Policy Model to the service, open the Policy drop-down list on left.
 151
 152 .. figure:: files/scaleout/4.png
 153    :align: center
 154
 155 Then, add the TCA Policy.
 156
 157 .. figure:: files/scaleout/5.png
 158    :align: center
 159
 160 The Policy will be attached to the service defined in SDC
 161
 162 .. figure:: files/scaleout/6.png
 163    :align: center
 164
 165 Finally, users need to provide the maximum number of VNF instances that ONAP is allowed to create as part of the scale out use case by setting up deployment properties.
 166
 167 .. figure:: files/scaleout/7.png
 168    :align: center
 169
 170 This VNF only supports scaling the vDNS, so users should select the vDNS module from the right panel and then click the "max_vf_module_instance" link. The maximum number of VNF instances to scale can be set to an arbitrary number higher than zero.
 171
 172 .. figure:: files/scaleout/8.png
 173    :align: center
 174
 175 At this point, users can complete the service creation in SDC by testing, accepting, and distributing the Service Models as described in the SDC user manual.
 176
 177
 178
 179 1-3 Using a Shell Script : Deploy Naming Policy
 180 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 181 In order to instantiate the VNF using CDS features, users need to deploy the naming policy that CDS uses for resource name generation to the Policy Engine. User can copy and run the script at the top of the page from any ONAP pod, for example Robot or Drools. The script uses the Policy endpoint defined in the Kubernetes domain, so the execution has to be triggered from some pod in the Kubernetes space.
 182
 183 ::
 184
 185     kubectl exec -it dev-policy-drools-0
 186     ./push_naming_policy.sh
 187
 188
 189 1-4 Using CLAMP : Closed Loop Design
 190 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 191 Once the service model is distributed, users can design the closed loop from CLAMP, using the GUI at https://clamp.api.simpledemo.onap.org:30258/designer/index.html
 192
 193 Use the "Closed Loop" link to open a distributed model.
 194
 195 .. figure:: files/scaleout/12.png
 196    :align: center
 197
 198 Select the closed loop associated to the distributed service model.
 199
 200 .. figure:: files/scaleout/13.png
 201    :align: center
 202
 203 The closed loop main page for TCA microservices is shown below.
 204
 205 .. figure:: files/scaleout/14.png
 206    :align: center
 207
 208 Click on the TCA box to create a configuration policy. From the pop-up window, users need to click "Add item" to create a new policy and fill it in with specific information, as shown below.
 209
 210 .. figure:: files/scaleout/15.png
 211    :align: center
 212
 213 For this use case, the control loop schema type is "VM", while the event name has to match the event name reported in the VNF telemetry, which is "vLoadBalancer".
 214
 215 Once the policy item has been created, users can define a threshold that will be used at runtime to evaluate telemetry reported by the vLB. When the specified threshold is crossed, DCAE generates an ONSET event that will tell Policy Engine which closed loop to activate.
 216
 217 .. figure:: files/scaleout/16.png
 218    :align: center
 219
 220 After the configuration policy is created, users need to create the operational policy, which the Policy Engine uses to determine which actions and parameters should be used during closed loop.
 221
 222 .. figure:: files/scaleout/17.png
 223    :align: center
 224
 225 Select "VF Module Create" recipe and "SO" actor. The payload section is:
 226
 227 ::
 228
 229     requestParameters: '{"usePreload":false,"userParams":[]}'
 230     configurationParameters: '[{"ip-addr":"$.vf-module-topology.vf-module-parameters.param[17].value","oam-ip-addr":"$.vf-module-topology.vf-module-parameters.param[31].value"}]'
 231
 232 Policy Engine passes the payload to SO, which will then use it during VF module instantiation to resolve configuration parameters. The JSON path
 233
 234 ::
 235
 236     "ip-addr":"$.vf-module-topology.vf-module-parameters.param[17].value"
 237
 238 indicates that resolution for parameter "ip-addr" is available at "$.vf-module-topology.vf-module-parameters.param[17].value" in the JSON object linked by the VF module self-link in AAI. For the vPacketGen/vLB/vDNS VNF, use the JSON paths provided in the example above.
 239
 240 The target type to select is VF module, as we are scaling a VF module. Please select the vDNS module as target resource ID.
 241
 242 .. figure:: files/scaleout/18.png
 243    :align: center
 244
 245 For what regards guard policies, either "Frequency Limiter", or "MinMax", or both can be used for the scale out use case. The example below shows the definition of a "Frequency Limiter" guard policy. Irrespective of the guard policy type, the policy name should be x.y.scaleout.
 246
 247 Once the operational policy design is completed, users can submit and then deploy the closed loop clicking the "Submit" and "Deploy" buttons, respectively, as shown below.
 248
 249 .. figure:: files/scaleout/20.png
 250    :align: center
 251
 252 At this point, the closed loop is deployed to Policy Engine and DCAE, and a new microservice will be deployed to the DCAE platform.
 253
 254
 255 1-5 Using CDT : Creating a VNF Template
 256 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 257 Before running scale out use case, the users need to create a VNF template using the Controller Design Tool (CDT), a design-time tool that allows users to create and on-board VNF templates into APPC. The template describes which control operation can be executed against the VNF (e.g. scale out, health check, modify configuration, etc.), the protocols that the VNF supports, port numbers, VNF APIs, and credentials for authentication. Being VNF agnostic, APPC uses these templates to "learn" about specific VNFs and the supported operations.
 258 CDT requires two input:
 259
 260 1) the list of parameters that APPC will receive (ip-addr, oam-ip-addr, enabled in the example above);
 261
 262 2) the VNF API that APPC will use to reconfigure the VNF.
 263
 264 Below is an example of the parameters file (yaml format), which we call parameters.yaml:
 265 ::
 266
 267     version: V1
 268     vnf-parameter-list:
 269     - name: ip-addr
 270       type: null
 271       description: null
 272       required: "true"
 273       default: null
 274       source: Manual
 275       rule-type: null
 276       request-keys: null
 277       response-keys: null
 278     - name: oam-ip-addr
 279       type: null
 280       description: null
 281       required: "true"
 282       default: null
 283       source: Manual
 284       rule-type: null
 285       request-keys: null
 286       response-keys: null
 287     - name: enabled
 288       type: null
 289       description: null
 290       required: "false"
 291       default: null
 292       source: Manual
 293       rule-type: null
 294       request-keys: null
 295       response-keys: null
 296
 297 Here is an example of API for the vLB VNF used for this use case. We name the file after the vnf-type contained in SDNC (i.e. Vloadbalancerms..vdns..module-3):
 298 ::
 299
 300     <vlb-business-vnf-onap-plugin xmlns="urn:opendaylight:params:xml:ns:yang:vlb-business-vnf-onap-plugin">
 301         <vdns-instances>
 302             <vdns-instance>
 303                 <ip-addr>${ip-addr}</ip-addr>
 304                 <oam-ip-addr>${oam-ip-addr}</oam-ip-addr>
 305                 <enabled>true</enabled>
 306             </vdns-instance>
 307         </vdns-instances>
 308     </vlb-business-vnf-onap-plugin>
 309
 310 To create the VNF template in CDT, the following steps are required:
 311
 312 - Connect to the CDT GUI: http://ANY-K8S-IP:30289
 313 - Click "My VNF" Tab. Create your user ID, if necessary
 314 - Click "Create new VNF" entering the VNF type as reported in VID or AAI, e.g. vLoadBalancerMS/vLoadBalancerMS 0
 315 - Select "ConfigScaleOut" action
 316 - Create a new template identifier using the VNF type name in service model as template name, e.g. Vloadbalancerms..vdns..module-3
 317 - Select protocol (Netconf-XML), VNF username (admin), and VNF port number (2831 for NETCONF)
 318 - Click "Parameter Definition" Tab and upload the parameters (.yaml) file
 319 - Click "Template Tab" and upload API template (.yaml) file
 320 - Click "Reference Data" Tab
 321 - Click "Save All to APPC"
 322
 323 For health check operation, we just need to specify the protocol, the port number and username of the VNF (REST, 8183, and "admin" respectively, in the case of vLB/vDNS) and the API. For the vLB/vDNS, the API is:
 324 ::
 325
 326   restconf/operational/health-vnf-onap-plugin:health-vnf-onap-plugin-state/health-check
 327
 328 Note that we don't need to create a VNF template for health check, so the "Template" flag can be set to "N". Again, the user has to click "Save All to APPC" to update the APPC database.
 329 At this time, CDT doesn't allow users to provide VNF password from the GUI. To update the VNF password we need to log into the APPC Maria DB container and change the password manually:
 330 ::
 331
 332   mysql -u sdnctl -p (type "gamma" when password is prompted)
 333   use sdnctl;
 334   UPDATE DEVICE_AUTHENTICATION SET PASSWORD='admin' WHERE
 335   VNF_TYPE='vLoadBalancerMS/vLoadBalancerMS 0'; (use your VNF type)
 336
 337
 338 1-6 Using SO : Setting the Controller Type in SO Database
 339 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 340 Users need to specify which controller to use for the scale out use case. For Dublin, the supported controller is APPC. Users need to create an association between the controller and the VNF type in the SO database.
 341
 342 To do so:
 343
 344 - Connect to one of the replicas of the MariaDB database
 345 - Type
 346
 347 ::
 348
 349     mysql -ucataloguser -pcatalog123
 350
 351 - Use catalogdb databalse
 352
 353 ::
 354
 355     use catalogdb;
 356
 357 - Create an association between APPC and the VNF type, for example:
 358
 359 ::
 360
 361     INSERT INTO controller_selection_reference (`VNF_TYPE`, `CONTROLLER_NAME`, `ACTION_CATEGORY`) VALUES ('<VNF Type>', 'APPC', 'ConfigScaleOut');
 362     INSERT INTO controller_selection_reference (`VNF_TYPE`, `CONTROLLER_NAME`, `ACTION_CATEGORY`) VALUES ('<VNF Type>', 'APPC', 'HealthCheck');
 363
 364 SO has a default entry for VNF type "vLoadBalancerMS/vLoadBalancerMS 0"
 365
 366
 367
 368
 369 PART 2 - Scale Out Use Case Instantiation
 370 -----------------------------------------
 371
 372 GET information from SDC catalogdb
 373
 374 ::
 375
 376   curl -X GET \
 377     'https://{{k8s}}:30204/sdc/v1/catalog/services' \
 378     -H 'Authorization: Basic dmlkOktwOGJKNFNYc3pNMFdYbGhhazNlSGxjc2UyZ0F3ODR2YW9HR21KdlV5MlU=' \
 379     -H 'X-ECOMP-InstanceID: VID' \
 380     -H 'cache-control: no-cache'
 381
 382
 383 In the response you should find values for:
 384
 385 * service-uuid
 386 * service-invariantUUID
 387 * service-name
 388
 389
 390 GET informations from SO catalogdb
 391
 392 ::
 393
 394   curl -X GET \
 395     'http://{{k8s}}:30744/ecomp/mso/catalog/v2/serviceVnfs?serviceModelName={{service-name}}' \
 396     -H 'Authorization: Basic YnBlbDpwYXNzd29yZDEk' \
 397     -H 'cache-control: no-cache'
 398
 399
 400 In the response you should find values for:
 401
 402 * vnf-modelinfo-modelname
 403 * vnf-modelinfo-modeluuid
 404 * vnf-modelinfo-modelinvariantuuid
 405 * vnf-modelinfo-modelcustomizationuuid
 406 * vnf-modelinfo-modelinstancename
 407 * vnf-vfmodule-0-modelinfo-modelname
 408 * vnf-vfmodule-0-modelinfo-modeluuid
 409 * vnf-vfmodule-0-modelinfo-modelinvariantuuid
 410 * vnf-vfmodule-0-modelinfo-modelcustomizationuuid
 411 * vnf-vfmodule-1-modelinfo-modelname
 412 * vnf-vfmodule-1-modelinfo-modeluuid
 413 * vnf-vfmodule-1-modelinfo-modelinvariantuuid
 414 * vnf-vfmodule-1-modelinfo-modelcustomizationuuid
 415 * vnf-vfmodule-2-modelinfo-modelname
 416 * vnf-vfmodule-2-modelinfo-modeluuid
 417 * vnf-vfmodule-2-modelinfo-modelinvariantuuid
 418 * vnf-vfmodule-2-modelinfo-modelcustomizationuuid
 419 * vnf-vfmodule-3-modelinfo-modelname
 420 * vnf-vfmodule-3-modelinfo-modeluuid
 421 * vnf-vfmodule-3-modelinfo-modelinvariantuuid
 422 * vnf-vfmodule-3-modelinfo-modelcustomizationuuid
 423
 424
 425 Note : all those informations are also available in the TOSCA service template in the SDC
 426
 427 You need after:
 428
 429 * the SSH public key value that will allow you to connect to the VM.
 430 * the cloudSite name and TenantId where to deploy the service
 431 * the name of the security group that will be used in the tenant for your service
 432 * the name of the network that will be used to connect your VM
 433 * the name of your OpenStack image
 434 * the name of your OpenStack VM flavor
 435
 436 We supposed here that we are using some already declared informations:
 437
 438 * customer named "Demonstration"
 439 * subscriptionServiceType named "vLB"
 440 * projectName named "Project-Demonstration"
 441 * owningEntityName named "OE-Demonstration"
 442 * platformName named "test"
 443 * lineOfBusinessName named "someValue"
 444
 445 Having all those information, you are now able to build the SO request
 446 that will instantiate Service, VNF, VF modules and Heat stacks:
 447
 448 ::
 449
 450   curl -X POST \
 451   'http://{{k8s}}:30277/onap/so/infra/serviceInstantiation/v7/serviceInstances' \
 452   -H 'Content-Type: application/json' \
 453   -H 'cache-control: no-cache' \
 454   -d '{
 455   "requestDetails": {
 456     "subscriberInfo": {
 457       "globalSubscriberId": "Demonstration"
 458     },
 459     "requestInfo": {
 460       "suppressRollback": false,
 461       "productFamilyId": "a9a77d5a-123e-4ca2-9eb9-0b015d2ee0fb",
 462       "requestorId": "VID",
 463       "instanceName": "{{service-instance-name}}",
 464       "source": "VID"
 465     },
 466     "cloudConfiguration": {
 467       "lcpCloudRegionId": "{{cloud-region}}",
 468       "tenantId": "{{tenantId}}"
 469     },
 470     "requestParameters": {
 471       "subscriptionServiceType": "vLB",
 472       "userParams": [
 473         {
 474           "Homing_Solution": "none"
 475         },
 476         {
 477           "service": {
 478             "instanceParams": [
 479
 480             ],
 481             "instanceName": "{{service-instance-name}}",
 482             "resources": {
 483               "vnfs": [
 484                 {
 485                   "modelInfo": {
 486                     "modelName": "{{vnf-modelinfo-modelname}}",
 487                     "modelVersionId": "{{vnf-modelinfo-modeluuid}}",
 488                     "modelInvariantUuid": "{{vnf-modelinfo-modelinvariantuuid}}",
 489                     "modelVersion": "1.0",
 490                     "modelCustomizationId": "{{vnf-modelinfo-modelcustomizationuuid}}",
 491                     "modelInstanceName": "{{vnf-modelinfo-modelinstancename}}"
 492                   },
 493                   "cloudConfiguration": {
 494                     "lcpCloudRegionId": "{{CloudSite-name}}",
 495                     "tenantId": "{{tenantId}}"
 496                   },
 497                   "platform": {
 498                     "platformName": "test"
 499                   },
 500                   "lineOfBusiness": {
 501                     "lineOfBusinessName": "someValue"
 502                   },
 503                   "productFamilyId": "a9a77d5a-123e-4ca2-9eb9-0b015d2ee0fb",
 504                   "instanceName": "{{vnf-modelinfo-modelinstancename}}",
 505                   "instanceParams": [
 506                     {
 507                       "onap_private_net_id": "olc-private",
 508                       "onap_private_subnet_id": "olc-private",
 509                       "pub_key": "{{Your SSH public key value}}",
 510                       "image_name": "{{my_image_name}}",
 511                       "flavor_name":"{{my_VM_flavor_name}}"
 512                     }
 513                   ],
 514                   "vfModules": [
 515                     {
 516                       "modelInfo": {
 517                         "modelName": "{{vnf-vfmodule-0-modelinfo-modelname}}",
 518                         "modelVersionId": "{{vnf-vfmodule-0-modelinfo-modeluuid}}",
 519                         "modelInvariantUuid": "{{vnf-vfmodule-0-modelinfo-modelinvariantuuid}}",
 520                         "modelVersion": "1",
 521                         "modelCustomizationId": "{{vnf-vfmodule-0-modelinfo-modelcustomizationuuid}}"
 522                        },
 523                       "instanceName": "{{vnf-vfmodule-0-modelinfo-modelname}}",
 524                       "instanceParams": [
 525                                                  {
 526                           "sec_group": "{{your_security_group_name}}",
 527                           "public_net_id": "{{your_public_network_name}}"
 528                         }
 529                       ]
 530                     },
 531                     {
 532                       "modelInfo": {
 533                         "modelName": "{{vnf-vfmodule-1-modelinfo-modelname}}",
 534                         "modelVersionId": "{{vnf-vfmodule-1-modelinfo-modeluuid}}",
 535                         "modelInvariantUuid": "{{vnf-vfmodule-1-modelinfo-modelinvariantuuid}}",
 536                         "modelVersion": "1",
 537                         "modelCustomizationId": "{{vnf-vfmodule-1-modelinfo-modelcustomizationuuid}}"
 538                        },
 539                       "instanceName": "{{vnf-vfmodule-1-modelinfo-modelname}}",
 540                       "instanceParams": [
 541                         {
 542                           "sec_group": "{{your_security_group_name}}",
 543                           "public_net_id": "{{your_public_network_name}}"
 544                         }
 545                       ]
 546                     },
 547                     {
 548                       "modelInfo": {
 549                         "modelName": "{{vnf-vfmodule-2-modelinfo-modelname}}",
 550                         "modelVersionId": "{{vnf-vfmodule-2-modelinfo-modeluuid}}",
 551                         "modelInvariantUuid": "{{vnf-vfmodule-2-modelinfo-modelinvariantuuid}}",
 552                         "modelVersion": "1",
 553                         "modelCustomizationId": "{{vnf-vfmodule-2-modelinfo-modelcustomizationuuid}}"
 554                        },
 555                       "instanceName": "{{vnf-vfmodule-2-modelinfo-modelname}}",
 556                       "instanceParams": [
 557                         {
 558                           "sec_group": "{{your_security_group_name}}",
 559                           "public_net_id": "{{your_public_network_name}}"
 560                         }
 561                       ]
 562                     },
 563                     {
 564                       "modelInfo": {
 565                         "modelName": "{{vnf-vfmodule-3-modelinfo-modelname}}",
 566                         "modelVersionId": "{{vnf-vfmodule-3-modelinfo-modeluuid}}",
 567                         "modelInvariantUuid": "{{vnf-vfmodule-3-modelinfo-modelinvariantuuid}}",
 568                         "modelVersion": "1",
 569                         "modelCustomizationId": "{{vnf-vfmodule-3-modelinfo-modelcustomizationuuid}}"
 570                       },
 571                       "instanceName": "{{vnf-vfmodule-3-modelinfo-modelname}}",
 572                       "instanceParams": [
 573                         {
 574                           "sec_group": "{{your_security_group_name}}",
 575                           "public_net_id": "{{your_public_network_name}}"
 576                         }
 577                       ]
 578                     }
 579                   ]
 580                 }
 581               ]
 582             },
 583             "modelInfo": {
 584               "modelVersion": "1.0",
 585               "modelVersionId": "{{service-uuid}}",
 586               "modelInvariantId": "{{service-invariantUUID}}",
 587               "modelName": "{{service-name}}",
 588               "modelType": "service"
 589             }
 590           }
 591         }
 592       ],
 593       "aLaCarte": false
 594     },
 595     "project": {
 596       "projectName": "Project-Demonstration"
 597     },
 598     "owningEntity": {
 599       "owningEntityId": "24ef5425-bec4-4fa3-ab03-c0ecf4eaac96",
 600       "owningEntityName": "OE-Demonstration"
 601     },
 602     "modelInfo": {
 603       "modelVersion": "1.0",
 604       "modelVersionId": "{{service-uuid}}",
 605       "modelInvariantId": "{{service-invariantUUID}}",
 606       "modelName": "{{service-name}}",
 607       "modelType": "service"
 608     }
 609   }
 610  }'
 611
 612
 613 In the response, you will obtain a requestId that will be usefull
 614 to follow the instantiation request status in the ONAP SO:
 615
 616
 617 ::
 618
 619   curl -X GET \
 620     'http://{{k8s}}:30086/infraActiveRequests/{{requestid}}' \
 621     -H 'cache-control: no-cache'
 622
 623
 624
 625
 626
 627 PART 3 - Post Instantiation Operations
 628 --------------------------------------
 629
 630 3-1 Using the VNF : vLB Manual Configuration
 631 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 632 After the VNF has been instantiated using the CDS configuration blueprint, user should manually configure the vLB to open a connection towards the vDNS. At this time, the use case doesn't support automated post-instantiation configuration with CDS. Note that this step is NOT required during scale out operations, as VNF reconfiguration will be triggered by SO and executed by APPC. To change the state of the vLB, the users can run the following REST call, replacing the IP addresses in the VNF endpoint and JSON object to match the private IP addresses of their vDNS instance:
 633
 634 ::
 635
 636   curl -X PUT \
 637   http://10.12.5.78:8183/restconf/config/vlb-business-vnf-onap-plugin:vlb-business-vnf-onap-plugin/vdns-instances/vdns-instance/192.168.10.59 \
 638   -H 'Accept: application/json' \
 639   -H 'Content-Type: application/json' \
 640   -H 'Postman-Token: a708b064-adb1-4804-89a7-ee604f5fe76f' \
 641   -H 'cache-control: no-cache' \
 642   -d '{
 643     "vdns-instance": [
 644         {
 645             "ip-addr": "192.168.10.59",
 646             "oam-ip-addr": "10.0.101.49",
 647             "enabled": true
 648         }
 649     ]
 650   }'
 651
 652 At this point, the VNF is fully set up.
 653
 654
 655 3-2 Updating AAI with VNF resources
 656 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 657 To allow automated scale out via closed loop, the users need to inventory the VNF resources in AAI. This is done by running the heatbridge python script in /root/oom/kubernetes/robot in the Rancher VM in the Kubernetes cluster:
 658
 659 ::
 660
 661     ./demo-k8s.sh onap heatbridge <vLB stack_name in OpenStack> <service_instance_id> vLB vlb_onap_private_ip_0
 662
 663 Heatbridge is needed for control loops because DCAE and Policy runs queries against AAI using vServer names as key.
 664
 665
 666 PART 4 - Triggering Scale Out Manually
 667 --------------------------------------
 668
 669 For scale out with manual trigger, VID is not supported at this time. Users can run the use case by directly calling SO APIs:
 670
 671 ::
 672
 673   curl -X POST \
 674   http://<Any_K8S_Node_IP_Address>:30277/onap/so/infra/serviceInstantiation/v7/serviceInstances/7d3ca782-c486-44b3-9fe5-39f322d8ee80/vnfs/9d33cf2d-d6aa-4b9e-a311-460a6be5a7de/vfModules/scaleOut \
 675   -H 'Accept: application/json' \
 676   -H 'Authorization: Basic SW5mcmFQb3J0YWxDbGllbnQ6cGFzc3dvcmQxJA==' \
 677   -H 'Cache-Control: no-cache' \
 678   -H 'Connection: keep-alive' \
 679   -H 'Content-Type: application/json' \
 680   -H 'Postman-Token: 12f2601a-4eb2-402c-a51a-f29502359501,9befda68-b2c9-4e7a-90ca-1be9c24ef664' \
 681   -H 'User-Agent: PostmanRuntime/7.15.0' \
 682   -H 'accept-encoding: gzip, deflate' \
 683   -H 'cache-control: no-cache' \
 684   -H 'content-length: 2422' \
 685   -H 'cookie: JSESSIONID=B3BA24216367F9D39E3DF5E8CBA4BC64' \
 686   -b JSESSIONID=B3BA24216367F9D39E3DF5E8CBA4BC64 \
 687   -d '{
 688     "requestDetails": {
 689         "modelInfo": {
 690             "modelCustomizationName": "VdnsloadbalancerCds..vdns..module-3",
 691             "modelCustomizationId": "ded42059-2f35-42d4-848b-16e1ab1ad197",
 692             "modelInvariantId": "2815d321-c6b4-4f21-b7f7-fa5adf8ed7d9",
 693             "modelVersionId": "524e34ed-9789-453e-ab73-8eff30eafef3",
 694             "modelName": "VdnsloadbalancerCds..vdns..module-3",
 695             "modelType": "vfModule",
 696             "modelVersion": "1"
 697         },
 698         "cloudConfiguration": {
 699             "lcpCloudRegionId": "RegionOne",
 700             "tenantId": "d570c718cbc545029f40e50b75eb13df",
 701             "cloudOwner": "CloudOwner"
 702         },
 703         "requestInfo": {
 704             "instanceName": "vDNS-VM-02",
 705             "source": "VID",
 706             "suppressRollback": false,
 707             "requestorId": "demo"
 708         },
 709         "requestParameters": {
 710             "userParams": []
 711         },
 712         "relatedInstanceList": [
 713             {
 714                 "relatedInstance": {
 715                     "instanceId": "7d3ca782-c486-44b3-9fe5-39f322d8ee80",
 716                     "modelInfo": {
 717                         "modelType": "service",
 718                         "modelInvariantId": "dfabdcae-cf50-4801-9885-9a3a9cc07e6f",
 719                         "modelVersionId": "ee55b537-7be5-4377-93c1-5d92931b6a78",
 720                         "modelName": "vLoadBalancerCDS",
 721                         "modelVersion": "1.0"
 722                     }
 723                 }
 724             },
 725             {
 726                 "relatedInstance": {
 727                     "instanceId": "9d33cf2d-d6aa-4b9e-a311-460a6be5a7de",
 728                     "modelInfo": {
 729                         "modelType": "vnf",
 730                         "modelInvariantId": "a77f9280-5c02-46cd-b1fc-855975db9df9",
 731                         "modelVersionId": "ff0e99ce-a521-44b5-b11b-da7e07ac83fc",
 732                         "modelName": "vLoadBalancerCDS",
 733                         "modelVersion": "1.0",
 734                         "modelCustomizationId": "b8b8a25d-19de-4581-bb63-f2dc8c0d79a7"
 735                     }
 736                 }
 737             }
 738         ],
 739         "configurationParameters": [
 740             {
 741                 "ip-addr": "$.vf-module-topology.vf-module-parameters.param[17].value",
 742                 "oam-ip-addr": "$.vf-module-topology.vf-module-parameters.param[31].value"
 743             }
 744         ]
 745     }
 746   }'
 747
 748
 749 To fill in the JSON object, users need to download the Service Model TOSCA template from the SDC Portal using one of the standard SDC users (for example user: cs0008, password: demo123456!). After logging to SDC, the user should select from the catalog the vLB service that they created, click the "TOSCA Artifacts" link on the left, and finally the download button on the right, as shown in the figure below:
 750
 751 .. figure:: files/scaleout/tosca_template_fig.png
 752    :align: center
 753
 754 For the example described below, users can refer to the TOSCA template linked at the top of the page. The template contains all the model (invariant/version/customization) IDs of service, VNF, and VF modules that the input request to SO needs.
 755
 756 The values of modelInvariantId, modelVersionId, and modelName in the relatedInstance item identified by "modelType": "service" in the JSON request to SO have to match invariantUUID, UUID, and name, respectively, in the TOSCA template:
 757 ::
 758
 759             {
 760                 "relatedInstance": {
 761                     "instanceId": "7d3ca782-c486-44b3-9fe5-39f322d8ee80",
 762                     "modelInfo": {
 763                         "modelType": "service",
 764                         "modelInvariantId": "dfabdcae-cf50-4801-9885-9a3a9cc07e6f",
 765                         "modelVersionId": "ee55b537-7be5-4377-93c1-5d92931b6a78",
 766                         "modelName": "vLoadBalancerCDS",
 767                         "modelVersion": "1.0"
 768                     }
 769                 }
 770             }
 771
 772 .. figure:: files/scaleout/service.png
 773    :align: center
 774
 775
 776 The values of modelInvariantId, modelVersionId, modelName, and modelVersion in the relatedInstance item identified by "modelType": "vnf" in the JSON request to SO have to match invariantUUID, UUID, name, and version, respectively, in the TOSCA template:
 777
 778 ::
 779
 780             {
 781                 "relatedInstance": {
 782                     "instanceId": "9d33cf2d-d6aa-4b9e-a311-460a6be5a7de",
 783                     "modelInfo": {
 784                         "modelType": "vnf",
 785                         "modelInvariantId": "a77f9280-5c02-46cd-b1fc-855975db9df9",
 786                         "modelVersionId": "ff0e99ce-a521-44b5-b11b-da7e07ac83fc",
 787                         "modelName": "vLoadBalancerCDS",
 788                         "modelVersion": "1.0",
 789                         "modelCustomizationId": "b8b8a25d-19de-4581-bb63-f2dc8c0d79a7"
 790                     }
 791                 }
 792             }
 793
 794 .. figure:: files/scaleout/vnf.png
 795    :align: center
 796
 797
 798 The modelCustomizationId, modelInvariantId, modelVersionId, modelName, and modelVersion in the modelInfo item identified by "modelType": "vfModule" in the JSON request to SO have to match vfModuleModelCustomizationUUID, vfModuleModelInvariantUUID, vfModuleModelUUID, vfModuleModelName, and vfModuleModelVersion, respectively, in the TOSCA template. The modelCustomizationName parameter in the SO object can be set as the modelName parameter in the same JSON object:
 799
 800 ::
 801
 802         "modelInfo": {
 803             "modelCustomizationName": "Vloadbalancercds..vdns..module-3",
 804             "modelCustomizationId": "ded42059-2f35-42d4-848b-16e1ab1ad197",
 805             "modelInvariantId": "2815d321-c6b4-4f21-b7f7-fa5adf8ed7d9",
 806             "modelVersionId": "524e34ed-9789-453e-ab73-8eff30eafef3",
 807             "modelName": "Vloadbalancercds..vdns..module-3",
 808             "modelType": "vfModule",
 809             "modelVersion": "1"
 810         }
 811
 812 The vLB-vDNS-vPacketGenerator VNF that we use to describe the scale out use case supports the scaling of the vDNS VF module only. As such, in the TOSCA template users should refer to the section identified by "vfModuleModelName": "Vloadbalancercds..vdns..module-3", as highlighted below:
 813
 814 .. figure:: files/scaleout/service.png
 815    :align: center
 816
 817
 818 Note that both Service and VNF related instances have a field called "instanceId" that represent the Service and VNF instance ID, respectively. These IDs are assigned at Service and VNF instantiation time and can be retrieved from AAI, querying for generic VNF objects:
 819
 820 ::
 821
 822     curl -k -X GET \
 823   https://<Any_K8S_Node_IP_Address>:30233/aai/v16/network/generic-vnfs \
 824   -H 'Accept: application/json' \
 825   -H 'Authorization: Basic QUFJOkFBSQ==' \
 826   -H 'Content-Type: application/json' \
 827   -H 'X-FromAppId: AAI' \
 828   -H 'X-TransactionId: get_aai_subscr'
 829
 830 From the list of VNFs reported by AAI, search for the name of the VNF that was previously instantiated, for example "vLB_VNF_01" in the example below:
 831
 832 ::
 833
 834         {
 835             "vnf-id": "9d33cf2d-d6aa-4b9e-a311-460a6be5a7de",
 836             "vnf-name": "vLB_VNF_01",
 837             "vnf-type": "vLoadBalancer/vLoadBalancer 0",
 838             "prov-status": "ACTIVE",
 839             "equipment-role": "",
 840             "orchestration-status": "Active",
 841             "ipv4-oam-address": "10.0.220.10",
 842             "in-maint": true,
 843             "is-closed-loop-disabled": false,
 844             "resource-version": "1565817789379",
 845             "model-invariant-id": "a77f9280-5c02-46cd-b1fc-855975db9df9",
 846             "model-version-id": "ff0e99ce-a521-44b5-b11b-da7e07ac83fc",
 847             "model-customization-id": "b8b8a25d-19de-4581-bb63-f2dc8c0d79a7",
 848             "selflink": "restconf/config/GENERIC-RESOURCE-API:services/service/7d3ca782-c486-44b3-9fe5-39f322d8ee80/service-data/vnfs/vnf/9d33cf2d-d6aa-4b9e-a311-460a6be5a7de/vnf-data/vnf-topology/",
 849             "relationship-list": {
 850                 "relationship": [
 851                     {
 852                         "related-to": "service-instance",
 853                         "relationship-label": "org.onap.relationships.inventory.ComposedOf",
 854                         "related-link": "/aai/v16/business/customers/customer/Demonstration/service-subscriptions/service-subscription/vRAR/service-instances/service-instance/7d3ca782-c486-44b3-9fe5-39f322d8ee80",
 855                         "relationship-data": [
 856                             {
 857                                 "relationship-key": "customer.global-customer-id",
 858                                 "relationship-value": "Demonstration"
 859                             },
 860                             {
 861                                 "relationship-key": "service-subscription.service-type",
 862                                 "relationship-value": "vLB"
 863                             },
 864                             {
 865                                 "relationship-key": "service-instance.service-instance-id",
 866                                 "relationship-value": "7d3ca782-c486-44b3-9fe5-39f322d8ee80"
 867                             }
 868                         ],
 869                         "related-to-property": [
 870                             {
 871                                 "property-key": "service-instance.service-instance-name",
 872                                 "property-value": "vLB-Service-0814-1"
 873                             }
 874                         ]
 875                     }
 876                     ...
 877          }
 878
 879 To identify the VNF ID, look for the "vnf-id" parameter at the top of the JSON object, while to determine the Service ID, look for the "relationship-value" parameter corresponding to the "relationship-key": "service-instance.service-instance-id" item in the "relationship-data" list. In the example above, the Service instance ID is 7d3ca782-c486-44b3-9fe5-39f322d8ee80, while the VNF ID is 9d33cf2d-d6aa-4b9e-a311-460a6be5a7de.
 880
 881 These IDs are also used in the URL request to SO:
 882
 883 ::
 884
 885     http://<Any_K8S_Node_IP_Address>:30277/onap/so/infra/serviceInstantiation/v7/serviceInstances/7d3ca782-c486-44b3-9fe5-39f322d8ee80/vnfs/9d33cf2d-d6aa-4b9e-a311-460a6be5a7de/vfModules/scaleOut
 886
 887
 888 Finally, the "configurationParameters" section in the JSON request to SO contains the parameters that will be used to reconfigure the VNF after scaling. This is use-case specific and depends on the VNF in use. For example, the vLB-vDNS-vPacketGenerator VNF described in this documentation use the vLB as "anchor" point. The vLB maintains the state of the VNF, which, for this use case is the list of active vDNS instances. After creating a new vDNS instance, the vLB needs to know the IP addresses (of the internal private network and management network) of the new vDNS. The reconfiguration action is executed by APPC, which receives those IP addresses from SO during the scale out workflow execution. Note that different VNFs may have different reconfiguration actions. The "configurationParameters" section describes how to resolve the parameters used for VNF reconfiguration. A parameter resolution is expressed as JSON path to the SDNC VF module topology parameter array. For each reconfiguration parameter, the user has to specify the array location that contains the corresponding value (IP address in the specific case).
 889
 890 ::
 891
 892     "configurationParameters": [
 893             {
 894                 "ip-addr": "$.vf-module-topology.vf-module-parameters.param[17].value",
 895                 "oam-ip-addr": "$.vf-module-topology.vf-module-parameters.param[31].value"
 896             }
 897     ]
 898
 899 Users can determine the correct location by querying the SDNC topology object. The URL can be obtained from the generic AAI object shown above ("selflink"), plus the path to the specific VF module object:
 900
 901 ::
 902
 903     vf-modules/vf-module/6c24d10b-ece8-4d02-ab98-be283b17cdd3/vf-module-data/vf-module-topology/
 904
 905 The complete URL becomes:
 906
 907 ::
 908
 909     http://<Any_K8S_Node_IP_Address>:30202/restconf/config/GENERIC-RESOURCE-API:services/service/eb6defa7-d679-4e03-a348-5f78ac9464e9/service-data/vnfs/vnf/0dd8658a-3791-454e-a35a-691f227faa86/vnf-data/vnf-topology/vf-modules/vf-module/6c24d10b-ece8-4d02-ab98-be283b17cdd3/vf-module-data/vf-module-topology/
 910
 911
 912 In future releases, we plan to leverage CDS for reconfiguration actions, so as to remove the dependency from JSON paths and simplify the process.
 913
 914
 915 PART 5 - Running the Scale Out Use Case with Configuration Preload
 916 ------------------------------------------------------------------
 917
 918 While Dublin release introduces CDS to model and automate the generation of cloud configuration for VNF instantiation, the manual preload approach is still supported for scale out with manual trigger (no closed loop).
 919
 920 The procedure is similar to one described above, with some minor changes:
 921
 922 1) **Service Design and Creation**: The heat template used to create a vendor software product in SDC is the same. However, during property assignment (Section 1-2) "sdnc_artifact_name", "sdnc_model_version", "sdnc_model_name" **must be** left blank, as they are used for CDS only.
 923
 924 2) As closed loop with preload is not supported for scale out, DCAE blueprint and Policy onboarding (Section 1-2), deployment of naming policy (Section 1-3), and closed loop design and deployment from CLAMP (Section 1-4) are not necessary.
 925
 926 3) **Creation of VNF template with CDT** works as described in Section 1-5.
 927
 928 4) **Controller type selection** in SO works as described in Section 1-6.
 929
 930 5) **VNF instantiation from VID**: users can use VID to create the service, the VNF, and instantiate the VF modules. Based on the Heat template structure, there are four VF modules:
 931
 932   * module-0: base module that contains resources, such as internal private networks and public key, shared across the VNF elements
 933   * module-1: vLB resource descriptor
 934   * module-2: vPacketGen resource descriptor
 935   * module-3: vDNS resource descriptor
 936
 937 These VF modules have to be installed in the following order, so as to satisfy heat dependencies: module-0, module-1, module-2, module-3. The parameters defined in the Heat environment files can be overridden by loading cloud configuration to SDNC before the VF modules are instantiated. See example of preloads below. They need to be customized based on the OpenStack cloud and execution environment in which the VF modules are going to be instantiated.
 938
 939 Module-0 Preload
 940 ~~~~~~~~~~~~~~~~
 941
 942 ::
 943
 944     curl -X POST \
 945   http://<Any_K8S_Node_IP_Address>:30202/restconf/operations/GENERIC-RESOURCE-API:preload-vf-module-topology-operation \
 946   -H 'Content-Type: application/json' \
 947   -H 'Postman-Token: 0a7abc62-9d8f-4f63-8b05-db7cc4c3e28b' \
 948   -H 'cache-control: no-cache' \
 949   -d '{
 950     "input": {
 951         "preload-vf-module-topology-information": {
 952             "vf-module-topology": {
 953                 "vf-module-topology-identifier": {
 954                     "vf-module-name": "vNetworks-0211-1"
 955                 },
 956                 "vf-module-parameters": {
 957                     "param": [
 958                         {
 959                             "name": "vlb_private_net_id",
 960                             "value": "vLBMS_zdfw1lb01_private_ms"
 961                         },
 962                         {
 963                             "name": "pktgen_private_net_id",
 964                             "value": "vLBMS_zdfw1pktgen01_private_ms"
 965                         },
 966                         {
 967                             "name": "vlb_private_net_cidr",
 968                             "value": "192.168.10.0/24"
 969                         },
 970                         {
 971                             "name": "pktgen_private_net_cidr",
 972                             "value": "192.168.9.0/24"
 973                         },
 974                         {
 975                             "name": "vlb_0_int_pktgen_private_port_0_mac",
 976                             "value": "fa:16:3e:00:01:10"
 977                         },
 978                         {
 979                             "name": "vpg_0_int_pktgen_private_port_0_mac",
 980                             "value": "fa:16:3e:00:01:20"
 981                         },
 982                         {
 983                             "name": "vnf_id",
 984                             "value": "vLoadBalancerMS"
 985                         },
 986                         {
 987                             "name": "vnf_name",
 988                             "value": "vLBMS"
 989                         },
 990                         {
 991                             "name": "key_name",
 992                             "value": "vlb_key"
 993                         },
 994                         {
 995                             "name": "pub_key",
 996                             "value": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDQXYJYYi3/OUZXUiCYWdtc7K0m5C0dJKVxPG0eI8EWZrEHYdfYe6WoTSDJCww+1qlBSpA5ac/Ba4Wn9vh+lR1vtUKkyIC/nrYb90ReUd385Glkgzrfh5HdR5y5S2cL/Frh86lAn9r6b3iWTJD8wBwXFyoe1S2nMTOIuG4RPNvfmyCTYVh8XTCCE8HPvh3xv2r4egawG1P4Q4UDwk+hDBXThY2KS8M5/8EMyxHV0ImpLbpYCTBA6KYDIRtqmgS6iKyy8v2D1aSY5mc9J0T5t9S2Gv+VZQNWQDDKNFnxqYaAo1uEoq/i1q63XC5AD3ckXb2VT6dp23BQMdDfbHyUWfJN"
 997                         }
 998                     ]
 999                 }
1000             },
1001             "vnf-topology-identifier-structure": {
1002                 "vnf-name": "vLoadBalancer-Vnf-0211-1",
1003                 "vnf-type": "vLoadBalancer/vLoadBalancer 0"
1004             },
1005             "vnf-resource-assignments": {
1006                 "availability-zones": {
1007                     "availability-zone": [
1008                         "nova"
1009                     ],
1010                     "max-count": 1
1011                 },
1012                 "vnf-networks": {
1013                     "vnf-network": []
1014                 }
1015             }
1016         },
1017         "request-information": {
1018             "request-id": "robot12",
1019             "order-version": "1",
1020             "notification-url": "openecomp.org",
1021             "order-number": "1",
1022             "request-action": "PreloadVfModuleRequest"
1023         },
1024         "sdnc-request-header": {
1025             "svc-request-id": "robot12",
1026             "svc-notification-url": "http://openecomp.org:8080/adapters/rest/SDNCNotify",
1027             "svc-action": "reserve"
1028         }
1029     }
1030   }'
1031
1032
1033 Module-1 Preload
1034 ~~~~~~~~~~~~~~~~
1035
1036 ::
1037
1038     curl -X POST \
1039   http://<Any_K8S_Node_IP_Address>:30202/restconf/operations/GENERIC-RESOURCE-API:preload-vf-module-topology-operation \
1040   -H 'Content-Type: application/json' \
1041   -H 'Postman-Token: 662914ac-29fc-414d-8823-1691fb2c718a' \
1042   -H 'cache-control: no-cache' \
1043   -d '{
1044     "input": {
1045         "preload-vf-module-topology-information": {
1046             "vf-module-topology": {
1047                 "vf-module-topology-identifier": {
1048                     "vf-module-name": "vLoadBalancer-0211-1"
1049                 },
1050                 "vf-module-parameters": {
1051                     "param": [
1052                         {
1053                             "name": "vlb_image_name",
1054                             "value": "ubuntu-16-04-cloud-amd64"
1055                         },
1056                         {
1057                             "name": "vlb_flavor_name",
1058                             "value": "m1.medium"
1059                         },
1060                         {
1061                             "name": "public_net_id",
1062                             "value": "public"
1063                         },
1064                         {
1065                             "name": "int_private_net_id",
1066                             "value": "vLBMS_zdfw1lb01_private_ms"
1067                         },
1068                         {
1069                             "name": "int_private_subnet_id",
1070                             "value": "vLBMS_zdfw1lb01_private_sub_ms"
1071                         },
1072                         {
1073                             "name": "int_pktgen_private_net_id",
1074                             "value": "vLBMS_zdfw1pktgen01_private_ms"
1075                         },
1076                         {
1077                             "name": "int_pktgen_private_subnet_id",
1078                             "value": "vLBMS_zdfw1pktgen01_private_sub_ms"
1079                         },
1080                         {
1081                             "name": "onap_private_net_id",
1082                             "value": "oam_onap_vnf_test"
1083                         },
1084                         {
1085                             "name": "onap_private_subnet_id",
1086                             "value": "oam_onap_vnf_test"
1087                         },
1088                         {
1089                             "name": "vlb_private_net_cidr",
1090                             "value": "192.168.10.0/24"
1091                         },
1092                         {
1093                             "name": "pktgen_private_net_cidr",
1094                             "value": "192.168.9.0/24"
1095                         },
1096                         {
1097                             "name": "onap_private_net_cidr",
1098                             "value": "10.0.0.0/16"
1099                         },
1100                         {
1101                             "name": "vlb_int_private_ip_0",
1102                             "value": "192.168.10.111"
1103                         },
1104                         {
1105                             "name": "vlb_onap_private_ip_0",
1106                             "value": "10.0.150.1"
1107                         },
1108                         {
1109                             "name": "vlb_int_pktgen_private_ip_0",
1110                             "value": "192.168.9.111"
1111                         },
1112                         {
1113                             "name": "vdns_int_private_ip_0",
1114                             "value": "192.168.10.211"
1115                         },
1116                         {
1117                             "name": "vdns_onap_private_ip_0",
1118                             "value": "10.0.150.3"
1119                         },
1120                         {
1121                             "name": "vpg_int_pktgen_private_ip_0",
1122                             "value": "192.168.9.110"
1123                         },
1124                         {
1125                             "name": "vpg_onap_private_ip_0",
1126                             "value": "10.0.150.2"
1127                         },
1128                         {
1129                             "name": "vlb_name_0",
1130                             "value": "vlb-0211-1"
1131                         },
1132                         {
1133                             "name": "vlb_0_mac_address",
1134                             "value": "fa:16:3e:00:01:10"
1135                         },
1136                         {
1137                             "name": "vpg_0_mac_address",
1138                             "value": "fa:16:3e:00:01:20"
1139                         },
1140                         {
1141                             "name": "vip",
1142                             "value": "192.168.9.112"
1143                         },
1144                         {
1145                             "name": "gre_ipaddr",
1146                             "value": "192.168.10.112"
1147                         },
1148                         {
1149                             "name": "vnf_id",
1150                             "value": "vLoadBalancerMS"
1151                         },
1152                         {
1153                             "name": "vf_module_id",
1154                             "value": "vLoadBalancerMS"
1155                         },
1156                         {
1157                             "name": "vnf_name",
1158                             "value": "vLBMS"
1159                         },
1160                         {
1161                             "name": "dcae_collector_ip",
1162                             "value": "10.12.5.20"
1163                         },
1164                         {
1165                             "name": "dcae_collector_port",
1166                             "value": "30235"
1167                         },
1168                         {
1169                             "name": "demo_artifacts_version",
1170                             "value": "1.5.0-SNAPSHOT"
1171                         },
1172                         {
1173                             "name": "install_script_version",
1174                             "value": "1.5.0-SNAPSHOT"
1175                         },
1176                         {
1177                             "name": "nb_api_version",
1178                             "value": "1.2.0"
1179                         },
1180                         {
1181                             "name": "keypair",
1182                             "value": "vlb_key"
1183                         },
1184                         {
1185                             "name": "cloud_env",
1186                             "value": "openstack"
1187                         },
1188                         {
1189                             "name": "nexus_artifact_repo",
1190                             "value": "https://nexus.onap.org"
1191                         },
1192                         {
1193                             "name": "sec_group",
1194                             "value": "default"
1195                         }
1196                     ]
1197                 }
1198             },
1199             "vnf-topology-identifier-structure": {
1200                 "vnf-name": "vLoadBalancer-Vnf-0211-1",
1201                 "vnf-type": "vLoadBalancer/vLoadBalancer 0"
1202             },
1203             "vnf-resource-assignments": {
1204                 "availability-zones": {
1205                     "availability-zone": [
1206                         "nova"
1207                     ],
1208                     "max-count": 1
1209                 },
1210                 "vnf-networks": {
1211                     "vnf-network": []
1212                 }
1213             }
1214         },
1215         "request-information": {
1216             "request-id": "robot12",
1217             "order-version": "1",
1218             "notification-url": "openecomp.org",
1219             "order-number": "1",
1220             "request-action": "PreloadVfModuleRequest"
1221         },
1222         "sdnc-request-header": {
1223             "svc-request-id": "robot12",
1224             "svc-notification-url": "http://openecomp.org:8080/adapters/rest/SDNCNotify",
1225             "svc-action": "reserve"
1226         }
1227     }
1228   }'
1229
1230
1231 Module-2 Preload
1232 ~~~~~~~~~~~~~~~~
1233 ::
1234
1235
1236     curl -X POST \
1237   http://<Any_K8S_Node_IP_Address>:30202/restconf/operations/GENERIC-RESOURCE-API:preload-vf-module-topology-operation \
1238   -H 'Content-Type: application/json' \
1239   -H 'Postman-Token: 5f2490b3-6e4a-4512-9a0d-0aa6f6fa0ea8' \
1240   -H 'cache-control: no-cache' \
1241   -d '{
1242     "input": {
1243         "preload-vf-module-topology-information": {
1244             "vf-module-topology": {
1245                 "vf-module-topology-identifier": {
1246                     "vf-module-name": "vPacketGen-0211-1"
1247                 },
1248                 "vf-module-parameters": {
1249                     "param": [
1250                         {
1251                             "name": "vpg_image_name",
1252                             "value": "ubuntu-16-04-cloud-amd64"
1253                         },
1254                         {
1255                             "name": "vpg_flavor_name",
1256                             "value": "m1.medium"
1257                         },
1258                         {
1259                             "name": "public_net_id",
1260                             "value": "public"
1261                         },
1262                         {
1263                             "name": "int_pktgen_private_net_id",
1264                             "value": "vLBMS_zdfw1pktgen01_private_ms"
1265                         },
1266                         {
1267                             "name": "int_pktgen_private_subnet_id",
1268                             "value": "vLBMS_zdfw1pktgen01_private_sub_ms"
1269                         },
1270                         {
1271                             "name": "onap_private_net_id",
1272                             "value": "oam_onap_vnf_test"
1273                         },
1274                         {
1275                             "name": "onap_private_subnet_id",
1276                             "value": "oam_onap_vnf_test"
1277                         },
1278                         {
1279                             "name": "pktgen_private_net_cidr",
1280                             "value": "192.168.9.0/24"
1281                         },
1282                         {
1283                             "name": "onap_private_net_cidr",
1284                             "value": "10.0.0.0/16"
1285                         },
1286                         {
1287                             "name": "vlb_int_pktgen_private_ip_0",
1288                             "value": "192.168.9.111"
1289                         },
1290                         {
1291                             "name": "vpg_int_pktgen_private_ip_0",
1292                             "value": "192.168.9.110"
1293                         },
1294                         {
1295                             "name": "vpg_onap_private_ip_0",
1296                             "value": "10.0.150.2"
1297                         },
1298                         {
1299                             "name": "vpg_name_0",
1300                             "value": "vpg-0211-1"
1301                         },
1302                         {
1303                             "name": "vlb_0_mac_address",
1304                             "value": "fa:16:3e:00:01:10"
1305                         },
1306                         {
1307                             "name": "vpg_0_mac_address",
1308                             "value": "fa:16:3e:00:01:20"
1309                         },
1310                         {
1311                             "name": "pg_int",
1312                             "value": "192.168.9.109"
1313                         },
1314                         {
1315                             "name": "vnf_id",
1316                             "value": "vLoadBalancerMS"
1317                         },
1318                         {
1319                             "name": "vf_module_id",
1320                             "value": "vLoadBalancerMS"
1321                         },
1322                         {
1323                             "name": "vnf_name",
1324                             "value": "vLBMS"
1325                         },
1326                         {
1327                             "name": "demo_artifacts_version",
1328                             "value": "1.5.0-SNAPSHOT"
1329                         },
1330                         {
1331                             "name": "install_script_version",
1332                             "value": "1.5.0-SNAPSHOT"
1333                         },
1334                         {
1335                             "name": "nb_api_version",
1336                             "value": "1.2.0"
1337                         },
1338                         {
1339                             "name": "keypair",
1340                             "value": "vlb_key"
1341                         },
1342                         {
1343                             "name": "cloud_env",
1344                             "value": "openstack"
1345                         },
1346                         {
1347                             "name": "nexus_artifact_repo",
1348                             "value": "https://nexus.onap.org"
1349                         },
1350                         {
1351                             "name": "sec_group",
1352                             "value": "default"
1353                         }
1354                     ]
1355                 }
1356             },
1357             "vnf-topology-identifier-structure": {
1358                 "vnf-name": "vLoadBalancer-Vnf-0211-1",
1359                 "vnf-type": "vLoadBalancer/vLoadBalancer 0"
1360             },
1361             "vnf-resource-assignments": {
1362                 "availability-zones": {
1363                     "availability-zone": [
1364                         "nova"
1365                     ],
1366                     "max-count": 1
1367                 },
1368                 "vnf-networks": {
1369                     "vnf-network": []
1370                 }
1371             }
1372         },
1373         "request-information": {
1374             "request-id": "robot12",
1375             "order-version": "1",
1376             "notification-url": "openecomp.org",
1377             "order-number": "1",
1378             "request-action": "PreloadVfModuleRequest"
1379         },
1380         "sdnc-request-header": {
1381             "svc-request-id": "robot12",
1382             "svc-notification-url": "http://openecomp.org:8080/adapters/rest/SDNCNotify",
1383             "svc-action": "reserve"
1384         }
1385     }
1386  }'
1387
1388
1389 Module-3 Preload
1390 ~~~~~~~~~~~~~~~~
1391
1392 ::
1393
1394     curl -X POST \
1395   http://<Any_K8S_Node_IP_Address>:30202/restconf/operations/GENERIC-RESOURCE-API:preload-vf-module-topology-operation \
1396   -H 'Content-Type: application/json' \
1397   -H 'Postman-Token: fd0a4706-f955-490a-875e-08ddd8fe002e' \
1398   -H 'cache-control: no-cache' \
1399   -d '{
1400     "input": {
1401         "preload-vf-module-topology-information": {
1402             "vf-module-topology": {
1403                 "vf-module-topology-identifier": {
1404                     "vf-module-name": "vDNS-0125-1"
1405                 },
1406                 "vf-module-parameters": {
1407                     "param": [
1408                         {
1409                             "name": "vdns_image_name",
1410                             "value": "ubuntu-16-04-cloud-amd64"
1411                         },
1412                         {
1413                             "name": "vdns_flavor_name",
1414                             "value": "m1.medium"
1415                         },
1416                         {
1417                             "name": "public_net_id",
1418                             "value": "public"
1419                         },
1420                         {
1421                             "name": "int_private_net_id",
1422                             "value": "vLBMS_zdfw1lb01_private"
1423                         },
1424                         {
1425                             "name": "int_private_subnet_id",
1426                             "value": "vLBMS_zdfw1lb01_private_sub_ms"
1427                         },
1428                         {
1429                             "name": "onap_private_net_id",
1430                             "value": "oam_onap_vnf_test"
1431                         },
1432                         {
1433                             "name": "onap_private_subnet_id",
1434                             "value": "oam_onap_vnf_test"
1435                         },
1436                         {
1437                             "name": "vlb_private_net_cidr",
1438                             "value": "192.168.10.0/24"
1439                         },
1440                         {
1441                             "name": "onap_private_net_cidr",
1442                             "value": "10.0.0.0/16"
1443                         },
1444                         {
1445                             "name": "vlb_int_private_ip_0",
1446                             "value": "192.168.10.111"
1447                         },
1448                         {
1449                             "name": "vlb_onap_private_ip_0",
1450                             "value": "10.0.150.1"
1451                         },
1452                         {
1453                             "name": "vlb_int_pktgen_private_ip_0",
1454                             "value": "192.168.9.111"
1455                         },
1456                         {
1457                             "name": "vdns_int_private_ip_0",
1458                             "value": "192.168.10.212"
1459                         },
1460                         {
1461                             "name": "vdns_onap_private_ip_0",
1462                             "value": "10.0.150.4"
1463                         },
1464                         {
1465                             "name": "vdns_name_0",
1466                             "value": "vdns-0211-1"
1467                         },
1468                         {
1469                             "name": "vnf_id",
1470                             "value": "vLoadBalancerMS"
1471                         },
1472                         {
1473                             "name": "vf_module_id",
1474                             "value": "vLoadBalancerMS"
1475                         },
1476                         {
1477                             "name": "vnf_name",
1478                             "value": "vLBMS"
1479                         },
1480                         {
1481                             "name": "install_script_version",
1482                             "value": "1.5.0-SNAPSHOT"
1483                         },
1484                         {
1485                             "name": "nb_api_version",
1486                             "value": "1.2.0"
1487                         },
1488                         {
1489                             "name": "keypair",
1490                             "value": "vlb_key"
1491                         },
1492                         {
1493                             "name": "cloud_env",
1494                             "value": "openstack"
1495                         },
1496                         {
1497                             "name": "sec_group",
1498                             "value": "default"
1499                         },
1500                         {
1501                             "name": "nexus_artifact_repo",
1502                             "value": "https://nexus.onap.org"
1503                         }
1504                     ]
1505                 }
1506             },
1507             "vnf-topology-identifier-structure": {
1508                 "vnf-name": "vLoadBalancer-Vnf-0125-1",
1509                 "vnf-type": "vLoadBalancer/vLoadBalancer 0"
1510             },
1511             "vnf-resource-assignments": {
1512                 "availability-zones": {
1513                     "availability-zone": [
1514                         "nova"
1515                     ],
1516                     "max-count": 1
1517                 },
1518                 "vnf-networks": {
1519                     "vnf-network": []
1520                 }
1521             }
1522         },
1523         "request-information": {
1524             "request-id": "robot12",
1525             "order-version": "1",
1526             "notification-url": "openecomp.org",
1527             "order-number": "1",
1528             "request-action": "PreloadVfModuleRequest"
1529         },
1530         "sdnc-request-header": {
1531             "svc-request-id": "robot12",
1532             "svc-notification-url": "http://openecomp.org:8080/adapters/rest/SDNCNotify",
1533             "svc-action": "reserve"
1534         }
1535     }
1536  }'
1537
1538 The Heat environment files already set many parameters used for VF module instantiation. Those parameters can be reused in the SDNC preload too, while placeholders like "PUT THE IP ADDRESS HERE" or "PUT THE PUBLIC KEY HERE" must be overridden.
1539
1540 To instantiate VF modules, please refer to this wiki page: https://wiki.onap.org/display/DW/Tutorial+vIMS%3A+VID+Instantiate+the+VNF using vLB as ServiceType.
1541
1542 6) **Post Instantiation Actions**: Please refer to Sections 3-1 for vLB configuration and Section 3-2 for resource orchestration with heatbridge.
1543
1544 7) **Triggering Scale Out Manually**: Please refer to Section 4 to trigger scale out manually with direct API call to SO.
1545
1546
1547 PART 6 - Test Status and Plans
1548 ------------------------------
1549 Dublin Scale Out test cases can be found here: https://wiki.onap.org/pages/viewpage.action?pageId=59966105
1550
1551
1552 PART 7 - Known Issues and Resolutions
1553 -------------------------------------
1554 1) When running closed loop-enabled scale out, the closed loop designed in CLAMP conflicts with the default closed loop defined for the old vLB/vDNS use case
1555
1556 Resolution: Change TCA configuration for the old vLB/vDNS use case
1557
1558 - Connect to Consul: http://<ANY K8S VM IP ADDRESS>:30270 and click on "Key/Value" → "dcae-tca-analytics"
1559 - Change "eventName" in the vLB default policy to something different, for example "vLB" instead of the default value "vLoadBalancer"
1560 - Change "subscriberConsumerGroup" in the TCA configuration to something different, for example "OpenDCAE-c13" instead of the default value "OpenDCAE-c12"
1561 - Click "UPDATE" to upload the new TCA configuration