Gitiles
Code Review Sign In
gerrit.opencord.org / composer / afb5460a335553eb5311d1f82bfdad432949f506
commitafb5460a335553eb5311d1f82bfdad432949f506[log] [tgz]
authorPeter K. Lee <peter@corenova.com>Thu Jul 28 23:59:24 2016 -0700
committerGitHub <noreply@github.com>Thu Jul 28 23:59:24 2016 -0700
treee91ac3df4b6f0c1ae0064dc035256a187ae0b657
parentd882a9b3752edd3ef130fc0b15236e1a97b8847e [diff]
Update README.md
1 file changed
tree: e91ac3df4b6f0c1ae0064dc035256a187ae0b657
  1. .gitignore
  2. LICENSE
  3. README.md
  4. package.json
  5. sample-data.json
  6. schema/
  7. src/
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

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