accounting-proxy

Index

• Deployment
  • Software requiremnts
  • Installation
• Configuration
  • Basic configuration
  • Orion Context Broker Configuration
  • Customizing Accounting Proxy for other components
• Running
• Proxy API
• Development
  • Accounting module
  • Testing

Deployment

Software Requirements:

• NodeJS: Homepage.
  • Express Framework: Homepage.
  • Redis for NodeJs: GitHub
  • Node Schedule: GitHub.
  • Commander: GitHub.
  • Fiware PEP-Proxy: GitHub.
  • Orion Context Broker: Homepage.

Installation:

To install NodeJS dependencies, execute in the accounting-proxy folder:

npm install

Configuration

Basic configuration

All the Accounting Proxy configuration is stored in the config.js file in the root of the project folder.

In order to have the accounting proxy running there are some information to fill:

• config.accounting_proxy: the information of the accounting proxy itself.

• port: port where the accounting proxy server is listening to client requests.
• store_port: port where the accounting proxy is listening to WStore notifications.

{
		port: 9000,
    	store_port: 9001
}

• config.database: the database used by the proxy. Possible options:
  • './db' : an SQL database (sqlite).
  • './db_Redis' : a Redis database.
• config.database_name: the database name for the SQL database ('accountingDB.sqlite' by default).
• config.modules: an array of accounting modules for accounting in different ways.

{
    accounting: [ 'call', 'megabyte']
}

• config.WStore: the information of the WStore server.
  • accounting_host: WStore host.
  • accounting_path: WStore path for accounting notifications.
  • accounting_port: Wstore port.

{
        accounting_host: 'localhost',
        accounting_path: '/api/contracting/',
        accounting_port: 9010
}

• config.resources: configuration of the resources accounted by the proxy.
  • contextBroker: set this option to true if the resource accounted is an Orion Context Broker. Otherwise set this option to false (default value).
  • notification_port: port qhere the accounting proxy is listening to subscription notifications from the Orion Context Broker (port 9002 by default).

{
        contextBroker: false,
        notification_port: 9002
}

Components configuration

---

The Accounting Proxy can proxied Orion Context Broker and other components by changing some configuration parameters.

Orion Context Broker configuration

In order to configure the Accounting Proxy working with Orion Context Broker there are some steps to follow:

• First, configure the config.resources section of config.js file in the root of the project folder.
  • contextBroker: set true this parameter.
  • notification_port: port where the accounting proxy server is listening to subscription notifications.

{
		contextBroker: true,
		notification_port: 9002
}

• After that, copy the ./fiware-pep-steelskin/config.js file into your PEP-Proxy folder and overwrite the existing config.js file.
• Then, copy the ./fiware-pep-steelskin/lib/plugins/accountingPlugin.js file into your PEP-Proxy plugins folder (fiware-pep-steelskin/lib/plugins).
• Finally, configure the PEP-Proxy config.js file copied in the previous step:
  • config.resource.original.host: the Accounting Proxy host.
  • port: the Accounting Proxy port (the same previously configured in the Accounting Proxy config.js as config.accounting_proxy.port, 9000 by default).
  • admin_port : the Accounting Proxy port where administration accounting proxy is listening (the same previously configured in the Accounting Proxy config.js as config.accounting_proxy.store_port, 9001 by default).
  • admin_paths: the administration paths used by WStore to notify the Accounting Proxy. (Do not change it).

{
        host: 'localhost',
        port: 9000,
        admin_port: 9001,
        admin_paths: ['/api/users', '/api/resources', '/api/users/keys']
}

Customizing Accounting Proxy for other components

In order to configure the Accounting Proxy working with other components follow this two steps:

• First, configure the config.resources section of config.js file in the root of the project folder.

  • contextBroker: set false this parameter to disable the Context Broker accounting.
  • The rest of information in config.resources is unnecessary in this case.

• After that, copy the ./fiware-pep-steelskin/config.js file into your PEP-Proxy folder and overwrite the existing config.js file.

• Then, copy the ./fiware-pep-steelskin/restAccountingPlugin.js file into your PEP-Proxy plugins folder (fiware-pep-steelskin/lib/plugins).

• Finally, configure the PEP-Proxy config.js file copied in the previous step:

  • config.resource.original.host: the Accounting Proxy host.
  • port: the Accounting Proxy port (the same previously configured in the Accounting Proxy config.js as config.accounting_proxy.port, 9000 by default).
  • admin_port : the Accounting Proxy port where administration accounting proxy is listening (the same previously configured in the Accounting Proxy config.js as config.accounting_proxy.store_port, 9001 by default).
  • admin_paths: the administration paths used by WStore to notify the Accounting Proxy. (Do not change it).

{
	host: 'localhost',
    port: 9000,
    admin_port: 9001,
    admin_paths: ['/api/users', '/api/resources', '/api/users/keys']
}

Running

Before run the Accounting Proxy you must have the PEP-Proxy and the Orion Context Broker running.

Then, execute:

node accounting-proxy

CLI

In order to manage servicies, use 'cli' tool. There are four commands available:

• ./cli addService <publicPath> <url>: binds the public path with the url specified.
• ./cli getService <publicPath>: returns the url associated with the public path.
• ./cli deleteService <publicPath>: delete the service associated with the public path.
• ./cli getInfo <userID>: returns information associated with the userID.

To display brief information: ./cli -h

Proxy API

Proxy's api is in port 9001 and root path /api/...

POST ../users

Use by the store to notify a offer purchase. Format example:

{
    "offering": {
        "organization": "...",
        "name": "...",
        "version": "..."
    },
    "provider": "...",
    "name": "...",
    "version": "...",
    "content_type":"...",
    "url": "http://...",
    "record_type": "...",
    "unit": "...",
    "component_label": "..."
}

• unit: accounting unit (megabyte, call, ...).

POST ../resources

Use by the store to notify a new resource include in an offer. Format example:

{
  "offering": {
    "organization": "...",
    "name": "...",
    "version": "..."
  },
  "reference": "...",
  "customer": "...",
  "customer_name": "...",
  "resources": 
 [
    {
      "provider": "...",
      "name": "...",
      "version": "...",
      "content_type":"...",
      "url": "http://..."
    },
    {
      "provider": "...",
      "name": "...",
      "version": "...",
      "content_type":"...",
      "url": "http://..."
    }
  ]
}

GET ../users/keys

Retrieve the user's API_KEYs in a json:

[
    {
        " offering": {
            "organization": "...",
            "name": "...",
            "version": "..."
        },
        "API_KEY": "..."
    },
    ...
]

Development

Accounting module

Accounting modules should be implemented following the next code:

/** Accounting module for unit: XXXXXX */

exports.count = function(response, callback) {
    // Code to do the accounting goes here
    // .....

    callback(error, amount);
}

The function count receives three parameters:

• response object.
• callback function, which is use to retrieve the amount to count or the error. The function has 2 parameters:
  • error string, with a description of the error if there is one. Otherwise, undefined.
  • ammount number, with the amount to add to the accounting.

Testing

To run tests type:

npm test

Test reporter generates a directory ./coverage with all the coverage information (coverage reporter is generated by Istanbul).

---

Last updated: _11/02/2016