4 This repository contains all the HEAT templates for the instantiation of the ONAP platform, and the vFirewall and vLoadBalancer/vDNS demo applications.
6 The repository includes:
9 - LICENSE.TXT: the license text
11 - The "boot" directory: the scripts that instantiate ONAP.
13 - The "heat" directory: contains the following three directories:
15 - OpenECOMP: contains the HEAT template for the installation of the ONAP platform. The template openecomp_rackspace.yaml and the environment file openecomp_rackspace.env work in Rackspace, while the template onap_openstack.yaml and the environment file onap_openstack.env work in vanilla OpenStack.
17 - vFW: contains the HEAT template for the instantiation of the vFirewall VNF (base_vfw.yaml) and the environment file (base_vfw.env)
19 - vLB: contains the HEAT template for the instantiation of the vLoadBalancer/vDNS VNF (base_vlb.yaml) and the environment file (base_vlb.env). The folder also contains the HEAT template for the DNS scaling-up scenario (dnsscaling.yaml) with its environment file (dnsscaling.env), and the HEAT template for the vLB packet generator (packet_gen_vlb.yaml) and its environment file (packet_gen_vlb.env).
21 - The "vnfs" directory: contains the following directories:
23 - honeycomb_plugin: Honeycomb plugin that allows ONAP to change VNF configuration via RESTCONF or NETCONF protocols.
25 - VES: source code of the ECOMP 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.
27 - VESreporting_vFW: VES client for vFirewall demo application.
29 - VESreporting_vLB: VES client for vLoadBalancer/vDNS demo application.
31 - vFW: scripts that download, install and run packages for the vFirewall demo application.
33 - vLB: scripts that download, install and run packages for the vLoadBalancer/vDNS demo application.
36 ONAP HEAT Template for Rackspace
39 The ONAP HEAT template spins up the entire ONAP platform. The template, openecomp_rackspace.yaml, comes with an environment file, openecomp_rackspace.env, in which all the default values are defined.
41 The HEAT template is composed of two sections: (i) parameters, and (ii) resources. The parameter section contains the declaration and description of the parameters that will be used to spin up ONAP, such as public network identifier, URLs of code and artifacts repositories, etc.
42 The default values of these parameters can be found in the environment file. The resource section contains the definition of:
43 - ONAP Private Management Network, which ONAP components use to communicate with each other and with VNFs
44 - ONAP Virtual Machines (VMs)
45 - Public/private key pair used to access ONAP VMs
46 - Virtual interfaces towards the ONAP Private Management Network
49 Each VM specification includes Operating System image name, VM size (i.e. flavor), VM name, etc. Each VM has two virtual network interfaces: one towards the public network and one towards the ONAP Private Management network, as described above.
50 Furthermore, each VM runs a post-instantiation script that downloads and installs software dependencies (e.g. Java JDK, gcc, make, Python, ...) and ONAP software packages and docker containers from remote repositories.
52 When the HEAT template is executed, the Openstack HEAT engine creates the resources defined in the HEAT template, based on the parameters values defined in the environment file.
54 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:
56 public_net_id: INSERT YOUR NETWORK ID/NAME HERE
57 pub_key: INSERT YOUR PUBLIC KEY HERE
58 openstack_tenant_id: INSERT YOUR TENANT ID HERE
59 openstack_username: INSERT YOUR USERNAME HERE
60 openstack_api_key: INSERT YOUR API KEY HERE
62 public_net_id is the unique identifier (UUID) or name of the public network of the cloud provider. Note that for Rackspace template, this value is already set to
64 00000000-0000-0000-0000-000000000000
67 pub_key is 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:
69 user@ubuntu:~$ ssh-keygen -t rsa
71 The following operations to create the public/private key pair occur:
73 Generating public/private rsa key pair.
74 Enter file in which to save the key (/home/user/.ssh/id_rsa):
75 Created directory '/home/user/.ssh'.
76 Enter passphrase (empty for no passphrase):
77 Enter same passphrase again:
78 Your identification has been saved in /home/user/.ssh/id_rsa.
79 Your public key has been saved in /home/user/.ssh/id_rsa.pub.
81 openstack_username, openstack_tenant_id (password), and openstack_api_key are user's credentials to access the Openstack-based cloud. Note that in the Rackspace web interface, openstack_api_key can be found by clicking on the username on the top-right corner of the GUI and then "Account Settings".
83 DCAE spins up the data collection and analytics environment outside the HEAT template. This environment is composed of: 3-VM CDAP/Hadoop cluster, 1 VM for the DCAE data collector, and 1 VM for Postgres DB. DCAE needs to know where (i.e. Rackspace region) it has to spin up these VMs. Three parameters have to be setup to reflect the Rackspace region, namely dcae_zone, dcae_state and openstack_region. dcae_zone and dcae_state are used to compose the name of the VMs, so any meaningful name can be used. openstack_region, instead, represents the actual location, so Rackspace-specific values must be used: IAD, DFW, HKG, SYD. The example below shows a snippet of the HEAT environment file that instantiate ONAP in IAD region in Rackspace:
89 The ONAP platform can be instantiated via Rackspace GUI or command line.
91 Instantiation via Rackspace GUI:
92 - Login to Rackspace with your personal credentials
93 - Click "Stack Templates" from the "Orchestration" menu
94 - Click "Create Custom Template"
95 - Paste or manually upload the HEAT template (openecomp.yaml)
96 - Specify a name for your template in the "Template Name" form
97 - Click "Create Template and Launch Stack" at the bottom of the page
98 - In the "Create Stack" page, specify a name for your stack in the "Stack Name" form and select the Rackspace Region
99 - In the "Advanced Option" menu, insert the values of the parameters specified in the environment file (openecomp.env)
100 - Click "Create Stack"
103 Instantiation via Command Line:
104 - 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):
106 apt-get install python-dev python-pip
107 pip install python-heatclient # Install heat client
108 pip install python-openstackclient # Install the Openstack client to support multiple services
110 - Create a file (named i.e. ~/rackspace/openrc) that sets all the environmental variables required to access Rackspace:
112 export OS_AUTH_URL=https://identity.api.rackspacecloud.com/v2.0/
113 export OS_USERNAME=INSERT YOUR USERNAME HERE
114 export OS_TENANT_ID=INSERT YOUR TENANT ID HERE
115 export OS_REGION_NAME=INSERT THE RACKSPACE REGION ID [IAD | DFW | SYD | HKG]
116 export OS_PASSWORD=INSERT YOUR PASSWORD HERE
118 - Run the script from command line:
120 source ~/rackspace/openrc
122 - In order to install the ONAP platform, type:
124 heat stack-create STACK_NAME -f PATH_TO_HEAT_TEMPLATE(YAML FILE) -e PATH_TO_ENV_FILE # Old HEAT client, OR
125 openstack stack create -t PATH_TO_HEAT_TEMPLATE(YAML FILE) -e PATH_TO_ENV_FILE STACK_NAME # New Openstack client
128 ONAP HEAT Template for vanilla OpenStack
131 The HEAT template for vanilla OpenStack is similar to the HEAT template for Rackspace. The main difference is the way resource-intensive VMs are defined. Unlike OpenStack, Rackspace requires to explicitly create a local disk for memory- or CPU-intensive VMs.
133 The HEAT template for vanilla OpenStack replicates typical application deployments in OpenStack. VMs have a private IP address in the ONAP Private Management Network space and use floating IP addresses. A router that connects the ONAP Private Management Network to the external network is also created.
135 In addition to the parameters described in the previous section, the HEAT template for vanilla OpenStack uses the following parameters to define the image name and flavor of a VM:
137 ubuntu_1404_image: PUT THE UBUNTU 14.04 IMAGE NAME HERE
138 ubuntu_1604_image: PUT THE UBUNTU 16.04 IMAGE NAME HERE
139 flavor_small: PUT THE SMALL FLAVOR NAME HERE
140 flavor_medium: PUT THE MEDIUM FLAVOR NAME HERE
141 flavor_large: PUT THE LARGE FLAVOR NAME HERE
142 flavor_xlarge: PUT THE XLARGE FLAVOR NAME HERE
144 Parameters for network configuration are also used:
158 These parameters are used to configure the ONAP internal DNS VM. The external_dns parameter is a comma-separated list of IP addresses (they can be obtained from /etc/resolv.conf in many UNIX-based Operating Systems). The IP address of the ONAP VMs must comply with the oam_network_cidr parameter, and viceversa. Except for external_dns, the other network parameters are already set. They should work for many deployments.
164 The HEAT templates for the demo applications are stored in heat/vFW and heat/vLB directories.
166 vFW contains the HEAT template, base_vfw.yaml, and the environment file, base_vfw.env, that are used to instantiate a virtual firewall. The VNF is composed of three VMs:
171 The packet generator generates traffic that passes through the firewall and reaches the sink. The firewall periodically reports the number of packets received in a unit of time to the DCAE collector. If the reported number of packets received on the firewall is above a high-water mark or below a low-water mark, ONAP will enforce a configuration change on the packet generator, reducing or augmenting the quantity of traffic generated, respectively.
173 vLB contains the HEAT template, base_vlb.yaml, and the environment file, base_vlb.env, that are used to spin up a virtual load balancer and a virtual DNS. vLB also contains the HEAT template, packet_gen_vlb.yaml, and the environment file packet_gen_vlb.env, of a packet generator that generates DNS queries.
174 The load balancer periodically reports the number of DNS query packets received in a time unit to the DCAE collector. If the reported number of received packets crosses a threshold, then ONAP will spin up a new DNS based on the dnsscaling.yaml HEAT template and dnsscaling.env to better balance the load of incoming DNS queries.
176 The vFW and vLB HEAT templates and environment files are onboarded into ONAP SDC and run automatically. The user is not required to run these templates manually.
177 However, before onboarding the templates following the instructions in the ONAP documentation, the user should set the following values in the environment files:
179 public_net_id: INSERT YOUR NETWORK ID/NAME HERE
180 pub_key: INSERT YOUR PUBLIC KEY HERE
183 ONAP Demo applications
186 Demo applications are installed and run automatically when the VNFs are instantiated. The user is not supposed to download and install the demo applications manually.
188 Two demo applications, vFirewall and vLoadBalancer/vDNS are included.
193 The vFirewall application contains 3 VMs: a firewall, a packet generator, and a packet sink.
195 The packet generator sends packets to the packet sink through the firewall. The firewall reports the volume of traffic from the packet generator to the sink to ONAP DCAE’s collector. To check the traffic volume to the sink, you can access the link http://sink_ip_address:667 through your browser. You can see the traffic volume in the charts.
197 The packet generator includes a script that periodically generates different volumes of traffic.
199 The closed-loop policy has been configured to re-adjust the traffic volume when it is needed.
201 __Closedloop for vFirewall demo:__
203 Through the ONAP Portal’s Policy Portal, we can find the configuration and operation policies that is currently enabled for the vFirewall application.
204 + The configuration policy sets the thresholds for generating an onset event from DCAE to the Policy engine. Currently the thresholds are set to 300 packets and 700 packets, while the measurement interval is set to 10 seconds.
205 + Once one of the thresholds is crossed (e.g. the number of received packets is below 300 packets or above 700 per 10 seconds), the Policy engine executes the operational policy to request APP-C to change the configuration of the packet generator.
206 + APP-C sends a request to the packet generator to adjust the traffic volume to 500 packets per 10 seconds.
207 + The traffic volume can be observed through the link http://sink_ip_address:667.
209 __Adjust packet generator:__
211 The packet generator contains 10 streams: fw_udp1, fw_udp2, fw_udp3,...fw_udp10. Each stream generates 100 packets per 10 seconds.
213 To enable a stream, include *{"id":"fw_udp1", "is-enabled":"true"}* in the *pg-stream* bracket.
215 To adjust the traffic volume sending from the packet generator, run the following command that enable 5 streams in a shell with localhost or the correct packet generator IP address in the http argument:
218 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"
221 A script in /opt/run_traffic_fw_demo.sh on the packet generator VM starts automatically and alternate the volume of traffic every 5 minutes.
226 The vLoadBalancer/vDNS app contains 2 VMs in the base model: a load balancer and a DNS instance. When there are too many DNS queries, the closed-loop is triggered and a new DNS instance will be spun up.
228 To test the application, in the command prompt:
231 # nslookup host1.dnsdemo.openecomp.org *vLoadBalancer_IP*
233 Server: *vLoadBalancer_IP*
234 Address: *vLoadBalancer_IP*
236 Name: host1.dnsdemo.openecomp.org
237 Address: 10.0.100.101
241 That means the load balancer has been set up correctly and has forwarded the DNS queries to the DNS instance.
243 __Closedloop for vLoadBalancer/vDNS:__
245 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.
246 + 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.
247 + 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 to query A&AI and send a request to MSO for spinning up a new DNS instance.
248 + A new DNS instance will be then spun up.
251 __Generate DNS queries:__
253 To generate DNS queries to the vLoadBalancer/vDNS instance, a separate packet generator is prepared for this purpose.
255 1. Spin up the heat template in the repository: https://link_to_repo/demo/heat/vLB/packet_gen_vlb.yaml.
257 2. Log in to the packet generator instance through ssh.
259 3. Change the IP address in the config file /opt/config/vlb_ipaddr.txt to the public IP address of the LoadBalancer instance.
261 4. Execute the script /opt/vdnspacketgen_change_streams_ports.sh to restart sending the DNS queries to the new LoadBalancer address.
263 5. To change the volume of queries, execute the following command in a command prompt with the updated vLoadBalancer_IP address or localhost in the http argument:
266 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://vLoadBalancer_IP:8183/restconf/config/sample-plugin:sample-plugin/pg-streams"
268 + *{"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.
270 + To increase the amount of traffic, we 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 insert *{"id":"dnsX", "is-enabled":"true"}* where *X* is the stream ID in the pg-stream bracket of the curl command.
271 For example, if we want to enable 3 streams, the curl command should be:
274 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://vLoadBalancer_IP:8183/restconf/config/sample-plugin:sample-plugin/pg-streams"