Merge pull request #11 from openbaton/develop

Merge develop into master
openbaton · Mar 3, 2017 · d6320a8 · d6320a8
2 parents 5a1e5fc + 61ee599
commit d6320a8
Show file tree

Hide file tree

Showing 57 changed files with 711 additions and 265 deletions.
diff --git a/docs/autoscaling.md b/docs/autoscaling.md
@@ -60,21 +60,21 @@ The latest stable version AutoScaling Engine can be cloned from this [repository
 git clone https://github.com/openbaton/autoscaling.git
 ```
 
-Once this is done, go inside the cloned folder and make use of the provided script to compile the project as done below:
+Once this is done, go inside the cloned folder and make use of the provided script to compile the project and start as done below:
 
 ```bash
-./autoscaling-engine.sh compile
+./autoscaling-engine.sh compile start
 ```
 
 # Manual configuration of the AutoScaling Engine
 
 This chapter describes what needs to be done before starting the AutoScaling Engine. This includes the configuration file and properties, and also how to make use of monitoring plugin.
 
 ## Configuration file
-The configuration file must be copied to `etc/openbaton/autoscaling.properties` by executing the following command from inside the repository folder:
+The configuration file must be copied to `etc/openbaton/openbaton-ase.properties` by executing the following command from inside the repository folder:
 
 ```bash
-cp etc/autoscaling.properties /etc/openbaton/autoscaling.properties
+cp etc/ase.properties /etc/openbaton/autoscaling.properties
 ```
 
 If done, check out the following chapter in order to understand the configuration parameters.
@@ -182,6 +182,7 @@ An example of an AutoScalePolicy can be found below followed by descriptions for
   }
 ]
 ```
+An example using the **TOSCA YAML descriptors** can be found [here][tosca-as].
 
 This AutoScalePolicy indicates an scaling-out operation of two new VNFC Instances if the averaged value of all measurement results of the metric `cpu load` is greater than the threshold of 0.7 (70%).
 This condition is checked every 30 seconds as defined via the period. Once the scaling-out is finished it starts a cooldown of 60 seconds. For this cooldown time further scaling requests are rejected by the AutoScaling Engine.
@@ -239,3 +240,4 @@ Actions types are the operations that can be executed when defined conditions ar
 [spring.io]:https://spring.io/
 [openbaton]: http://openbaton.org
 [openbaton-doc]: http://openbaton.org/documentation
+[tosca-as]:tosca-asp.md
diff --git a/docs/descriptors/tutorial-dummy-NSR/tutorial-dummy-NSR.json b/docs/descriptors/tutorial-dummy-NSR/tutorial-dummy-NSR.json
@@ -24,7 +24,8 @@
             {
               "connection_point":[
                 {
-                  "virtual_link_reference":"private"
+                  "virtual_link_reference":"private",
+                  "interfaceId":0
                 }
               ]
             }
@@ -77,15 +78,17 @@
               "connection_point":[
                 {
                   "floatingIp":"random",
-                  "virtual_link_reference":"private"
+                  "virtual_link_reference":"private",
+                  "interfaceId":0
                 }
               ]
             },
             {
               "connection_point":[
                 {
                   "floatingIp":"random",
-                  "virtual_link_reference":"private"
+                  "virtual_link_reference":"private",
+                  "interfaceId":0
                 }
               ]
             }

diff --git a/docs/descriptors/tutorial-iperf-NSR/tutorial-iperf-NSR-floatingIPs.json b/docs/descriptors/tutorial-iperf-NSR/tutorial-iperf-NSR-floatingIPs.json
@@ -37,7 +37,8 @@
               "connection_point":[
                 {
                   "floatingIp":"random",
-                  "virtual_link_reference":"private"
+                  "virtual_link_reference":"private",
+                  "interfaceId":0
                 }
               ]
             }
@@ -93,7 +94,8 @@
               "connection_point":[
                 {
                   "floatingIp":"random",
-                  "virtual_link_reference":"private"
+                  "virtual_link_reference":"private",
+                  "interfaceId":0
                 }
               ]
             }

diff --git a/docs/descriptors/tutorial-iperf-NSR/tutorial-iperf-NSR-privateIPs.json b/docs/descriptors/tutorial-iperf-NSR/tutorial-iperf-NSR-privateIPs.json
@@ -36,7 +36,8 @@
             {
               "connection_point":[
                 {
-                  "virtual_link_reference":"private"
+                  "virtual_link_reference":"private",
+                  "interfaceId":0
                 }
               ]
             }
@@ -86,7 +87,8 @@
             {
               "connection_point":[
                 {
-                  "virtual_link_reference":"private"
+                  "virtual_link_reference":"private",
+                  "interfaceId":0
                 }
               ]
             }

diff --git a/docs/descriptors/tutorial-sipp-fms/sipp-fms-nsd.json b/docs/descriptors/tutorial-sipp-fms/sipp-fms-nsd.json
@@ -43,7 +43,8 @@
               "connection_point":[
                 {
                   "floatingIp":"random",
-                  "virtual_link_reference":"private"
+                  "virtual_link_reference":"private",
+                  "interfaceId":0
                 }
               ]
             }
@@ -138,7 +139,8 @@
               "connection_point":[
                 {
                   "floatingIp":"random",
-                  "virtual_link_reference":"private"
+                  "virtual_link_reference":"private",
+                  "interfaceId":0
                 }
               ]
             }

diff --git a/docs/descriptors/tutorial-sipp/NetworkServiceDescriptor-SIPp-floatingIPs.json b/docs/descriptors/tutorial-sipp/NetworkServiceDescriptor-SIPp-floatingIPs.json
@@ -37,7 +37,8 @@
                             "connection_point":[
                                 {
                                     "floatingIp":"random",
-                                    "virtual_link_reference":"private"
+                                    "virtual_link_reference":"private",
+                                    "interfaceId":0
                                 }
                             ]
                         }
@@ -178,7 +179,8 @@
                             "connection_point":[
                                 {
                                     "floatingIp":"random",
-                                    "virtual_link_reference":"private"
+                                    "virtual_link_reference":"private",
+                                    "interfaceId":0
                                 }
                             ]
                         }

diff --git a/docs/descriptors/tutorial-sipp/NetworkServiceDescriptor-SIPp.json b/docs/descriptors/tutorial-sipp/NetworkServiceDescriptor-SIPp.json
@@ -36,7 +36,8 @@
                         {
                             "connection_point":[
                                 {
-                                    "virtual_link_reference":"private"
+                                    "virtual_link_reference":"private",
+                                    "interfaceId":0
                                 }
                             ]
                         }
@@ -176,7 +177,8 @@
                         {
                             "connection_point":[
                                 {
-                                    "virtual_link_reference":"private"
+                                    "virtual_link_reference":"private",
+                                    "interfaceId":0
                                 }
                             ]
                         }

diff --git a/docs/fault-management.md b/docs/fault-management.md
diff --git a/docs/fms-sipp-tutorial.md b/docs/fms-sipp-tutorial.md
@@ -1,5 +1,4 @@
 # Tutorial: Fault Management System
------------------------------------------  
 
 This tutorial explain how to use the Fault Management System in a simple network service. The network service is composed by a SIPp client and a SIPp server. 
 The Fault Management System will create a standby SIPp server in order to protect the active SIPp server from failures.
@@ -10,17 +9,17 @@ In order to execute this scenario, you need to have the following components up
 
  * [NFVO][nfvo-github]
  * [OpenStack vim driver][openstack-plugin]
- * [Zabbix plugin][zabbix-plugin] + Zabbix Server 2.2v
+ * [Zabbix plugin][zabbix-plugin] + Zabbix Server (2.2 or 3.0 version)
  * [Generic VNFM][generic-vnfm]
  * [Fault Management System][fms]
  * OpenStack
 
 Start the NFVO and Generic VNFM depending on how you [installed][installation] it.  
-If you used the bootstrap script for installing you do not have to care about the OpenStack vim driver as it will be installed already. 
+If you used the bootstrap script for installing you do not have to care about the OpenStack vim driver as it will be installed already, as well as Zabbix Plugin. 
 
 ## Store the Vim Instance
 
-For registering the Point of Presence of type OpenStack to the NFVO you have to upload a Vim Instance. You can use the following [json descriptor][vim] by changing the values to your needs. 
+For registering the Point of Presence of type OpenStack to the NFVO you have to upload a Vim Instance. You can use the following [json descriptor][vim-instance-json] by changing the values to your needs. 
 
 ### Using the dashboard
 
@@ -39,13 +38,12 @@ $./openbaton.sh VimInstance-create vim-instance.json
 
 ## Store the Network Service Descriptor
 
-Download the [sipp-fms-nsd.json][sipp-fms-nsd] file, and upload it in the catalogue either using the dashboard or the CLI.  
+Download the [sipp-fms-nsd.json][sipp-fms-nsd] file, make sure that all the parameters fit with your environment and then upload it in the catalogue either using the dashboard or the CLI.  
+The main parameters you should check before uploading the NSD are: vm_image (make sure you have and Ubuntu image in OpenStack and its name matches the one in this parameter), vimInstanceName (if you only have one vim instance you can leave it empty otherwise you must specify the vim instance name in this parameter or when you will launch the NSD) and flavour_key (make sure you have a flavour in OpenStack matching the one in this parameter).
 
 ### Using the dashboard
 
-If you want to use the Dashboard go to `Catalogue -> NS Descriptors` and choose the NSD of your choice by clicking on `Upload NSD` and selecting the Descriptor's json file.
-
-![Onboarding-NSD][nsd-onboarding]
+If you want to use the Dashboard go to `Catalogue -> NS Descriptors`, copy the text of NSD "sipp-fms-nsd.json", click `Add NSD -> Upload NSD`, paste the NSD and click `Store NSD`.
 
 ### Using the CLI
 
@@ -87,7 +85,7 @@ Once this request is processed successfully, it returns the following:
 ```
 
 ## Deploy the Network Service Descriptor
-As soon as you onboarded the NSD in the NFVO you can deploy this NSD either by using the dashboard or the CLI.  
+As soon as you uploaded the NSD in the NFVO you can deploy this NSD either by using the dashboard or the CLI.  
 This will create a Network Service Record (NSR) and actually launch the Virtual Machines on OpenStack. The network service is composed by two VNFC instances (virtual machines), however the Fault Management System creates a third virtual machine, which consists in the SIPp server in standby.
 
 ### Using the dashboard
@@ -106,7 +104,7 @@ Regarding the SIPp server VNF you should see the following:
 
 Now you can trigger the switch to standby simulating a failure.  
 Go to Openstack dashboard and terminate the virtual machine which correspond to the ACTIVE SIPp server. As you can expect the SIPp client will loose the connection with the server.  
-However after 1/2 minutes the FMS will execute the switch to standby. After this action, the standby SIPp server is activated and the client will connect to the new one, so that the network service recovers from the failure.
+However after 1/2 minutes the FMS will execute the switch to standby. After this action, the standby SIPp server will be activated and the client will connect to the new one, so that the network service recovers from the failure.
 
 <!---
 References
@@ -123,4 +121,6 @@ References
 [sipp-fms-nsd]:descriptors/tutorial-sipp-fms/sipp-fms-nsd.json
 [nsd-onboarding]: images/tutorials/tutorial-iperf-NSR/nsd-onboarding.png
 [nsr-deploy]: images/tutorials/tutorial-iperf-NSR/nsr-deploy.png
-[vnfc-active-standby]:images/tutorials/tutorial-sipp-fms/vnfc-active-standby.png
+[vnfc-active-standby]:images/tutorials/tutorial-sipp-fms/vnfc-active-standby.png
+[vim-instance-json]:descriptors/vim-instance/openstack-vim-instance.json
+[vim-onboarding]: images/tutorials/tutorial-iperf-NSR/vim-onboarding.png
diff --git a/docs/how-to-register-event.md b/docs/how-to-register-event.md
@@ -21,7 +21,7 @@ repositories {
 }
 
 dependencies {
-    compile 'org.openbaton:sdk:3.0.0'
+    compile 'org.openbaton:sdk:3.2.0'
 }
 ```
 
@@ -158,7 +158,8 @@ public class RestApi {
   private Gson gson = new GsonBuilder().setPrettyPrinting().create();
 
   @RequestMapping(method = RequestMethod.POST, consumes = MediaType.APPLICATION_JSON_VALUE)
-  public void receiveEvent(JsonObject event){
+  public void receiveEvent(@RequestBody String msg){
+    JsonObject event = new JsonParser().parse(msg).getAsJsonObject();
     System.out.println("Received event from NFVO:\n" + event);
     String action = event.get("action").getAsString();
     System.out.println("The action is: " + action);
@@ -178,4 +179,4 @@ public class RestApi {
   }
 }
 ```
-As shown in the example class, the payload is a json string converted to the NetworkServiceRecord or VirtualNetworkFunctionRecord depending on the event. Another note is that the NFVO calls a POST on the specified eventEndpoint (in this case "http://172.0.0.1/event/module"), for that reason the RestApi example class is listening on that path for a POST method.
+As shown in the example class, the payload is a json string converted to the NetworkServiceRecord or VirtualNetworkFunctionRecord depending on the event. Another note is that the NFVO calls a POST on the specified eventEndpoint (in this case "http://172.0.0.1/event/module"), for that reason the RestApi example class is listening on that path for a POST method.
diff --git a/docs/images/edit-NSD1.png b/docs/images/edit-NSD1.png
diff --git a/docs/images/edit-NSD2.png b/docs/images/edit-NSD2.png
diff --git a/docs/images/nfvo-how-to-use-gui-NSD-create-file.png b/docs/images/nfvo-how-to-use-gui-NSD-create-file.png
diff --git a/docs/images/nfvo-how-to-use-gui-NSD-create-form.png b/docs/images/nfvo-how-to-use-gui-NSD-create-form.png
diff --git a/docs/images/nfvo-how-to-use-gui-NSDlist.png b/docs/images/nfvo-how-to-use-gui-NSDlist.png
diff --git a/docs/images/nfvo-how-to-use-gui-add-user.png b/docs/images/nfvo-how-to-use-gui-add-user.png
diff --git a/docs/images/nfvo-how-to-use-gui-launch-config.png b/docs/images/nfvo-how-to-use-gui-launch-config.png
diff --git a/docs/images/nfvo-how-to-use-gui-overview.png b/docs/images/nfvo-how-to-use-gui-overview.png
diff --git a/docs/images/vim-instance-register-new-pop-file.png b/docs/images/vim-instance-register-new-pop-file.png
diff --git a/docs/images/vim-instance-register-new-pop.png b/docs/images/vim-instance-register-new-pop.png
diff --git a/docs/images/zabbix-plugin-architecture.png b/docs/images/zabbix-plugin-architecture.png
diff --git a/docs/index.md b/docs/index.md
@@ -1,4 +1,4 @@
-## Open Baton
+# Open Baton
 Open Baton is an open source project providing a comprehensive implementation of the ETSI Management and Orchestration (MANO) specification. 
 
 ## Its main components

diff --git a/docs/iperf-NSR.md b/docs/iperf-NSR.md
@@ -1,5 +1,4 @@
 # Tutorial: iPerf Network Service
------------------------------------------
 
 This tutorial explains how to deploy a network service that uses iPerf.  
 [iPerf][iperf-website] is a tool for active measurements of the maximum achievable bandwidth between two or more machines where an iPerf client connects to an iPerf server.

diff --git a/docs/monitoring.md b/docs/monitoring.md
@@ -1,4 +1,4 @@
-## Monitoring
+# Monitoring
 
 Open Baton interfaces with monitoring systems using a plugin mechanism. 
 The plugin mechanism allows Open Baton to easily use multiple monitoring system. The following figure shows how the monitoring plugin communicate with the NFVO.

diff --git a/docs/network-slicing.md b/docs/network-slicing.md
@@ -140,6 +140,8 @@ For stopping you can use:
 # How to use Network Slicing Engine
 The currently only supported driver is neutron, which will use the native QoS capabilities of Openstack Mitaka. To use it simply set ```nse.driver=neutron``` in the configuration file. To set QoS policies in your NSD specify the following QoS parameter in the virtual_link of your vnfd configuration. 
 
+In JSON:
+
 ```
   "virtual_link":[
     {
@@ -150,6 +152,18 @@ The currently only supported driver is neutron, which will use the native QoS ca
     }
   ]
 ```
+In YAML:
+
+```yaml
+mgmt:
+  type: tosca.nodes.nfv.VL
+  properties:
+    vendor: Fokus
+    qos:
+      - minimum_bandwith:BRONZE
+
+```
+
 
 [nse-repo]: https://github.com/openbaton/network-slicing
 [openbaton]: http://openbaton.org