Gitiles
Code Review Sign In
gerrit.opencord.org / composer / ca9a02b752c46100d9cd8ab634c2856ad4fd87f8
commitca9a02b752c46100d9cd8ab634c2856ad4fd87f8[log] [tgz]
authorPeter K. Lee <peter@corenova.com>Thu Jul 28 19:13:11 2016 -0700
committerGitHub <noreply@github.com>Thu Jul 28 19:13:11 2016 -0700
tree0e31ed77b70782174bbfc79d4aba990c1727a728
parent0b611d6900835f30013a9a671970146170136fd2 [diff]
Update README.md
1 file changed
tree: 0e31ed77b70782174bbfc79d4aba990c1727a728
  1. .gitignore
  2. LICENSE
  3. README.md
  4. package.json
  5. sample-data.json
  6. schema/
  7. src/
README.md

yang-cord

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 Overview - provides 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