Difference between revisions of "OpenStack-SDK-Node.js"

Latest revision as of 15:47, 14 May 2014

Summary

This project is not an official OpenStack project, nor are there plans to do so in the near term. This wiki entry is an effort to clearly communicate the recommended way to interact/interoperate with OpenStack via a Node.js language binding/Software Development Kit (SDK). We hope this will improve the experience of OpenStack end-users who are using the Node.js programming language by providing them with everything they need to develop applications against OpenStack.

What's in an SDK?: An SDK is more than just a set of APIs provided to you. A complete SDK provides a consumer focused API for interacting with the system, and it additionally includes:

Documentation aimed at users consuming the SDK and system.
Clear examples of usage, including functioning, executable examples.

OpenStack is considering endoring pkgcloud as the 'official' Node.js binding for interacting with OpenStack public/hybrid/private clouds: Open source SDKs for OpenStack application development

Much effort is currently being invested in the pkgcloud project in general and the OpenStack provider in particular. The pkgcloud OpenStack provider already has maximum reuse for OpenStack provider clouds.

Audience

The primary target for this package is application developers who develop against OpenStack. This does not include those who develop OpenStack itself or operate it. These are developers looking to consume a feature-rich OpenStack Cloud with its many services. These Developers require a consistent, single namespace API ("Application Programming Interface") that allows them to build and deploy their application with minimal dependencies.

Requirements

Feel native to developers working in Node.js.
Support multiple API versions for each service (e.g., Nova API v1 and v2).
Provide a method for vendor extensions. Numerous vendors have extensions. There needs to be a method to support these to aid the end developer.

Resources

Source code (pkgcloud)	https://github.com/pkgcloud/pkgcloud
Bug tracker	https://github.com/pkgcloud/pkgcloud/issues

IRC

The developers use IRC in #pkgcloud on freenode for development discussion.

Revision as of 15:43, 14 May 2014 (view source) Ken Perkins (talk \| contribs) (Created page with "__TOC__ == Summary == This project is not an official OpenStack project, nor are there plans to do so in the near term. This wiki entry is an effort to clearly communicate th...")		Latest revision as of 15:47, 14 May 2014 (view source) Ken Perkins (talk \| contribs)
Line 11:		Line 11:


−	OpenStack ~~has endorsed~~ pkgcloud as the 'official' Node.js binding for interacting with OpenStack public/hybrid/private clouds:	+	OpenStack is considering endoring pkgcloud as the 'official' Node.js binding for interacting with OpenStack public/hybrid/private clouds:
	[http://developer.openstack.org Open source SDKs for OpenStack application development]		[http://developer.openstack.org Open source SDKs for OpenStack application development]