To enable application developers to build applications that use OpenStack, we need SDKs for each programming language (e.g., PHP, Go, Java) to provide them with what they need.
The purpose of this page is to work through how we go about building SDKs in a semi-consistent manner on the OpenStack infrastructure.
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.
- The SDK may optionally include tools to help developers use the SDK, such as IDE plugins or batch scripts.
Application developers build applications that interact with OpenStack. Application developers are not OpenStack Operators or Developers. 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.
Goals for each SDK
- Don't break clients!
- Support multiple API versions for each service (e.g., Keystone API v2 and v3).
- Use application developer friendly language in descriptions (e.g., Compute instead of Nova).
- Provide a manner to extend the services in the SDKs.
- Be written in a manner consistent with the language and platform they are for (e.g., A Java SDK shouldn't look like Python).
- Contain example code to get started.
- Contain documentation explaining how to get started and going with the SDKs and the services.
- Contain cross-linked class/module reference documentation.
- Contain a release history/change log documenting deprecations, new additions and bug fixes in the SDK (with links wherever possible).
- Handle OpenStack extensions in a graceful manner (e.g. you should be able to simply make a method call to determine if an OpenStack cloud supports a particular extension).
- Be open source and sustainable.
- Open source license must be compatible with Apache License v2?
Non-Goals for each SDK
- While an SDK should provide working code examples showing usage of the SDK, it must not provide a complete end-user client (e.g. a CLI) implementation. Such an implementation belongs to a separate project that would depend on and use the appropriate SDK.
Summit Design Sessions
- SDK Documentation Discussion at Grizzly Summit
- Documenting Application Developer Resources at Icehouse Summit
Example uses of an SDK
- Syncing objects between containers from two different providers. For example, syncing objects between a private and public cloud.
- Using object storage as a back end to store data or files within an application.
- Building a custom services management tool (e.g., a special purpose CLI or console).