Jump to: navigation, search

Difference between revisions of "OpenStack-SDK-Ruby"

(Create initial landing page for a Ruby SDK of some sort.)
 
(Summary)
Line 9: Line 9:
 
* Documentation aimed at users consuming the SDK and system.  
 
* Documentation aimed at users consuming the SDK and system.  
 
* Clear examples of usage, including functioning, executable examples.
 
* Clear examples of usage, including functioning, executable examples.
 +
 +
 +
Note that much effort is currently being invested in the Fog project in general and the OpenStack provider in particular around this topic.
  
 
== Audience ==
 
== Audience ==

Revision as of 20:32, 13 March 2014

Summary

This is a proposed OpenStack project that is designed to improve the experience of OpenStack end-users who are using the Ruby 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.


Note that much effort is currently being invested in the Fog project in general and the OpenStack provider in particular around this topic.

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

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

Todo

Design Decisions

Resources

IRC

The developers use IRC in #openstack-sdks on freenode for development discussion.