| 1 |
|
| 2 | # NAM Adapter
|
| 3 |
|
| 4 | NAM Adapter is the component in charge of the Network Active Monitoring data within the XIFI Infrastructure Monitoring Middleware (XIMM) (initial description and concepts provided in the [deliverable D3.1- XIFI infrastructure adaptation components API open specification] (http://wiki.fi-xifi.eu/Public:D3.1)). This component provides a multi-domain monitoring mechanism able to handle latency and bandwidth-related tests along a set of points of interest within the federated community.
|
| 5 |
|
| 6 | ## Install
|
| 7 |
|
| 8 | ### Installation Requirements
|
| 9 |
|
| 10 | The main recommendation to install the NAM Adapter is to deploy the software package on a host with Ubuntu/ Debian running as Operating System. If this was not the case, it would be necessary to check how to install additional packages that are required. NAM's software repository has been successfully tested with versions 12.10 and 13.10 of Ubuntu, and version 7.3 of Debian. No major issues are expected for upcoming versions.
|
| 11 |
|
| 12 | In order to work properly, the component requires the following set of software modules:
|
| 13 |
|
| 14 | * Node.js
|
| 15 | * MongoDB
|
| 16 | * NTP
|
| 17 | * Iperf
|
| 18 |
|
| 19 | The required software can be installed manually from the default Debian/Ubuntu repositories by using the following commands:
|
| 20 |
|
| 21 | Install Node-js
|
| 22 | ```
|
| 23 | $ sudo apt-get update
|
| 24 | $ sudo apt-get install -y python-software-properties python g++ make
|
| 25 | $ sudo add-apt-repository -y ppa:chris-lea/node.js
|
| 26 | $ sudo apt-get update
|
| 27 | $ sudo apt-get install nodejs
|
| 28 | ```
|
| 29 |
|
| 30 | Install mongodb
|
| 31 | ```
|
| 32 | $ sudo apt-get install mongodb
|
| 33 | ```
|
| 34 |
|
| 35 | Install iperf
|
| 36 |
|
| 37 | ```
|
| 38 | $ sudo apt-get install iperf
|
| 39 | ```
|
| 40 |
|
| 41 |
|
| 42 |
|
| 43 | ### Installation of the NAM Adapter in Debian/Ubuntu
|
| 44 |
|
| 45 | For install nam adapter uses the following command:
|
| 46 |
|
| 47 | ```
|
| 48 | sudo npm nam_adapter
|
| 49 | ```
|
| 50 |
|
| 51 | ## Usage
|
| 52 |
|
| 53 | ### Request an On-Demand Test between endpoints
|
| 54 | A Call instance resource represents a measure between a host A and host B. The following parameters are needed to run Test On-Demand (OWD or BDW):
|
| 55 |
|
| 56 | * URI: http://{hostServerNAM}:{portNAM}/monitoring/host2hosts/{serviceType}/{regionId_Source}-{hostId_Source};{regionId_Destination}-{hostId_Destination}
|
| 57 | * Method: GET
|
| 58 | * Content-Type: Application/JSON
|
| 59 | * Query string parameters: ?format=XML/JSON/TXT
|
| 60 | * Request body: none
|
| 61 |
|
| 62 |
|
| 63 | Example of usage:
|
| 64 |
|
| 65 | ```
|
| 66 | curl --header "{my-token}" "http://138.4.47.33:3000/monitoring/host2hosts/owd/Trento-193.205.211.69;Waterford-193.1.202.133"
|
| 67 | ```
|
| 68 |
|
| 69 | ## Developing
|
| 70 |
|
| 71 |
|
| 72 |
|
| 73 | ### Tools
|
| 74 |
|