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
  68 PART 1 - Service Definition and Onboarding
  69 ------------------------------------------
  70 This use-case requires operations on several ONAP components to perform service definition and onboarding.
  71
  72
  73 1-1 Using CDS : VNF Configuration Modeling and Upload
  74 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  75 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.
  76
  77 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
  78
  79
  80 1-2 Using SDC : VNF Onboarding and Service Creation
  81 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  82 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:
  83 ::
  84
  85     zip ../vLB.zip *
  86
  87 For a complete description of service design and creation, please refer to the SDC wiki page: https://wiki.onap.org/display/DW/Design
  88
  89 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!).
  90
  91 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:
  92
  93 .. figure:: files/scaleout/9.png
  94    :align: center
  95
  96 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.
  97
  98 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.
  99
 100 .. figure:: files/scaleout/10.png
 101    :align: center
 102
 103 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.
 104
 105 .. figure:: files/scaleout/11.png
 106    :align: center
 107
 108
 109 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:
 110
 111 .. figure:: files/scaleout/1.png
 112    :align: center
 113
 114 Upload the DCAE blueprint linked at the top of the page using the pop-up window.
 115
 116 .. figure:: files/scaleout/2.png
 117    :align: center
 118
 119 The blueprint will appear in the artifacts section on the right.
 120
 121 .. figure:: files/scaleout/3.png
 122    :align: center
 123
 124 To attach a Policy Model to the service, open the Policy drop-down list on left.
 125
 126 .. figure:: files/scaleout/4.png
 127    :align: center
 128
 129 Then, add the TCA Policy.
 130
 131 .. figure:: files/scaleout/5.png
 132    :align: center
 133
 134 The Policy will be attached to the service defined in SDC
 135
 136 .. figure:: files/scaleout/6.png
 137    :align: center
 138
 139 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.
 140
 141 .. figure:: files/scaleout/7.png
 142    :align: center
 143
 144 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.
 145
 146 .. figure:: files/scaleout/8.png
 147    :align: center
 148
 149 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.
 150
 151
 152
 153 1-3 Using a Shell Script : Deploy Naming Policy
 154 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 155 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.
 156
 157 ::
 158
 159     kubectl exec -it dev-policy-drools-0
 160     ./push_naming_policy.sh
 161
 162
 163 1-4 Using CLAMP : Closed Loop Design
 164 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 165 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
 166
 167 Use the "Closed Loop" link to open a distributed model.
 168
 169 .. figure:: files/scaleout/12.png
 170    :align: center
 171
 172 Select the closed loop associated to the distributed service model.
 173
 174 .. figure:: files/scaleout/13.png
 175    :align: center
 176
 177 The closed loop main page for TCA microservices is shown below.
 178
 179 .. figure:: files/scaleout/14.png
 180    :align: center
 181
 182 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.
 183
 184 .. figure:: files/scaleout/15.png
 185    :align: center
 186
 187 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".
 188
 189 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.
 190
 191 .. figure:: files/scaleout/16.png
 192    :align: center
 193
 194 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.
 195
 196 .. figure:: files/scaleout/17.png
 197    :align: center
 198
 199 Select "VF Module Create" recipe and "SO" actor. The payload section is:
 200
 201 ::
 202
 203     requestParameters: '{"usePreload":false,"userParams":[]}'
 204     configurationParameters: '[{"ip-addr":"$.vf-module-topology.vf-module-parameters.param[17].value","oam-ip-addr":"$.vf-module-topology.vf-module-parameters.param[31].value"}]'
 205
 206 Policy Engine passes the payload to SO, which will then use it during VF module instantiation to resolve configuration parameters. The JSON path
 207
 208 ::
 209
 210     "ip-addr":"$.vf-module-topology.vf-module-parameters.param[17].value"
 211
 212 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.
 213
 214 The target type to select is VF module, as we are scaling a VF module. Please select the vDNS module as target resource ID.
 215
 216 .. figure:: files/scaleout/18.png
 217    :align: center
 218
 219 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.
 220
 221 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.
 222
 223 .. figure:: files/scaleout/20.png
 224    :align: center
 225
 226 At this point, the closed loop is deployed to Policy Engine and DCAE, and a new microservice will be deployed to the DCAE platform.
 227
 228
 229 1-5 Using CDT : Creating a VNF Template
 230 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 231 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.
 232 CDT requires two input:
 233
 234 1) the list of parameters that APPC will receive (ip-addr, oam-ip-addr, enabled in the example above);
 235
 236 2) the VNF API that APPC will use to reconfigure the VNF.
 237
 238 Below is an example of the parameters file (yaml format), which we call parameters.yaml:
 239 ::
 240
 241     version: V1
 242     vnf-parameter-list:
 243     - name: ip-addr
 244       type: null
 245       description: null
 246       required: "true"
 247       default: null
 248       source: Manual
 249       rule-type: null
 250       request-keys: null
 251       response-keys: null
 252     - name: oam-ip-addr
 253       type: null
 254       description: null
 255       required: "true"
 256       default: null
 257       source: Manual
 258       rule-type: null
 259       request-keys: null
 260       response-keys: null
 261     - name: enabled
 262       type: null
 263       description: null
 264       required: "false"
 265       default: null
 266       source: Manual
 267       rule-type: null
 268       request-keys: null
 269       response-keys: null
 270
 271 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):
 272 ::
 273
 274     <vlb-business-vnf-onap-plugin xmlns="urn:opendaylight:params:xml:ns:yang:vlb-business-vnf-onap-plugin">
 275         <vdns-instances>
 276             <vdns-instance>
 277                 <ip-addr>${ip-addr}</ip-addr>
 278                 <oam-ip-addr>${oam-ip-addr}</oam-ip-addr>
 279                 <enabled>true</enabled>
 280             </vdns-instance>
 281         </vdns-instances>
 282     </vlb-business-vnf-onap-plugin>
 283
 284 To create the VNF template in CDT, the following steps are required:
 285
 286 - Connect to the CDT GUI: http://ANY-K8S-IP:30289
 287 - Click "My VNF" Tab. Create your user ID, if necessary
 288 - Click "Create new VNF" entering the VNF type as reported in VID or AAI, e.g. vLoadBalancerMS/vLoadBalancerMS 0
 289 - Select "ConfigScaleOut" action
 290 - Create a new template identifier using the VNF type name in service model as template name, e.g. Vloadbalancerms..vdns..module-3
 291 - Select protocol (Netconf-XML), VNF username (admin), and VNF port number (2831 for NETCONF)
 292 - Click "Parameter Definition" Tab and upload the parameters (.yaml) file
 293 - Click "Template Tab" and upload API template (.yaml) file
 294 - Click "Reference Data" Tab
 295 - Click "Save All to APPC"
 296
 297 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:
 298 ::
 299
 300   restconf/operational/health-vnf-onap-plugin:health-vnf-onap-plugin-state/health-check
 301
 302 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.
 303 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:
 304 ::
 305
 306   mysql -u sdnctl -p (type "gamma" when password is prompted)
 307   use sdnctl;
 308   UPDATE DEVICE_AUTHENTICATION SET PASSWORD='admin' WHERE
 309   VNF_TYPE='vLoadBalancerMS/vLoadBalancerMS 0'; (use your VNF type)
 310
 311
 312 1-6 Using SO : Setting the Controller Type in SO Database
 313 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 314 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.
 315
 316 To do so:
 317
 318 - Connect to one of the replicas of the MariaDB database
 319 - Type
 320
 321 ::
 322
 323     mysql -ucataloguser -pcatalog123
 324
 325 - Use catalogdb databalse
 326
 327 ::
 328
 329     use catalogdb;
 330
 331 - Create an association between APPC and the VNF type, for example:
 332
 333 ::
 334
 335     INSERT INTO controller_selection_reference (`VNF_TYPE`, `CONTROLLER_NAME`, `ACTION_CATEGORY`) VALUES ('<VNF Type>', 'APPC', 'ConfigScaleOut');
 336     INSERT INTO controller_selection_reference (`VNF_TYPE`, `CONTROLLER_NAME`, `ACTION_CATEGORY`) VALUES ('<VNF Type>', 'APPC', 'HealthCheck');
 337
 338 SO has a default entry for VNF type "vLoadBalancerMS/vLoadBalancerMS 0"
 339
 340
 341
 342
 343 PART 2 - Scale Out Use Case Instantiation
 344 -----------------------------------------
 345
 346 GET information from SDC catalogdb
 347
 348 ::
 349
 350   curl -X GET \
 351     'https://{{k8s}}:30204/sdc/v1/catalog/services' \
 352     -H 'Authorization: Basic dmlkOktwOGJKNFNYc3pNMFdYbGhhazNlSGxjc2UyZ0F3ODR2YW9HR21KdlV5MlU=' \
 353     -H 'X-ECOMP-InstanceID: VID' \
 354     -H 'cache-control: no-cache'
 355
 356
 357 In the response you should find values for:
 358
 359 * service-uuid
 360 * service-invariantUUID
 361 * service-name
 362
 363
 364 GET informations from SO catalogdb
 365
 366 ::
 367
 368   curl -X GET \
 369     'http://{{k8s}}:30744/ecomp/mso/catalog/v2/serviceVnfs?serviceModelName={{service-name}}' \
 370     -H 'Authorization: Basic YnBlbDpwYXNzd29yZDEk' \
 371     -H 'cache-control: no-cache'
 372
 373
 374 In the response you should find values for:
 375
 376 * vnf-modelinfo-modelname
 377 * vnf-modelinfo-modeluuid
 378 * vnf-modelinfo-modelinvariantuuid
 379 * vnf-modelinfo-modelcustomizationuuid
 380 * vnf-modelinfo-modelinstancename
 381 * vnf-vfmodule-0-modelinfo-modelname
 382 * vnf-vfmodule-0-modelinfo-modeluuid
 383 * vnf-vfmodule-0-modelinfo-modelinvariantuuid
 384 * vnf-vfmodule-0-modelinfo-modelcustomizationuuid
 385 * vnf-vfmodule-1-modelinfo-modelname
 386 * vnf-vfmodule-1-modelinfo-modeluuid
 387 * vnf-vfmodule-1-modelinfo-modelinvariantuuid
 388 * vnf-vfmodule-1-modelinfo-modelcustomizationuuid
 389 * vnf-vfmodule-2-modelinfo-modelname
 390 * vnf-vfmodule-2-modelinfo-modeluuid
 391 * vnf-vfmodule-2-modelinfo-modelinvariantuuid
 392 * vnf-vfmodule-2-modelinfo-modelcustomizationuuid
 393 * vnf-vfmodule-3-modelinfo-modelname
 394 * vnf-vfmodule-3-modelinfo-modeluuid
 395 * vnf-vfmodule-3-modelinfo-modelinvariantuuid
 396 * vnf-vfmodule-3-modelinfo-modelcustomizationuuid
 397
 398
 399 Note : all those informations are also available in the TOSCA service template in the SDC
 400
 401 You need after:
 402
 403 * the SSH public key value that will allow you to connect to the VM.
 404 * the cloudSite name and TenantId where to deploy the service
 405 * the name of the security group that will be used in the tenant for your service
 406 * the name of the network that will be used to connect your VM
 407 * the name of your OpenStack image
 408 * the name of your OpenStack VM flavor
 409
 410 We supposed here that we are using some already declared informations:
 411
 412 * customer named "Demonstration"
 413 * subscriptionServiceType named "vLB"
 414 * projectName named "Project-Demonstration"
 415 * owningEntityName named "OE-Demonstration"
 416 * platformName named "test"
 417 * lineOfBusinessName named "someValue"
 418
 419 Having all those information, you are now able to build the SO request
 420 that will instantiate Service, VNF, VF modules and Heat stacks:
 421
 422 ::
 423
 424   curl -X POST \
 425   'http://{{k8s}}:30277/onap/so/infra/serviceInstantiation/v7/serviceInstances' \
 426   -H 'Content-Type: application/json' \
 427   -H 'cache-control: no-cache' \
 428   -d '{
 429   "requestDetails": {
 430     "subscriberInfo": {
 431       "globalSubscriberId": "Demonstration"
 432     },
 433     "requestInfo": {
 434       "suppressRollback": false,
 435       "productFamilyId": "a9a77d5a-123e-4ca2-9eb9-0b015d2ee0fb",
 436       "requestorId": "VID",
 437       "instanceName": "{{service-instance-name}}",
 438       "source": "VID"
 439     },
 440     "cloudConfiguration": {
 441       "lcpCloudRegionId": "{{cloud-region}}",
 442       "tenantId": "{{tenantId}}"
 443     },
 444     "requestParameters": {
 445       "subscriptionServiceType": "vLB",
 446       "userParams": [
 447         {
 448           "Homing_Solution": "none"
 449         },
 450         {
 451           "service": {
 452             "instanceParams": [
 453
 454             ],
 455             "instanceName": "{{service-instance-name}}",
 456             "resources": {
 457               "vnfs": [
 458                 {
 459                   "modelInfo": {
 460                     "modelName": "{{vnf-modelinfo-modelname}}",
 461                     "modelVersionId": "{{vnf-modelinfo-modeluuid}}",
 462                     "modelInvariantUuid": "{{vnf-modelinfo-modelinvariantuuid}}",
 463                     "modelVersion": "1.0",
 464                     "modelCustomizationId": "{{vnf-modelinfo-modelcustomizationuuid}}",
 465                     "modelInstanceName": "{{vnf-modelinfo-modelinstancename}}"
 466                   },
 467                   "cloudConfiguration": {
 468                     "lcpCloudRegionId": "{{CloudSite-name}}",
 469                     "tenantId": "{{tenantId}}"
 470                   },
 471                   "platform": {
 472                     "platformName": "test"
 473                   },
 474                   "lineOfBusiness": {
 475                     "lineOfBusinessName": "someValue"
 476                   },
 477                   "productFamilyId": "a9a77d5a-123e-4ca2-9eb9-0b015d2ee0fb",
 478                   "instanceName": "{{vnf-modelinfo-modelinstancename}}",
 479                   "instanceParams": [
 480                     {
 481                       "onap_private_net_id": "olc-private",
 482                       "onap_private_subnet_id": "olc-private",
 483                       "pub_key": "{{Your SSH public key value}}",
 484                       "image_name": "{{my_image_name}}",
 485                       "flavor_name":"{{my_VM_flavor_name}}"
 486                     }
 487                   ],
 488                   "vfModules": [
 489                     {
 490                       "modelInfo": {
 491                         "modelName": "{{vnf-vfmodule-0-modelinfo-modelname}}",
 492                         "modelVersionId": "{{vnf-vfmodule-0-modelinfo-modeluuid}}",
 493                         "modelInvariantUuid": "{{vnf-vfmodule-0-modelinfo-modelinvariantuuid}}",
 494                         "modelVersion": "1",
 495                         "modelCustomizationId": "{{vnf-vfmodule-0-modelinfo-modelcustomizationuuid}}"
 496                        },
 497                       "instanceName": "{{vnf-vfmodule-0-modelinfo-modelname}}",
 498                       "instanceParams": [
 499                                                  {
 500                           "sec_group": "{{your_security_group_name}}",
 501                           "public_net_id": "{{your_public_network_name}}"
 502                         }
 503                       ]
 504                     },
 505                     {
 506                       "modelInfo": {
 507                         "modelName": "{{vnf-vfmodule-1-modelinfo-modelname}}",
 508                         "modelVersionId": "{{vnf-vfmodule-1-modelinfo-modeluuid}}",
 509                         "modelInvariantUuid": "{{vnf-vfmodule-1-modelinfo-modelinvariantuuid}}",
 510                         "modelVersion": "1",
 511                         "modelCustomizationId": "{{vnf-vfmodule-1-modelinfo-modelcustomizationuuid}}"
 512                        },
 513                       "instanceName": "{{vnf-vfmodule-1-modelinfo-modelname}}",
 514                       "instanceParams": [
 515                         {
 516                           "sec_group": "{{your_security_group_name}}",
 517                           "public_net_id": "{{your_public_network_name}}"
 518                         }
 519                       ]
 520                     },
 521                     {
 522                       "modelInfo": {
 523                         "modelName": "{{vnf-vfmodule-2-modelinfo-modelname}}",
 524                         "modelVersionId": "{{vnf-vfmodule-2-modelinfo-modeluuid}}",
 525                         "modelInvariantUuid": "{{vnf-vfmodule-2-modelinfo-modelinvariantuuid}}",
 526                         "modelVersion": "1",
 527                         "modelCustomizationId": "{{vnf-vfmodule-2-modelinfo-modelcustomizationuuid}}"
 528                        },
 529                       "instanceName": "{{vnf-vfmodule-2-modelinfo-modelname}}",
 530                       "instanceParams": [
 531                         {
 532                           "sec_group": "{{your_security_group_name}}",
 533                           "public_net_id": "{{your_public_network_name}}"
 534                         }
 535                       ]
 536                     },
 537                     {
 538                       "modelInfo": {
 539                         "modelName": "{{vnf-vfmodule-3-modelinfo-modelname}}",
 540                         "modelVersionId": "{{vnf-vfmodule-3-modelinfo-modeluuid}}",
 541                         "modelInvariantUuid": "{{vnf-vfmodule-3-modelinfo-modelinvariantuuid}}",
 542                         "modelVersion": "1",
 543                         "modelCustomizationId": "{{vnf-vfmodule-3-modelinfo-modelcustomizationuuid}}"
 544                       },
 545                       "instanceName": "{{vnf-vfmodule-3-modelinfo-modelname}}",
 546                       "instanceParams": [
 547                         {
 548                           "sec_group": "{{your_security_group_name}}",
 549                           "public_net_id": "{{your_public_network_name}}"
 550                         }
 551                       ]
 552                     }
 553                   ]
 554                 }
 555               ]
 556             },
 557             "modelInfo": {
 558               "modelVersion": "1.0",
 559               "modelVersionId": "{{service-uuid}}",
 560               "modelInvariantId": "{{service-invariantUUID}}",
 561               "modelName": "{{service-name}}",
 562               "modelType": "service"
 563             }
 564           }
 565         }
 566       ],
 567       "aLaCarte": false
 568     },
 569     "project": {
 570       "projectName": "Project-Demonstration"
 571     },
 572     "owningEntity": {
 573       "owningEntityId": "24ef5425-bec4-4fa3-ab03-c0ecf4eaac96",
 574       "owningEntityName": "OE-Demonstration"
 575     },
 576     "modelInfo": {
 577       "modelVersion": "1.0",
 578       "modelVersionId": "{{service-uuid}}",
 579       "modelInvariantId": "{{service-invariantUUID}}",
 580       "modelName": "{{service-name}}",
 581       "modelType": "service"
 582     }
 583   }
 584  }'
 585
 586
 587 In the response, you will obtain a requestId that will be usefull
 588 to follow the instantiation request status in the ONAP SO:
 589
 590
 591 ::
 592
 593   curl -X GET \
 594     'http://{{k8s}}:30086/infraActiveRequests/{{requestid}}' \
 595     -H 'cache-control: no-cache'
 596
 597
 598
 599
 600
 601 PART 3 - Post Instantiation Operations
 602 --------------------------------------
 603
 604 3-1 Using the VNF : vLB Manual Configuration
 605 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 606 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:
 607
 608 ::
 609
 610   curl -X PUT \
 611   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 \
 612   -H 'Accept: application/json' \
 613   -H 'Content-Type: application/json' \
 614   -H 'Postman-Token: a708b064-adb1-4804-89a7-ee604f5fe76f' \
 615   -H 'cache-control: no-cache' \
 616   -d '{
 617     "vdns-instance": [
 618         {
 619             "ip-addr": "192.168.10.59",
 620             "oam-ip-addr": "10.0.101.49",
 621             "enabled": true
 622         }
 623     ]
 624   }'
 625
 626 At this point, the VNF is fully set up.
 627
 628
 629 3-2 Updating AAI with VNF resources
 630 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 631 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:
 632
 633 ::
 634
 635     ./demo-k8s.sh onap heatbridge <vLB stack_name in OpenStack> <service_instance_id> vLB vlb_onap_private_ip_0
 636
 637 Heatbridge is needed for control loops because DCAE and Policy runs queries against AAI using vServer names as key.
 638
 639
 640 PART 4 - Triggering Scale Out Manually
 641 --------------------------------------
 642
 643 For scale out with manual trigger, VID is not supported at this time. Users can run the use case by directly calling SO APIs:
 644
 645 ::
 646
 647   curl -X POST \
 648   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 \
 649   -H 'Accept: application/json' \
 650   -H 'Authorization: Basic SW5mcmFQb3J0YWxDbGllbnQ6cGFzc3dvcmQxJA==' \
 651   -H 'Cache-Control: no-cache' \
 652   -H 'Connection: keep-alive' \
 653   -H 'Content-Type: application/json' \
 654   -H 'Postman-Token: 12f2601a-4eb2-402c-a51a-f29502359501,9befda68-b2c9-4e7a-90ca-1be9c24ef664' \
 655   -H 'User-Agent: PostmanRuntime/7.15.0' \
 656   -H 'accept-encoding: gzip, deflate' \
 657   -H 'cache-control: no-cache' \
 658   -H 'content-length: 2422' \
 659   -H 'cookie: JSESSIONID=B3BA24216367F9D39E3DF5E8CBA4BC64' \
 660   -b JSESSIONID=B3BA24216367F9D39E3DF5E8CBA4BC64 \
 661   -d '{
 662     "requestDetails": {
 663         "modelInfo": {
 664             "modelCustomizationName": "VdnsloadbalancerCds..vdns..module-3",
 665             "modelCustomizationId": "ded42059-2f35-42d4-848b-16e1ab1ad197",
 666             "modelInvariantId": "2815d321-c6b4-4f21-b7f7-fa5adf8ed7d9",
 667             "modelVersionId": "524e34ed-9789-453e-ab73-8eff30eafef3",
 668             "modelName": "VdnsloadbalancerCds..vdns..module-3",
 669             "modelType": "vfModule",
 670             "modelVersion": "1"
 671         },
 672         "cloudConfiguration": {
 673             "lcpCloudRegionId": "RegionOne",
 674             "tenantId": "d570c718cbc545029f40e50b75eb13df",
 675             "cloudOwner": "CloudOwner"
 676         },
 677         "requestInfo": {
 678             "instanceName": "vDNS-VM-02",
 679             "source": "VID",
 680             "suppressRollback": false,
 681             "requestorId": "demo"
 682         },
 683         "requestParameters": {
 684             "userParams": []
 685         },
 686         "relatedInstanceList": [
 687             {
 688                 "relatedInstance": {
 689                     "instanceId": "7d3ca782-c486-44b3-9fe5-39f322d8ee80",
 690                     "modelInfo": {
 691                         "modelType": "service",
 692                         "modelInvariantId": "dfabdcae-cf50-4801-9885-9a3a9cc07e6f",
 693                         "modelVersionId": "ee55b537-7be5-4377-93c1-5d92931b6a78",
 694                         "modelName": "vLoadBalancerCDS",
 695                         "modelVersion": "1.0"
 696                     }
 697                 }
 698             },
 699             {
 700                 "relatedInstance": {
 701                     "instanceId": "9d33cf2d-d6aa-4b9e-a311-460a6be5a7de",
 702                     "modelInfo": {
 703                         "modelType": "vnf",
 704                         "modelInvariantId": "a77f9280-5c02-46cd-b1fc-855975db9df9",
 705                         "modelVersionId": "ff0e99ce-a521-44b5-b11b-da7e07ac83fc",
 706                         "modelName": "vLoadBalancerCDS",
 707                         "modelVersion": "1.0",
 708                         "modelCustomizationId": "b8b8a25d-19de-4581-bb63-f2dc8c0d79a7"
 709                     }
 710                 }
 711             }
 712         ],
 713         "configurationParameters": [
 714             {
 715                 "ip-addr": "$.vf-module-topology.vf-module-parameters.param[17].value",
 716                 "oam-ip-addr": "$.vf-module-topology.vf-module-parameters.param[31].value"
 717             }
 718         ]
 719     }
 720   }'
 721
 722
 723 To fill in the JSON object, users can refer to the Service Model 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.
 724
 725 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:
 726 ::
 727
 728             {
 729                 "relatedInstance": {
 730                     "instanceId": "7d3ca782-c486-44b3-9fe5-39f322d8ee80",
 731                     "modelInfo": {
 732                         "modelType": "service",
 733                         "modelInvariantId": "dfabdcae-cf50-4801-9885-9a3a9cc07e6f",
 734                         "modelVersionId": "ee55b537-7be5-4377-93c1-5d92931b6a78",
 735                         "modelName": "vLoadBalancerCDS",
 736                         "modelVersion": "1.0"
 737                     }
 738                 }
 739             }
 740
 741 .. figure:: files/scaleout/service.png
 742    :align: center
 743
 744
 745 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:
 746
 747 ::
 748
 749             {
 750                 "relatedInstance": {
 751                     "instanceId": "9d33cf2d-d6aa-4b9e-a311-460a6be5a7de",
 752                     "modelInfo": {
 753                         "modelType": "vnf",
 754                         "modelInvariantId": "a77f9280-5c02-46cd-b1fc-855975db9df9",
 755                         "modelVersionId": "ff0e99ce-a521-44b5-b11b-da7e07ac83fc",
 756                         "modelName": "vLoadBalancerCDS",
 757                         "modelVersion": "1.0",
 758                         "modelCustomizationId": "b8b8a25d-19de-4581-bb63-f2dc8c0d79a7"
 759                     }
 760                 }
 761             }
 762
 763 .. figure:: files/scaleout/vnf.png
 764    :align: center
 765
 766
 767 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:
 768
 769 ::
 770
 771         "modelInfo": {
 772             "modelCustomizationName": "Vloadbalancercds..vdns..module-3",
 773             "modelCustomizationId": "ded42059-2f35-42d4-848b-16e1ab1ad197",
 774             "modelInvariantId": "2815d321-c6b4-4f21-b7f7-fa5adf8ed7d9",
 775             "modelVersionId": "524e34ed-9789-453e-ab73-8eff30eafef3",
 776             "modelName": "Vloadbalancercds..vdns..module-3",
 777             "modelType": "vfModule",
 778             "modelVersion": "1"
 779         }
 780
 781 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:
 782
 783 .. figure:: files/scaleout/service.png
 784    :align: center
 785
 786
 787 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:
 788
 789 ::
 790
 791     curl -k -X GET \
 792   https://<Any_K8S_Node_IP_Address>:30233/aai/v16/network/generic-vnfs \
 793   -H 'Accept: application/json' \
 794   -H 'Authorization: Basic QUFJOkFBSQ==' \
 795   -H 'Content-Type: application/json' \
 796   -H 'X-FromAppId: AAI' \
 797   -H 'X-TransactionId: get_aai_subscr'
 798
 799 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:
 800
 801 ::
 802
 803         {
 804             "vnf-id": "9d33cf2d-d6aa-4b9e-a311-460a6be5a7de",
 805             "vnf-name": "vLB_VNF_01",
 806             "vnf-type": "vLoadBalancer/vLoadBalancer 0",
 807             "prov-status": "ACTIVE",
 808             "equipment-role": "",
 809             "orchestration-status": "Active",
 810             "ipv4-oam-address": "10.0.220.10",
 811             "in-maint": true,
 812             "is-closed-loop-disabled": false,
 813             "resource-version": "1565817789379",
 814             "model-invariant-id": "a77f9280-5c02-46cd-b1fc-855975db9df9",
 815             "model-version-id": "ff0e99ce-a521-44b5-b11b-da7e07ac83fc",
 816             "model-customization-id": "b8b8a25d-19de-4581-bb63-f2dc8c0d79a7",
 817             "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/",
 818             "relationship-list": {
 819                 "relationship": [
 820                     {
 821                         "related-to": "service-instance",
 822                         "relationship-label": "org.onap.relationships.inventory.ComposedOf",
 823                         "related-link": "/aai/v16/business/customers/customer/Demonstration/service-subscriptions/service-subscription/vRAR/service-instances/service-instance/7d3ca782-c486-44b3-9fe5-39f322d8ee80",
 824                         "relationship-data": [
 825                             {
 826                                 "relationship-key": "customer.global-customer-id",
 827                                 "relationship-value": "Demonstration"
 828                             },
 829                             {
 830                                 "relationship-key": "service-subscription.service-type",
 831                                 "relationship-value": "vLB"
 832                             },
 833                             {
 834                                 "relationship-key": "service-instance.service-instance-id",
 835                                 "relationship-value": "7d3ca782-c486-44b3-9fe5-39f322d8ee80"
 836                             }
 837                         ],
 838                         "related-to-property": [
 839                             {
 840                                 "property-key": "service-instance.service-instance-name",
 841                                 "property-value": "vLB-Service-0814-1"
 842                             }
 843                         ]
 844                     }
 845                     ...
 846          }
 847
 848 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.
 849
 850 These IDs are also used in the URL request to SO:
 851
 852 ::
 853
 854     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
 855
 856
 857 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).
 858
 859 ::
 860
 861     "configurationParameters": [
 862             {
 863                 "ip-addr": "$.vf-module-topology.vf-module-parameters.param[17].value",
 864                 "oam-ip-addr": "$.vf-module-topology.vf-module-parameters.param[31].value"
 865             }
 866     ]
 867
 868 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:
 869
 870 ::
 871
 872     vf-modules/vf-module/6c24d10b-ece8-4d02-ab98-be283b17cdd3/vf-module-data/vf-module-topology/
 873
 874 The complete URL becomes:
 875
 876 ::
 877
 878     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/
 879
 880
 881 In future releases, we plan to leverage CDS for reconfiguration actions, so as to remove the dependency from JSON paths and simplify the process.
 882
 883
 884 PART 5 - Running the Scale Out Use Case with Configuration Preload
 885 ------------------------------------------------------------------
 886
 887 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).
 888
 889 The procedure is similar to one described above, with some minor changes:
 890
 891 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.
 892
 893 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.
 894
 895 3) **Creation of VNF template with CDT** works as described in Section 1-5.
 896
 897 4) **Controller type selection** in SO works as described in Section 1-6.
 898
 899 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:
 900
 901   * module-0: base module that contains resources, such as internal private networks and public key, shared across the VNF elements
 902   * module-1: vLB resource descriptor
 903   * module-2: vPacketGen resource descriptor
 904   * module-3: vDNS resource descriptor
 905
 906 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.
 907
 908 Module-0 Preload
 909 ~~~~~~~~~~~~~~~~
 910
 911 ::
 912
 913     curl -X POST \
 914   http://<Any_K8S_Node_IP_Address>:30202/restconf/operations/GENERIC-RESOURCE-API:preload-vf-module-topology-operation \
 915   -H 'Content-Type: application/json' \
 916   -H 'Postman-Token: 0a7abc62-9d8f-4f63-8b05-db7cc4c3e28b' \
 917   -H 'cache-control: no-cache' \
 918   -d '{
 919     "input": {
 920         "preload-vf-module-topology-information": {
 921             "vf-module-topology": {
 922                 "vf-module-topology-identifier": {
 923                     "vf-module-name": "vNetworks-0211-1"
 924                 },
 925                 "vf-module-parameters": {
 926                     "param": [
 927                         {
 928                             "name": "vlb_private_net_id",
 929                             "value": "vLBMS_zdfw1lb01_private_ms"
 930                         },
 931                         {
 932                             "name": "pktgen_private_net_id",
 933                             "value": "vLBMS_zdfw1pktgen01_private_ms"
 934                         },
 935                         {
 936                             "name": "vlb_private_net_cidr",
 937                             "value": "192.168.10.0/24"
 938                         },
 939                         {
 940                             "name": "pktgen_private_net_cidr",
 941                             "value": "192.168.9.0/24"
 942                         },
 943                         {
 944                             "name": "vlb_0_int_pktgen_private_port_0_mac",
 945                             "value": "fa:16:3e:00:01:10"
 946                         },
 947                         {
 948                             "name": "vpg_0_int_pktgen_private_port_0_mac",
 949                             "value": "fa:16:3e:00:01:20"
 950                         },
 951                         {
 952                             "name": "vnf_id",
 953                             "value": "vLoadBalancerMS"
 954                         },
 955                         {
 956                             "name": "vnf_name",
 957                             "value": "vLBMS"
 958                         },
 959                         {
 960                             "name": "key_name",
 961                             "value": "vlb_key"
 962                         },
 963                         {
 964                             "name": "pub_key",
 965                             "value": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDQXYJYYi3/OUZXUiCYWdtc7K0m5C0dJKVxPG0eI8EWZrEHYdfYe6WoTSDJCww+1qlBSpA5ac/Ba4Wn9vh+lR1vtUKkyIC/nrYb90ReUd385Glkgzrfh5HdR5y5S2cL/Frh86lAn9r6b3iWTJD8wBwXFyoe1S2nMTOIuG4RPNvfmyCTYVh8XTCCE8HPvh3xv2r4egawG1P4Q4UDwk+hDBXThY2KS8M5/8EMyxHV0ImpLbpYCTBA6KYDIRtqmgS6iKyy8v2D1aSY5mc9J0T5t9S2Gv+VZQNWQDDKNFnxqYaAo1uEoq/i1q63XC5AD3ckXb2VT6dp23BQMdDfbHyUWfJN"
 966                         }
 967                     ]
 968                 }
 969             },
 970             "vnf-topology-identifier-structure": {
 971                 "vnf-name": "vLoadBalancer-Vnf-0211-1",
 972                 "vnf-type": "vLoadBalancer/vLoadBalancer 0"
 973             },
 974             "vnf-resource-assignments": {
 975                 "availability-zones": {
 976                     "availability-zone": [
 977                         "nova"
 978                     ],
 979                     "max-count": 1
 980                 },
 981                 "vnf-networks": {
 982                     "vnf-network": []
 983                 }
 984             }
 985         },
 986         "request-information": {
 987             "request-id": "robot12",
 988             "order-version": "1",
 989             "notification-url": "openecomp.org",
 990             "order-number": "1",
 991             "request-action": "PreloadVfModuleRequest"
 992         },
 993         "sdnc-request-header": {
 994             "svc-request-id": "robot12",
 995             "svc-notification-url": "http://openecomp.org:8080/adapters/rest/SDNCNotify",
 996             "svc-action": "reserve"
 997         }
 998     }
 999   }'
1000
1001
1002 Module-1 Preload
1003 ~~~~~~~~~~~~~~~~
1004
1005 ::
1006
1007     curl -X POST \
1008   http://<Any_K8S_Node_IP_Address>:30202/restconf/operations/GENERIC-RESOURCE-API:preload-vf-module-topology-operation \
1009   -H 'Content-Type: application/json' \
1010   -H 'Postman-Token: 662914ac-29fc-414d-8823-1691fb2c718a' \
1011   -H 'cache-control: no-cache' \
1012   -d '{
1013     "input": {
1014         "preload-vf-module-topology-information": {
1015             "vf-module-topology": {
1016                 "vf-module-topology-identifier": {
1017                     "vf-module-name": "vLoadBalancer-0211-1"
1018                 },
1019                 "vf-module-parameters": {
1020                     "param": [
1021                         {
1022                             "name": "vlb_image_name",
1023                             "value": "ubuntu-16-04-cloud-amd64"
1024                         },
1025                         {
1026                             "name": "vlb_flavor_name",
1027                             "value": "m1.medium"
1028                         },
1029                         {
1030                             "name": "public_net_id",
1031                             "value": "public"
1032                         },
1033                         {
1034                             "name": "int_private_net_id",
1035                             "value": "vLBMS_zdfw1lb01_private_ms"
1036                         },
1037                         {
1038                             "name": "int_private_subnet_id",
1039                             "value": "vLBMS_zdfw1lb01_private_sub_ms"
1040                         },
1041                         {
1042                             "name": "int_pktgen_private_net_id",
1043                             "value": "vLBMS_zdfw1pktgen01_private_ms"
1044                         },
1045                         {
1046                             "name": "int_pktgen_private_subnet_id",
1047                             "value": "vLBMS_zdfw1pktgen01_private_sub_ms"
1048                         },
1049                         {
1050                             "name": "onap_private_net_id",
1051                             "value": "oam_onap_vnf_test"
1052                         },
1053                         {
1054                             "name": "onap_private_subnet_id",
1055                             "value": "oam_onap_vnf_test"
1056                         },
1057                         {
1058                             "name": "vlb_private_net_cidr",
1059                             "value": "192.168.10.0/24"
1060                         },
1061                         {
1062                             "name": "pktgen_private_net_cidr",
1063                             "value": "192.168.9.0/24"
1064                         },
1065                         {
1066                             "name": "onap_private_net_cidr",
1067                             "value": "10.0.0.0/16"
1068                         },
1069                         {
1070                             "name": "vlb_int_private_ip_0",
1071                             "value": "192.168.10.111"
1072                         },
1073                         {
1074                             "name": "vlb_onap_private_ip_0",
1075                             "value": "10.0.150.1"
1076                         },
1077                         {
1078                             "name": "vlb_int_pktgen_private_ip_0",
1079                             "value": "192.168.9.111"
1080                         },
1081                         {
1082                             "name": "vdns_int_private_ip_0",
1083                             "value": "192.168.10.211"
1084                         },
1085                         {
1086                             "name": "vdns_onap_private_ip_0",
1087                             "value": "10.0.150.3"
1088                         },
1089                         {
1090                             "name": "vpg_int_pktgen_private_ip_0",
1091                             "value": "192.168.9.110"
1092                         },
1093                         {
1094                             "name": "vpg_onap_private_ip_0",
1095                             "value": "10.0.150.2"
1096                         },
1097                         {
1098                             "name": "vlb_name_0",
1099                             "value": "vlb-0211-1"
1100                         },
1101                         {
1102                             "name": "vlb_0_mac_address",
1103                             "value": "fa:16:3e:00:01:10"
1104                         },
1105                         {
1106                             "name": "vpg_0_mac_address",
1107                             "value": "fa:16:3e:00:01:20"
1108                         },
1109                         {
1110                             "name": "vip",
1111                             "value": "192.168.9.112"
1112                         },
1113                         {
1114                             "name": "gre_ipaddr",
1115                             "value": "192.168.10.112"
1116                         },
1117                         {
1118                             "name": "vnf_id",
1119                             "value": "vLoadBalancerMS"
1120                         },
1121                         {
1122                             "name": "vf_module_id",
1123                             "value": "vLoadBalancerMS"
1124                         },
1125                         {
1126                             "name": "vnf_name",
1127                             "value": "vLBMS"
1128                         },
1129                         {
1130                             "name": "dcae_collector_ip",
1131                             "value": "10.12.5.20"
1132                         },
1133                         {
1134                             "name": "dcae_collector_port",
1135                             "value": "30235"
1136                         },
1137                         {
1138                             "name": "demo_artifacts_version",
1139                             "value": "1.5.0-SNAPSHOT"
1140                         },
1141                         {
1142                             "name": "install_script_version",
1143                             "value": "1.5.0-SNAPSHOT"
1144                         },
1145                         {
1146                             "name": "nb_api_version",
1147                             "value": "1.2.0"
1148                         },
1149                         {
1150                             "name": "keypair",
1151                             "value": "vlb_key"
1152                         },
1153                         {
1154                             "name": "cloud_env",
1155                             "value": "openstack"
1156                         },
1157                         {
1158                             "name": "nexus_artifact_repo",
1159                             "value": "https://nexus.onap.org"
1160                         },
1161                         {
1162                             "name": "sec_group",
1163                             "value": "default"
1164                         }
1165                     ]
1166                 }
1167             },
1168             "vnf-topology-identifier-structure": {
1169                 "vnf-name": "vLoadBalancer-Vnf-0211-1",
1170                 "vnf-type": "vLoadBalancer/vLoadBalancer 0"
1171             },
1172             "vnf-resource-assignments": {
1173                 "availability-zones": {
1174                     "availability-zone": [
1175                         "nova"
1176                     ],
1177                     "max-count": 1
1178                 },
1179                 "vnf-networks": {
1180                     "vnf-network": []
1181                 }
1182             }
1183         },
1184         "request-information": {
1185             "request-id": "robot12",
1186             "order-version": "1",
1187             "notification-url": "openecomp.org",
1188             "order-number": "1",
1189             "request-action": "PreloadVfModuleRequest"
1190         },
1191         "sdnc-request-header": {
1192             "svc-request-id": "robot12",
1193             "svc-notification-url": "http://openecomp.org:8080/adapters/rest/SDNCNotify",
1194             "svc-action": "reserve"
1195         }
1196     }
1197   }'
1198
1199
1200 Module-2 Preload
1201 ~~~~~~~~~~~~~~~~
1202 ::
1203
1204
1205     curl -X POST \
1206   http://<Any_K8S_Node_IP_Address>:30202/restconf/operations/GENERIC-RESOURCE-API:preload-vf-module-topology-operation \
1207   -H 'Content-Type: application/json' \
1208   -H 'Postman-Token: 5f2490b3-6e4a-4512-9a0d-0aa6f6fa0ea8' \
1209   -H 'cache-control: no-cache' \
1210   -d '{
1211     "input": {
1212         "preload-vf-module-topology-information": {
1213             "vf-module-topology": {
1214                 "vf-module-topology-identifier": {
1215                     "vf-module-name": "vPacketGen-0211-1"
1216                 },
1217                 "vf-module-parameters": {
1218                     "param": [
1219                         {
1220                             "name": "vpg_image_name",
1221                             "value": "ubuntu-16-04-cloud-amd64"
1222                         },
1223                         {
1224                             "name": "vpg_flavor_name",
1225                             "value": "m1.medium"
1226                         },
1227                         {
1228                             "name": "public_net_id",
1229                             "value": "public"
1230                         },
1231                         {
1232                             "name": "int_pktgen_private_net_id",
1233                             "value": "vLBMS_zdfw1pktgen01_private_ms"
1234                         },
1235                         {
1236                             "name": "int_pktgen_private_subnet_id",
1237                             "value": "vLBMS_zdfw1pktgen01_private_sub_ms"
1238                         },
1239                         {
1240                             "name": "onap_private_net_id",
1241                             "value": "oam_onap_vnf_test"
1242                         },
1243                         {
1244                             "name": "onap_private_subnet_id",
1245                             "value": "oam_onap_vnf_test"
1246                         },
1247                         {
1248                             "name": "pktgen_private_net_cidr",
1249                             "value": "192.168.9.0/24"
1250                         },
1251                         {
1252                             "name": "onap_private_net_cidr",
1253                             "value": "10.0.0.0/16"
1254                         },
1255                         {
1256                             "name": "vlb_int_pktgen_private_ip_0",
1257                             "value": "192.168.9.111"
1258                         },
1259                         {
1260                             "name": "vpg_int_pktgen_private_ip_0",
1261                             "value": "192.168.9.110"
1262                         },
1263                         {
1264                             "name": "vpg_onap_private_ip_0",
1265                             "value": "10.0.150.2"
1266                         },
1267                         {
1268                             "name": "vpg_name_0",
1269                             "value": "vpg-0211-1"
1270                         },
1271                         {
1272                             "name": "vlb_0_mac_address",
1273                             "value": "fa:16:3e:00:01:10"
1274                         },
1275                         {
1276                             "name": "vpg_0_mac_address",
1277                             "value": "fa:16:3e:00:01:20"
1278                         },
1279                         {
1280                             "name": "pg_int",
1281                             "value": "192.168.9.109"
1282                         },
1283                         {
1284                             "name": "vnf_id",
1285                             "value": "vLoadBalancerMS"
1286                         },
1287                         {
1288                             "name": "vf_module_id",
1289                             "value": "vLoadBalancerMS"
1290                         },
1291                         {
1292                             "name": "vnf_name",
1293                             "value": "vLBMS"
1294                         },
1295                         {
1296                             "name": "demo_artifacts_version",
1297                             "value": "1.5.0-SNAPSHOT"
1298                         },
1299                         {
1300                             "name": "install_script_version",
1301                             "value": "1.5.0-SNAPSHOT"
1302                         },
1303                         {
1304                             "name": "nb_api_version",
1305                             "value": "1.2.0"
1306                         },
1307                         {
1308                             "name": "keypair",
1309                             "value": "vlb_key"
1310                         },
1311                         {
1312                             "name": "cloud_env",
1313                             "value": "openstack"
1314                         },
1315                         {
1316                             "name": "nexus_artifact_repo",
1317                             "value": "https://nexus.onap.org"
1318                         },
1319                         {
1320                             "name": "sec_group",
1321                             "value": "default"
1322                         }
1323                     ]
1324                 }
1325             },
1326             "vnf-topology-identifier-structure": {
1327                 "vnf-name": "vLoadBalancer-Vnf-0211-1",
1328                 "vnf-type": "vLoadBalancer/vLoadBalancer 0"
1329             },
1330             "vnf-resource-assignments": {
1331                 "availability-zones": {
1332                     "availability-zone": [
1333                         "nova"
1334                     ],
1335                     "max-count": 1
1336                 },
1337                 "vnf-networks": {
1338                     "vnf-network": []
1339                 }
1340             }
1341         },
1342         "request-information": {
1343             "request-id": "robot12",
1344             "order-version": "1",
1345             "notification-url": "openecomp.org",
1346             "order-number": "1",
1347             "request-action": "PreloadVfModuleRequest"
1348         },
1349         "sdnc-request-header": {
1350             "svc-request-id": "robot12",
1351             "svc-notification-url": "http://openecomp.org:8080/adapters/rest/SDNCNotify",
1352             "svc-action": "reserve"
1353         }
1354     }
1355  }'
1356
1357
1358 Module-3 Preload
1359 ~~~~~~~~~~~~~~~~
1360
1361 ::
1362
1363     curl -X POST \
1364   http://<Any_K8S_Node_IP_Address>:30202/restconf/operations/GENERIC-RESOURCE-API:preload-vf-module-topology-operation \
1365   -H 'Content-Type: application/json' \
1366   -H 'Postman-Token: fd0a4706-f955-490a-875e-08ddd8fe002e' \
1367   -H 'cache-control: no-cache' \
1368   -d '{
1369     "input": {
1370         "preload-vf-module-topology-information": {
1371             "vf-module-topology": {
1372                 "vf-module-topology-identifier": {
1373                     "vf-module-name": "vDNS-0125-1"
1374                 },
1375                 "vf-module-parameters": {
1376                     "param": [
1377                         {
1378                             "name": "vdns_image_name",
1379                             "value": "ubuntu-16-04-cloud-amd64"
1380                         },
1381                         {
1382                             "name": "vdns_flavor_name",
1383                             "value": "m1.medium"
1384                         },
1385                         {
1386                             "name": "public_net_id",
1387                             "value": "public"
1388                         },
1389                         {
1390                             "name": "int_private_net_id",
1391                             "value": "vLBMS_zdfw1lb01_private"
1392                         },
1393                         {
1394                             "name": "int_private_subnet_id",
1395                             "value": "vLBMS_zdfw1lb01_private_sub_ms"
1396                         },
1397                         {
1398                             "name": "onap_private_net_id",
1399                             "value": "oam_onap_vnf_test"
1400                         },
1401                         {
1402                             "name": "onap_private_subnet_id",
1403                             "value": "oam_onap_vnf_test"
1404                         },
1405                         {
1406                             "name": "vlb_private_net_cidr",
1407                             "value": "192.168.10.0/24"
1408                         },
1409                         {
1410                             "name": "onap_private_net_cidr",
1411                             "value": "10.0.0.0/16"
1412                         },
1413                         {
1414                             "name": "vlb_int_private_ip_0",
1415                             "value": "192.168.10.111"
1416                         },
1417                         {
1418                             "name": "vlb_onap_private_ip_0",
1419                             "value": "10.0.150.1"
1420                         },
1421                         {
1422                             "name": "vlb_int_pktgen_private_ip_0",
1423                             "value": "192.168.9.111"
1424                         },
1425                         {
1426                             "name": "vdns_int_private_ip_0",
1427                             "value": "192.168.10.212"
1428                         },
1429                         {
1430                             "name": "vdns_onap_private_ip_0",
1431                             "value": "10.0.150.4"
1432                         },
1433                         {
1434                             "name": "vdns_name_0",
1435                             "value": "vdns-0211-1"
1436                         },
1437                         {
1438                             "name": "vnf_id",
1439                             "value": "vLoadBalancerMS"
1440                         },
1441                         {
1442                             "name": "vf_module_id",
1443                             "value": "vLoadBalancerMS"
1444                         },
1445                         {
1446                             "name": "vnf_name",
1447                             "value": "vLBMS"
1448                         },
1449                         {
1450                             "name": "install_script_version",
1451                             "value": "1.5.0-SNAPSHOT"
1452                         },
1453                         {
1454                             "name": "nb_api_version",
1455                             "value": "1.2.0"
1456                         },
1457                         {
1458                             "name": "keypair",
1459                             "value": "vlb_key"
1460                         },
1461                         {
1462                             "name": "cloud_env",
1463                             "value": "openstack"
1464                         },
1465                         {
1466                             "name": "sec_group",
1467                             "value": "default"
1468                         },
1469                         {
1470                             "name": "nexus_artifact_repo",
1471                             "value": "https://nexus.onap.org"
1472                         }
1473                     ]
1474                 }
1475             },
1476             "vnf-topology-identifier-structure": {
1477                 "vnf-name": "vLoadBalancer-Vnf-0125-1",
1478                 "vnf-type": "vLoadBalancer/vLoadBalancer 0"
1479             },
1480             "vnf-resource-assignments": {
1481                 "availability-zones": {
1482                     "availability-zone": [
1483                         "nova"
1484                     ],
1485                     "max-count": 1
1486                 },
1487                 "vnf-networks": {
1488                     "vnf-network": []
1489                 }
1490             }
1491         },
1492         "request-information": {
1493             "request-id": "robot12",
1494             "order-version": "1",
1495             "notification-url": "openecomp.org",
1496             "order-number": "1",
1497             "request-action": "PreloadVfModuleRequest"
1498         },
1499         "sdnc-request-header": {
1500             "svc-request-id": "robot12",
1501             "svc-notification-url": "http://openecomp.org:8080/adapters/rest/SDNCNotify",
1502             "svc-action": "reserve"
1503         }
1504     }
1505  }'
1506
1507 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.
1508
1509 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.
1510
1511 6) **Post Instantiation Actions**: Please refer to Sections 3-1 for vLB configuration and Section 3-2 for resource orchestration with heatbridge.
1512
1513 7) **Triggering Scale Out Manually**: Please refer to Section 4 to trigger scale out manually with direct API call to SO.
1514
1515
1516 PART 6 - Test Status and Plans
1517 ------------------------------
1518 Dublin Scale Out test cases can be found here: https://wiki.onap.org/pages/viewpage.action?pageId=59966105
1519
1520
1521 PART 7 - Known Issues and Resolutions
1522 -------------------------------------
1523 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
1524
1525 Resolution: Change TCA configuration for the old vLB/vDNS use case
1526
1527 - Connect to Consul: http://<ANY K8S VM IP ADDRESS>:30270 and click on "Key/Value" → "dcae-tca-analytics"
1528 - Change "eventName" in the vLB default policy to something different, for example "vLB" instead of the default value "vLoadBalancer"
1529 - Change "subscriberConsumerGroup" in the TCA configuration to something different, for example "OpenDCAE-c13" instead of the default value "OpenDCAE-c12"
1530 - Click "UPDATE" to upload the new TCA configuration