README.md

   1 Content
   2 ---
   3
   4 The Demo repository contains the HEAT templates and scripts for the instantiation of the ONAP platform and use cases. The repository includes:
   5
   6  - README.md: this file.
   7
   8  - LICENSE.TXT: the license text.
   9
  10  - pom.xml: POM file used to build the software hosted in this repository.
  11
  12  - version.properties: current version number of the Demo repository. Format: MAJOR.MINOR.PATCH (e.g. 1.1.0)
  13
  14  - The "boot" directory contains the scripts that install and configure ONAP:
  15     - install.sh: sets up the host VM for specific components. This script runs only once, soon after the VM is created.
  16     - vm\_init.sh: contains component-specific configuration, downloads and runs docker containers. For some components, this script may either call a component-specific script (cloned from Gerrit repository) or call docker-compose.
  17     - serv.sh: it is installed in /etc/init.d, calls vm\_init.sh at each VM (re)boot.
  18     - configuration files for the Bind DNS Server installed with ONAP. Currently, both simpledemo.openecomp.org and simpledemo.onap.org domains are supported.
  19     - sdc\_ext\_volume_partitions.txt: file that contains external volume partitions for SDC.
  20
  21  - The "docker\_update\_scripts" directory contains scripts that update all the docker containers of an ONAP instance.
  22
  23  - The "heat" directory contains the following sub-directories:
  24
  25         - ONAP: contains the HEAT files for the installation of the ONAP platform. NOTE: onap\_openstack.yaml AND onap\_openstack.env ARE THE HEAT TEMPLATE AND ENVIRONMENT FILE CURRENTLY SUPPORTED. onap\_openstack\_float.yaml, onap\_openstack\_float.env, onap\_openstack\_nofloat.yaml, onap\_openstack\_nofloat.env AND onap\_rackspace.yaml, onap\_rackspace.env AREN'T UPDATED AND THEIR USAGE IS DEPRECATED.
  26
  27         - vCPE: contains sub-directories with HEAT templates for the installation of vCPE Infrastructure (Radius Server, DHCP, DNS, Web Server), vBNG, vBRG Emulator, vGMUX, and vGW.
  28
  29         - vFW: contains the HEAT template for the instantiation of the vFirewall VNF (base\_vfw.yaml) and the environment file (base\_vfw.env) For Amsterdam release, this template is used for testing and demonstrating VNF instantiation only (no closed-loop).
  30
  31         - vFWCL: contains two sub-directories, one that hosts the HEAT template for the vFirewall and vSink (vFWSNK/base\_vfw.yaml), and one that hosts the HEAT template for the vPacketGenerator (vPKG/base\_vpkg.yaml). For Amsterdam release, these templates are used for testing and demonstrating VNF instantiation and closed-loop.
  32
  33         - vLB: contains the HEAT template for the instantiation of the vPacketGenerator/vLoadBalancer/vDNS VNF (base\_vlb.yaml) and the environment file (base\_vlb.env). The directory also contains the HEAT template for the DNS scaling-up scenario (dnsscaling.yaml) with its environment file (dnsscaling.env).
  34
  35         - vVG: contains the HEAT template for the instantiation of a volume group (base\_vvg.yaml and base\_vvg.env).
  36
  37  - The "scripts" directory contains the deploy.sh script that uploads software artifacts to the Nexus repository during the build process.
  38
  39  - The "tosca" directory contains an example of the TOSCA model of the vCPE infrastructure.
  40
  41  - The "tutorials" directory contains tutorials for Clearwater\_IMS and for creating a Netconf mount point in APPC. The "VoLTE" sub-directory is currently not used.
  42
  43  - The "vagrant" directory contains the scripts that install ONAP using Vagrant.
  44
  45  - The "vnfs" directory: contains the following directories:
  46
  47         - honeycomb_plugin: Honeycomb plugin that allows ONAP to change VNF configuration via RESTCONF or NETCONF protocols.
  48
  49         - vCPE: contains sub-directories with the scripts that install all the components of the vCPE use case.
  50
  51         - VES: source code of the ONAP Vendor Event Listener (VES) Library. The VES library used here has been cloned from the GitHub repository at https://github.com/att/evel-library on February 1, 2017. (DEPRECATED FOR AMSTERDAM RELEASE)
  52
  53         - VESreporting_vFW: VES client for vFirewall demo application. (DEPRECATED FOR AMSTERDAM RELEASE)
  54
  55         - VESreporting_vLB: VES client for vLoadBalancer/vDNS demo application. (DEPRECATED FOR AMSTERDAM RELEASE)
  56
  57         - VES5.0: source code of the ONAP Vendor Event Listener (VES) Library, version 5.0. (SUPPORTED FOR AMSTERDAM RELEASE)
  58
  59         - VESreporting_vFW5.0: VES v5.0 client for vFirewall demo application. (SUPPORTED FOR AMSTERDAM RELEASE)
  60
  61         - VESreporting_vLB5.0: VES v5.0 client for vLoadBalancer/vDNS demo application. (SUPPORTED FOR AMSTERDAM RELEASE)
  62
  63         - vFW: scripts that download, install and run packages for the vFirewall use case.
  64
  65         - vLB: scripts that download, install and run packages for the vLoadBalancer/vDNS use case.
  66
  67
  68 ONAP Installation in OpenStack Clouds via HEAT Template
  69 ---
  70
  71 The ONAP HEAT template spins up the entire ONAP platform in OpenStack-based clouds. The template, onap\_openstack.yaml, comes with an environment file, onap\_openstack.env, in which all the default values are defined.
  72
  73 NOTE: onap\_openstack.yaml AND onap\_openstack.env ARE THE HEAT TEMPLATE AND ENVIRONMENT FILE CURRENTLY SUPPORTED. onap\_openstack\_float.yaml, onap\_openstack\_float.env, onap\_openstack\_nofloat.yaml, onap\_openstack\_nofloat.env AND onap\_rackspace.yaml, onap\_rackspace.env AREN'T UPDATED AND THEIR USAGE IS DEPRECATED. As such, the following description refers to onap\_openstack.yaml and onap\_openstack.env.
  74
  75 The HEAT template is composed of two sections: (i) parameters, and (ii) resources.
  76
  77  - The "parameters" section contains the declarations and descriptions of the parameters that will be used to spin up ONAP, such as public network identifier, URLs of code and artifacts repositories, etc. The default values of these parameters can be found in the environment file.
  78
  79  - The "resources" section contains the definitions of:
  80    - ONAP Private Management Network, which is used by ONAP components to communicate with each other and with VNFs
  81    - ONAP Virtual Machines (VMs)
  82    - Public/private key pair used to access ONAP VMs
  83    - Virtual interfaces towards the ONAP Private Management Network
  84    - Disk volumes.
  85
  86 Each VM specification includes Operating System image name, VM size (i.e. flavor), VM name, etc. Each VM has a virtual network interface with a private IP address in the ONAP Private Management network and a floating IP that OpenStack assigns based on availability.
  87 Furthermore, each VM runs an install.sh script that downloads and installs software dependencies (e.g. Java JDK, gcc, make, Python, ...). install.sh finally calls vm_init.sh that downloads docker containers from remote repositories and runs them.
  88
  89 When the HEAT template is executed, the OpenStack HEAT engine creates the resources defined in the HEAT template, based on the parameter values defined in the environment file.
  90
  91 Before running HEAT, it is necessary to customize the environment file. Indeed, some parameters, namely public\_net\_id, pub\_key, openstack\_tenant\_id, openstack\_username, and openstack\_api\_key, need to be set depending on the user's environment:
  92
  93         public_net_id:       PUT YOUR NETWORK ID/NAME HERE
  94         pub_key:             PUT YOUR PUBLIC KEY HERE
  95         openstack_tenant_id: PUT YOUR OPENSTACK PROJECT ID HERE
  96         openstack_username:  PUT YOUR OPENSTACK USERNAME HERE
  97         openstack_api_key:   PUT YOUR OPENSTACK PASSWORD HERE
  98         horizon_url:         PUT THE HORIZON URL HERE
  99         keystone_url:        PUT THE KEYSTONE URL HERE (do not include version number)
 100
 101
 102 openstack\_region parameter is set to RegionOne (OpenStack default). If your OpenStack is using another Region, please modify this parameter.
 103
 104 public\_net\_id is the unique identifier (UUID) or name of the public network of the cloud provider. To get the public\_net\_id, use the following OpenStack CLI command (ext is the name of the external network, change it with the name of the external network of your installation)
 105
 106         openstack network list | grep ext | awk '{print $2}'
 107
 108 pub\_key is the string value of the public key that will be installed in each ONAP VM. To create a public/private key pair in Linux, please execute the following instruction:
 109
 110         user@ubuntu:~$ ssh-keygen -t rsa
 111
 112 The following operations to create the public/private key pair occur:
 113
 114         Generating public/private rsa key pair.
 115         Enter file in which to save the key (/home/user/.ssh/id_rsa):
 116         Created directory '/home/user/.ssh'.
 117         Enter passphrase (empty for no passphrase):
 118         Enter same passphrase again:
 119         Your identification has been saved in /home/user/.ssh/id_rsa.
 120         Your public key has been saved in /home/user/.ssh/id_rsa.pub.
 121
 122 openstack\_username, openstack\_tenant\_id (password), and openstack\_api\_key are the user's credentials to access the OpenStack-based cloud.
 123
 124 Some global parameters used for all components are also required:
 125
 126         ubuntu_1404_image: PUT THE UBUNTU 14.04 IMAGE NAME HERE
 127         ubuntu_1604_image: PUT THE UBUNTU 16.04 IMAGE NAME HERE
 128         flavor_small: PUT THE SMALL FLAVOR NAME HERE
 129         flavor_medium: PUT THE MEDIUM FLAVOR NAME HERE
 130         flavor_large: PUT THE LARGE FLAVOR NAME HERE
 131         flavor_xlarge: PUT THE XLARGE FLAVOR NAME HERE
 132         flavor_xxlarge: PUT THE XXLARGE FLAVOR NAME HERE
 133
 134 To get the images in your OpenStack environment, use the following OpenStack CLI command:
 135
 136         openstack image list | grep 'ubuntu'
 137
 138 To get the flavor names used in your OpenStack environment, use the following OpenStack CLI command:
 139
 140         openstack flavor list
 141
 142 Some network parameters must be configured:
 143
 144         dns_list: PUT THE ADDRESS OF THE EXTERNAL DNS HERE (e.g. a comma-separated list of IP addresses in your /etc/resolv.conf in UNIX-based Operating Systems).
 145         external_dns: PUT THE FIRST ADDRESS OF THE EXTERNAL DNS LIST HERE (THIS WILL BE DEPRECATED SOON)
 146         dns_forwarder: PUT THE IP OF DNS FORWARDER FOR ONAP DEPLOYMENT'S OWN DNS SERVER
 147         oam_network_cidr: 10.0.0.0/16
 148
 149 ONAP installs a DNS server used to resolve IP addresses in the ONAP OAM private network. ONAP Amsterdam Release also requires OpenStack Designate DNS support for the DCAE platform, so as to allow IP address discovery and communication among DCAE elements. This is required because the ONAP HEAT template only installs the DCAE bootstrap container, which will in turn install the entire DCAE platform. As such, at installation time, the IP addresses of the DCAE components are unknown. The DNS server that ONAP installs needs to be connected to the Designate DNS to allow communication between the DCAE elements and the other ONAP components. To this end, dns\_list, external\_dns, and dns\_forwarder should all have the IP address of the Designate DNS. These three parameters are redundant, but still required for Amsterdam Release. Originally, dns\_list and external\_dns were both used to circumvent some limitations of older OpenStack versions. In future releases, the DNS settings and parameters in HEAT will be consolidated. The Designate DNS is configured to access the external DNS. As such, the ONAP DNS will forward to the Designate DNS the queries from ONAP components to the external world. The Designate DNS will then forward those queries to the external DNS.
 150
 151 DCAE spins up ONAP's data collection and analytics system in two phases.  The first is the launching of a bootstrap VM that is specified in the ONAP Heat template, as described above.  This VM requires a number of deployment-specific configuration parameters being provided so that it can subsequently bring up the DCAE system.  There are two groups of parameters.  The first group relates to the launching of DCAE VMs, including parameters such as the keystone URL and additional VM image IDs/names.  Hence these parameters need to be provided to DCAE.  Note that although DCAE VMs will be launched in the same tenant as the rest of ONAP, because DCAE may use MultiCloud node as the agent for interfacing with the underlying cloud, it needs a separate keystone URL (which points to MultiCloud node instead of the underlying cloud).  The second group of configuration parameters relate to DNS As A Service support (DNSaaS).  DCAE requires DNSaaS for registering its VMs into organization-wide DNS service.  For OpenStack, DNSaaS is provided by Designate, as mentioned above.  Designate support can be provided via an integrated service endpoint listed under the service catalog of the OpenStack installation; or proxyed by the ONAP MultiCloud service.  For the latter case, a number of parameters are needed to configure MultiCloud to use the correct Designate service.  These parameters are described below:
 152
 153         dcae_keystone_url: PUT THE MULTIVIM PROVIDED KEYSTONE API URL HERE
 154         dcae_centos_7_image: PUT THE CENTOS7 VM IMAGE NAME HERE FOR DCAE LAUNCHED CENTOS7 VM
 155         dcae_domain: PUT THE NAME OF DOMAIN THAT DCAE VMS REGISTER UNDER
 156         dcae_public_key: PUT THE PUBLIC KEY OF A KEYPAIR HERE TO BE USED BETWEEN DCAE LAUNCHED VMS
 157         dcae_private_key: PUT THE SECRET KEY OF A KEYPAIR HERE TO BE USED BETWEEN DCAE LAUNCHED VMS
 158
 159         dnsaas_config_enabled: PUT WHETHER TO USE PROXYED DESIGNATE
 160         dnsaas_region: PUT THE DESIGNATE PROVIDING OPENSTACK'S REGION HERE
 161         dnsaas_keystone_url: PUT THE DESIGNATE PROVIDING OPENSTACK'S KEYSTONE URL HERE
 162         dnsaas_tenant_name: PUT THE TENANT NAME IN THE DESIGNATE PROVIDING OPENSTACK HERE (FOR R1 USE THE SAME AS openstack_tenant_name)
 163         dnsaas_username: PUT THE DESIGNATE PROVIDING OPENSTACK'S USERNAME HERE
 164         dnsaas_password: PUT THE DESIGNATE PROVIDING OPENSTACK'S PASSWORD HERE
 165
 166
 167 The ONAP platform can be instantiated via Horizon (OpenStack dashboard) or Command Line.
 168
 169 Instantiation via Horizon:
 170
 171  - Login to Horizon URL with your personal credentials
 172  - Click "Stacks" from the "Orchestration" menu
 173  - Click "Launch Stack"
 174  - Paste or manually upload the HEAT template file (onap\_openstack.yaml) in the "Template Source" form
 175  - Paste or manually upload the HEAT environment file (onap\_openstack.env) in the "Environment Source" form
 176  - Click "Next"
 177  - Specify a name in the "Stack Name" form
 178  - Provide the password in the "Password" form
 179  - Click "Launch"
 180
 181 Instantiation via Command Line:
 182
 183  - Install the HEAT client on your machine, e.g. in Ubuntu (ref. http://docs.openstack.org/user-guide/common/cli-install-openstack-command-line-clients.html):
 184
 185         apt-get install python-dev python-pip
 186         pip install python-heatclient        # Install heat client
 187         pip install python-openstackclient   # Install the Openstack client to support multiple services
 188
 189  - Create a file (named i.e. ~/openstack/openrc) that sets all the environmental variables required to access the OpenStack platform:
 190
 191         export OS_AUTH_URL=INSERT THE AUTH URL HERE
 192         export OS_USERNAME=INSERT YOUR USERNAME HERE
 193         export OS_TENANT_ID=INSERT YOUR TENANT ID HERE
 194         export OS_REGION_NAME=INSERT THE REGION HERE
 195         export OS_PASSWORD=INSERT YOUR PASSWORD HERE
 196
 197    Alternatively, you can download the OpenStack RC file from the dashboard: Compute -> Access & Security -> API Access -> Download RC File
 198
 199  - Source the script or RC file from command line:
 200
 201         source ~/openstack/openrc
 202
 203  - In order to install the ONAP platform, type:
 204
 205         openstack stack create -t PATH_TO_HEAT_TEMPLATE(YAML FILE) -e PATH_TO_ENV_FILE STACK_NAME  # New Openstack client, OR
 206         heat stack-create STACK_NAME -f PATH_TO_HEAT_TEMPLATE(YAML FILE) -e PATH_TO_ENV_FILE       # Old HEAT client
 207
 208
 209 vFirewall Use Case
 210 ---
 211
 212 The use case is composed of three virtual functions (VFs): packet generator, firewall, and traffic sink. These VFs run in three separate VMs. The packet generator sends packets to the packet sink through the firewall. The firewall reports the volume of traffic passing though to the ONAP DCAE collector. To check the traffic volume that lands at the sink VM, you can access the link http://sink\_ip\_address:667 through your browser and enable automatic page refresh by clicking the "Off" button. You can see the traffic volume in the charts.
 213
 214 The packet generator includes a script that periodically generates different volumes of traffic. The closed-loop policy has been configured to re-adjust the traffic volume when high-water or low-water marks are crossed.
 215
 216 __Closed-Loop for vFirewall demo:__
 217
 218 Through the ONAP Portal's Policy Portal, we can find the configuration and operation policies that are currently enabled for the vFirewall use case.
 219
 220 - The configuration policy sets the thresholds for generating an onset event from DCAE to the Policy engine. Currently, the high-water mark is set to 700 packets while the low-water mark is set to 300 packets. The measurement interval is set to 10 seconds.
 221 - When a threshold is crossed (i.e. the number of received packets is below 300 packets or above 700 packets per 10 seconds), the Policy engine executes the operational policy to request APPC to adjust the traffic volume to 500 packets per 10 seconds.
 222 - APPC sends a request to the packet generator to adjust the traffic volume.
 223 - Changes to the traffic volume can be observed through the link http://sink\_ip\_address:667.
 224
 225 __Adjust packet generator:__
 226
 227 The packet generator contains 10 streams: fw\_udp1, fw\_udp2, fw\_udp3, . . . , fw\_udp10. Each stream generates 100 packets per 10 seconds. A script in /opt/run\_traffic\_fw\_demo.sh on the packet generator VM starts automatically and alternates high traffic (i.e. 10 active streams at the same time) and low traffic (1 active stream) every 5 minutes.
 228
 229 To enable a stream, include *{"id":"fw_udp1", "is-enabled":"true"}* in the *pg-stream* bracket.
 230
 231 To adjust the traffic volume produced by the packet generator, run the following command in a shell, replacing PacketGen_IP in the HTTP argument with localhost (if you run it in the packet generator VM) or the packet generator IP address:
 232
 233
 234     curl -X PUT -H "Authorization: Basic YWRtaW46YWRtaW4=" -H "Content-Type: application/json" -H "Cache-Control: no-cache" -d '{"pg-streams":{"pg-stream": [{"id":"fw_udp1", "is-enabled":"true"},{"id":"fw_udp2", "is-enabled":"true"},{"id":"fw_udp3", "is-enabled":"true"},{"id":"fw_udp4", "is-enabled":"true"},{"id":"fw_udp5", "is-enabled":"true"}]}}' "http://PacketGen_IP:8183/restconf/config/sample-plugin:sample-plugin/pg-streams"
 235
 236 The command above enables 5 streams.
 237
 238
 239 vLoadBalancer/vDNS Use Case
 240 ---
 241
 242 The use case is composed of three VFs: packet generator, load balancer, and DNS server. These VFs run in three separate VMs. The packet generator issues DNS lookup queries that reach the DNS server via the load balancer. DNS replies reach the packet generator via the load balancer as well. The load balancer reports the average amount of traffic per DNS over a time interval to the DCAE collector. When the average amount of traffic per DNS server crosses a predefined threshold, the closed-loop is triggered and a new DNS server is instantiated.
 243
 244 To test the application, you can run a DNS query from the packet generator VM:
 245
 246     dig @vLoadBalancer_IP host1.dnsdemo.onap.org
 247
 248 The output below means that the load balancer has been set up correctly, has forwarded the DNS queries to one DNS instance, and the packet generator has received the DNS reply message.
 249
 250     ; <<>> DiG 9.10.3-P4-Ubuntu <<>> @192.168.9.111 host1.dnsdemo.onap.org
 251     ; (1 server found)
 252     ;; global options: +cmd
 253     ;; Got answer:
 254     ;; ->>HEADER<<- opcode: QUERY, status: NOERROR, id: 31892
 255     ;; flags: qr aa rd; QUERY: 1, ANSWER: 1, AUTHORITY: 1, ADDITIONAL: 2
 256     ;; WARNING: recursion requested but not available
 257
 258     ;; OPT PSEUDOSECTION:
 259     ; EDNS: version: 0, flags:; udp: 4096
 260     ;; QUESTION SECTION:
 261     ;host1.dnsdemo.onap.org.            IN      A
 262
 263     ;; ANSWER SECTION:
 264     host1.dnsdemo.onap.org.     604800  IN      A       10.0.100.101
 265
 266     ;; AUTHORITY SECTION:
 267     dnsdemo.onap.org.   604800  IN      NS      dnsdemo.onap.org.
 268
 269     ;; ADDITIONAL SECTION:
 270     dnsdemo.onap.org.   604800  IN      A       10.0.100.100
 271
 272     ;; Query time: 0 msec
 273     ;; SERVER: 192.168.9.111#53(192.168.9.111)
 274     ;; WHEN: Fri Nov 10 17:39:12 UTC 2017
 275     ;; MSG SIZE  rcvd: 97
 276
 277
 278 __Closedloop for vLoadBalancer/vDNS:__
 279
 280 Through the Policy Portal (accessible via the ONAP Portal), we can find the configuration and operation policies that are currently enabled for the vLoadBalancer/vDNS application.
 281 + The configuration policy sets the thresholds for generating an onset event from DCAE to the Policy engine. Currently, the threshold is set to 200 packets, while the measurement interval is set to 10 seconds.
 282 + Once the threshold is crossed (e.g. the number of received packets is above 200 packets per 10 seconds), the Policy engine executes the operational policy. The Policy engine queries A&AI to fetch the VNF UUID and sends a request to SO to spin up a new DNS instance for the VNF identified by that UUID.
 283 + SO spins up a new DNS instance.
 284
 285
 286 To change the volume of queries generated by the packet generator, run the following command in a shell, replacing PacketGen_IP in the HTTP argument with localhost (if you run it in the packet generator VM) or the packet generator IP address:
 287
 288     curl -X PUT -H "Authorization: Basic YWRtaW46YWRtaW4=" -H "Content-Type: application/json" -H "Cache-Control: no-cache" -d '{"pg-streams":{"pg-stream": [{"id":"dns1", "is-enabled":"true"}]}}' "http://PacketGen_IP:8183/restconf/config/sample-plugin:sample-plugin/pg-streams"
 289
 290 + *{"id":"dns1", "is-enabled":"true"}* shows the stream *dns1* is enabled. The packet generator sends requests in the rate of 100 packets per 10 seconds.
 291
 292 + To increase the amount of traffic, you can enable more streams. The packet generator has 10 streams, *dns1*, *dns2*, *dns3* to *dns10*. Each of them generates 100 packets per 10 seconds. To enable the streams, please add *{"id":"dnsX", "is-enabled":"true"}* to the pg-stream bracket of the curl command, where *X* is the stream ID.
 293
 294 For example, if you want to enable 3 streams, the curl command will be:
 295
 296     curl -X PUT -H "Authorization: Basic YWRtaW46YWRtaW4=" -H "Content-Type: application/json" -H "Cache-Control: no-cache" -d '{"pg-streams":{"pg-stream": [{"id":"dns1", "is-enabled":"true"}, {"id":"dns2", "is-enabled":"true"},{"id":"dns3", "is-enabled":"true"}]}}' "http://PacketGen_IP:8183/restconf/config/sample-plugin:sample-plugin/pg-streams"
 297
 298 When the VNF starts, the packet generator is automatically configured to run 5 streams.
 299
 300 vVolumeGroup Use Case
 301 ---
 302
 303 The vVG directory contains the HEAT template (base\_vvg.yaml) and environment file (base\_vvg.env) used to spin up a volume group in OpenStack and attach it to an existing ONAP instance.
 304
 305 The HEAT environment file contains two parameters:
 306
 307     volume_size: 100
 308     nova_instance: 1234456
 309
 310 volume\_size is the size (in gigabytes) of the volume group. nova\_instance is the name or UUID of the VM to which the volume group will be attached. This parameter should be changed appropriately.
 311
 312
 313 ONAP Use Cases HEAT Templates
 314 ---
 315
 316 USE CASE VNFs SHOULD BE INSTANTIATED VIA ONAP. THE USER IS NOT SUPPOSED TO DOWNLOAD THE HEAT TEMPLATES AND RUN THEM MANUALLY.
 317
 318 The vFWCL directory contains two HEAT templates, one for creating a packet generator (vPKG/base\_vpkg.yaml) and one for creating a firewall and a packet sink (vFWSNK/base\_vfw.yaml). This use case supports VNF onboarding, instantiation, and closed-loop. The vFW directory, instead, contains a single HEAT template (base\_vfw) that spins up the three VFs. This use case supports VNF onboarding and instantiation only (no support for closed-loop). For Amsterdam Release, the HEAT templates in vFWCL are recommended, so that users can test and demonstrate the entire ONAP end-to-end flow.
 319
 320 The vLB directory contains a base HEAT template (base\_vlb.yaml) that install a packet generator, a load balancer, and a DNS instance, plus another HEAT template (dnsscaling.yaml) for the DNS scaling scenario, in which another DNS server is instantiated.
 321
 322 Before onboarding the VNFs in SDC, the user should set the following values in the HEAT environment files:
 323
 324     image_name: PUT THE VM IMAGE NAME HERE
 325     flavor_name: PUT THE VM FLAVOR NAME HERE
 326     public_net_id: PUT THE PUBLIC NETWORK ID HERE
 327     dcae_collector_ip: PUT THE ADDRESS OF THE DCAE COLLECTOR HERE (NOTE: this is not required for vFWCL/vPKG/base\_vpkg.env)
 328     pub_key: PUT YOUR KEY HERE
 329     cloud_env: PUT openstack OR rackspace HERE
 330
 331 image\_name, flavor\_name, \public\_net\_id, and pub\_key can be obtained as described in the ONAP Section. For deployment in OpenStack, cloud\_env must be openstack.
 332
 333 The DNS scaling HEAT environment file for the vLoadBalancer use case also requires you to specify the private IP of the load balancer, so that the DNS can connect to the vLB:
 334
 335     vlb_private_ip_1: PUT THE PRIVATE ADDRESS OF THE VLB IN THE ONAP NETWORK SPACE HERE
 336
 337 As an alternative, it is possible to set the HEAT environment variables after the VNF is onboarded via SDC by appropriately preloading data into SDNC. That data will be fetched and used by SO to overwrite the default parameters in the HEAT environment file before the VNF is instantiated. For further information about SDNC data preload, please visit the wiki page: https://wiki.onap.org/display/DW/Tutorial_vIMS+%3A+SDNC+Updates
 338
 339 Each VNF has a MANIFEST.json file associated with the HEAT templates. During VNF onboarding, SDC reads the MANIFEST.json file to understand the role of each HEAT template that is part of the VNF (e.g. base template vs. non-base template). VNF onboarding requires users to create a zip file that contains all the HEAT templates and the MANIFEST file. To create the zip file, you can run the following command from shell:
 340
 341     cd VNF_FOLDER  (this is the folder that contains the HEAT templates and the MANIFEST file)
 342     zip ZIP_FILE_NAME.zip *
 343
 344 For information about VNF onboarding via the SDC portal, please refer to the wiki page: https://wiki.onap.org/display/DW/Design