commit	28b3c404031e38d4072adfc2e6034dda0641a5ad	[log] [tgz]
author	Peter K. Lee <peter@intercloud.net>	Tue Aug 09 18:11:28 2016 -0700
committer	Peter K. Lee <peter@intercloud.net>	Tue Aug 09 18:11:28 2016 -0700
tree	95c1b62921c0f19694bb227afda09173daf05fb5
parent	87698fa849af329571176e5cf352775a4ba80e1f [diff]

tree: 95c1b62921c0f19694bb227afda09173daf05fb5

README.md

YANG model-driven CORD

This is a work-in-progress effort to create YANG data models for the CORD project and deliver flexible service compositions.

You may contact Larry Peterson llp@onlab.us and Peter Lee peter@corenova.com to learn more about this initiative and find out how you can help.

Installation

$ npm install yang-cord

Getting Started

Following the installation, you can start an instance of the YANG model-driven REST API web server. It utilizes yang-express middleware framework built on Express.js to provide dynamic YANG model-driven API routing capability.

$ npm start

> yang-cord@1.0.1 start /home/peter/yang-cord
> node lib/server.js

mounted 'cord-core' model
mounted 'xos-core' model
[cord-core] calling GET on /cord-core:subscriber

An option --port is provided to specify the port to listen on, it can be used with:

npm start -- --port 3000

Reference Guides

API Guide - provides a walkthrough on interacting with the REST API endpoints
Modeler's Guide - provides information on current YANG models for XOS and CORD and what's coming up next
Developer's Guide - provides technical detail on controller logic and dynamic interfaces and how to best leverage YANG model-driven developer tools for getting things done fast.

Tests

To run the test suite, first install the dependencies, then run npm test.

$ npm install
$ npm test

Mocha test suite is currently under development...

LICENSE

Apache 2.0