tree: 6b443c5392373df06fb6ecbb89e05774d4911cf1 [path history] [tgz]
  1. .gitignore
  2. .npmignore
  3. LICENSE
  4. README.md
  5. package.json
  6. sample-data.json
  7. schema/
  8. src/
  9. test/
  10. webpack.config.js
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.8 start /home/plee/hack/yang-cord
> node lib/api/server.js

[yang-express] start of a new journey
[openapi] enabling...
[openapi] enabled ok
[restjson] enabling...
[restjson] enabled ok
[websocket] enabling...
[yang-express] registering a new link
[yang-express] registered 'link:cord-core'
[yang-express] registering a new link
[yang-express] registered 'link:xos-core'
[websocket] binding to server
[websocket] enabled ok

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