api-site/www/index.html
Anne Gentle 2af1e02e7a Updates the API Reference links
Change-Id: Iff04d17d09841651d3ff37338a04e4c4ebd25956
2015-03-19 23:54:29 -05:00

960 lines
24 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html lang="en" xml:lang="en" xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta content="HTML Tidy for Linux/x86 (vers 11 February 2007), see www.w3.org" name="generator"/>
<meta content="text/html; charset=utf8" http-equiv="Content-Type"/>
<meta content="Ip5yk0nd8yQHEo8I7SjzVfAiadlHvTvqQHLGwn1GFyU" name="google-site-verification"/>
<title>
Documentation &gt;&gt; Application Development
</title>
<!-- Google Fonts -->
<link href="http://www.openstack.org/blog/feed/" rel="alternate" title="RSS 2.0" type="application/rss+xml"/>
<link href="http://fonts.googleapis.com/css?family=PT+Sans&amp;subset=latin" rel="stylesheet" type="text/css"/>
<!-- Framework CSS -->
<link href="http://openstack.org/themes/openstack/css/blueprint/screen.css" media="screen, projection" rel="stylesheet" type="text/css"/>
<link href="http://openstack.org/themes/openstack/css/blueprint/print.css" media="print" rel="stylesheet" type="text/css"/>
<!--[if lt IE 8]><link rel="stylesheet" href="http://openstack.org/themes/openstack/css/blueprint/ie.css" type="text/css" media="screen, projection"><![endif]-->
<!-- OpenStack Specific CSS -->
<link href="http://openstack.org/themes/openstack/css/main.css" media="screen, projection, print" rel="stylesheet" type="text/css"/>
<link href="http://openstack.org/themes/openstack/css/dropdown.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript">
//<![CDATA[
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-17511903-1']);
_gaq.push(['_setDomainName', '.openstack.org']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
//]]>
</script>
</head>
<body class="docshome" id="docshome">
<!-- Top Site Banner -->
<div class="topMessage">
<div class="container">
<div class="span-24 last">
<p>
Need help with a development problem?
<a class="roundedButton" href="https://ask.openstack.org/en/questions/">
Ask OpenStack
</a>
</p>
</div>
</div>
</div>
<!-- End Site Banner -->
<div class="container">
<div id="header">
<div class="span-5">
<h1 id="logo">
<a href="http://www.openstack.org/">
OpenStack
</a>
</h1>
</div>
<div class="span-19 last blueLine">
<div class="span-19" id="navigation">
<ul id="Menu1">
<li>
<a href="/" title="Go to the Home page">
Home
</a>
</li>
<li>
<a class="link" href="http://www.openstack.org/software/" title="Go to the Software page">
Software
</a>
</li>
<li>
<a class="link" href="http://www.openstack.org/user-stories/" title="Go to the User Stories page">
User Stories
</a>
</li>
<li>
<a class="link" href="http://www.openstack.org/community/" title="Go to the Community page">
Community
</a>
</li>
<li>
<a class="link" href="http://www.openstack.org/foundation/" title="Go to the Foundation page">
Foundation
</a>
</li>
<li>
<a class="link" href="http://www.openstack.org/profile/" title="Go to the Profile page">
Profile
</a>
</li>
<li>
<a href="http://www.openstack.org/blog/" title="Go to the OpenStack Blog">
Blog
</a>
</li>
<li>
<a href="http://wiki.openstack.org/" title="Go to the OpenStack Wiki">
Wiki
</a>
</li>
<li>
<a href="http://docs.openstack.org/" title="Go to OpenStack Documentation">
Documentation
</a>
</li>
</ul>
</div>
</div>
</div>
<div class="span-17">
<p>
</p>
</div>
<div class="span-7 last gcse-holder">
<div id="gcse">
<script>
(function() {
var cx = '000108871792296872333:noj9nikm74i';
var gcse = document.createElement('script');
gcse.type = 'text/javascript';
gcse.async = true;
gcse.src = (document.location.protocol == 'https:' ? 'https:' : 'http:') +
'//www.google.com/cse/cse.js?cx=' + cx;
var s = document.getElementsByTagName('script')[0];
s.parentNode.insertBefore(gcse, s);
})();
</script>
<gcse:search>
</gcse:search>
</div>
</div>
</div>
<!-- Page Content -->
<div class="container">
<div class="opener span-24 last">
<h1>
Resources for application development on private and public OpenStack clouds.
</h1>
<p>
You interact with an OpenStack cloud using a number of tools. The tool you choose depends on your use case in the cloud. Here are some starting points.
</p>
<div class="toolBoxes">
<div class="sdk span-6 prepend-1">
<h1>
SDK
</h1>
<a href="#sdk">
Software Development Kits
</a>
</div>
<div class="cli span-6 prepend-1">
<h1>
CLI
</h1>
<a href="#cli">
Command Line Interfaces
</a>
</div>
<div class="API span-6 prepend-1 last">
<h1>
API
</h1>
<a href="#api">
Application Programming Interfaces
</a>
</div>
</div>
</div>
<hr/>
<div class="span-24" id="sdk">
<h2>
Software Development Kits
</h2>
<p>
A Software Development Kit (SDK) is a collection of code, examples, and documentation that helps you to create applications in the language of your choice on OpenStack clouds. If your language or use case isn't covered by one of the SDKs below, you may need to use the
<a href="#api">
API
</a>
or one of the other
<a href="https://wiki.openstack.org/wiki/SDKs#Known_SDKs">
Known SDKs
</a>
.
</p>
<div class="span-24" id="java">
<h3 class="lang-name">
Java
</h3>
<div class="span-6 prepend-1">
<p>
<a class="roundedButton" href="http://jclouds.apache.org/guides/openstack/">
Get SDK Now
</a>
</p>
</div>
<div class="span-3">
<dl>
<dt>
SDK
</dt>
<dd>
<a href="http://jclouds.apache.org/guides/openstack/">
Apache jclouds
</a>
</dd>
</dl>
</div>
<div class="span-4 prepend-1">
<dl>
<dt>
Docs and Resources
</dt>
<dd>
<a class="link" href="http://jclouds.apache.org/guides/openstack/" target="_top">
Getting Started Guide
</a>
</dd>
<dd>
<a class="link" href="http://jclouds.apache.org/reference/javadoc/" target="_top">
SDK Reference Manual
</a>
</dd>
<dd>
<a class="link" href="http://jclouds.apache.org/releasenotes/" target="_top">
Release Notes
</a>
</dd>
</dl>
</div>
<div class="span-6 prepend-1">
<dl>
<dt>
Community Links
</dt>
<dd>
<strong>
Twitter:
</strong>
<a href="https://twitter.com/jclouds">
@jclouds
</a>
</dd>
<dd>
<strong>
IRC:
</strong>
<a href="irc://irc.freenode.net/jclouds">
#jclouds
</a>
on freenode
</dd>
<dd>
<strong>
Mailing List:
</strong>
<a href="mailto:jclouds-user-subscribe@apache.org">
Register
</a>
|
<a href="http://www.mail-archive.com/user@jclouds.apache.org/">
Archive
</a>
</dd>
<dd>
<strong>
Report Issues:
</strong>
<a href="http://jclouds.apache.org/reference/report-a-bug/">
Issue Tracker
</a>
</dd>
</dl>
</div>
</div>
<div class="span-24" id="nodejs">
<h3 class="lang-name">
Node.js
</h3>
<div class="span-6 prepend-1">
<p>
<a class="roundedButton" href="https://www.npmjs.org/package/pkgcloud">
Get SDK Now
</a>
</p>
</div>
<div class="span-3">
<dl>
<dt>
SDK
</dt>
<dd>
<a href="https://github.com/pkgcloud/pkgcloud/blob/master/docs/providers/openstack/README.md">
pkgcloud
</a>
</dd>
</dl>
</div>
<div class="span-4 prepend-1">
<dl>
<dt>
Docs and Resources
</dt>
<dd>
<a class="link" href="https://github.com/pkgcloud/pkgcloud/blob/master/docs/providers/openstack/getting-started-compute.md" target="_top">
Getting Started Guide
</a>
</dd>
<dd>
<a class="link" href="https://github.com/pkgcloud/pkgcloud#supported-apis" target="_top">
SDK Reference Manual
</a>
</dd>
<dd>
<a class="link" href="https://github.com/pkgcloud/pkgcloud/releases/" target="_top">
Release Notes
</a>
</dd>
</dl>
</div>
<div class="span-6 prepend-1">
<dl>
<dt>
Community Links
</dt>
<dd>
<strong>
Twitter:
</strong>
<a href="https://twitter.com/pkgcloud">
@pkgcloud
</a>
</dd>
<dd>
<strong>
IRC:
</strong>
<a href="irc://irc.freenode.net/pkgcloud">
#pkgcloud
</a>
on freenode
</dd>
<dd>
<strong>
Mailing List:
</strong>
<a href="https://github.com/pkgcloud/pkgcloud/issues">
GitHub Issues
</a>
</dd>
<dd>
<strong>
Report Issues:
</strong>
<a href="https://github.com/pkgcloud/pkgcloud/issues">
Issue Tracker
</a>
</dd>
</dl>
</div>
</div>
<div class="span-24" id="ruby">
<h3 class="lang-name">
Ruby
</h3>
<div class="span-6 prepend-1">
<p>
<a class="roundedButton" href="https://github.com/fog/fog/blob/master/lib/fog/openstack/docs/getting_started.md">
Get SDK Now
</a>
</p>
</div>
<div class="span-3">
<dl>
<dt>
SDK
</dt>
<dd>
<a href="https://github.com/fog/fog/blob/master/lib/fog/openstack/docs/getting_started.md">
Fog
</a>
</dd>
</dl>
</div>
<div class="span-4 prepend-1">
<dl>
<dt>
Docs and Resources
</dt>
<dd>
<a class="link" href="https://github.com/fog/fog/blob/master/lib/fog/openstack/docs/getting_started.md" target="_top">
Getting Started Guide
</a>
</dd>
<dd>
<a class="link" href="http://rubydoc.info/gems/fog/" target="_top">
SDK Reference Manual
</a>
</dd>
<dd>
<a class="link" href="https://github.com/fog/fog/blob/master/changelog.txt" target="_top">
Release Notes
</a>
</dd>
</dl>
</div>
<div class="span-6 prepend-1">
<dl>
<dt>
Community Links
</dt>
<dd>
<strong>
Twitter:
</strong>
<a href="https://twitter.com/fog">
@fog
</a>
</dd>
<dd>
<strong>
IRC:
</strong>
<a href="irc://irc.freenode.net/ruby-fog">
#ruby-fog
</a>
on freenode
</dd>
<dd>
<strong>
Mailing List:
</strong>
<a href="http://groups.google.com/group/ruby-fog">
ruby-fog
</a>
</dd>
<dd>
<strong>
Report Issues:
</strong>
<a href="https://github.com/fog/fog/issues">
Issue Tracker
</a>
</dd>
</dl>
</div>
</div>
<div class="span-24" id="net">
<h3 class="lang-name">
.NET
</h3>
<div class="span-6 prepend-1">
<p>
<a class="roundedButton" href="https://www.nuget.org/packages/OpenStack-SDK-DotNet/">
Get SDK Now
</a>
</p>
</div>
<div class="span-3">
<dl>
<dt>
SDK
</dt>
<dd>
<a href="https://www.nuget.org/packages/OpenStack-SDK-DotNet/">
.NET
</a>
</dd>
</dl>
</div>
<div class="span-4 prepend-1">
<dl>
<dt>
Docs and Resources
</dt>
<dd>
<a class="link" href="https://wiki.openstack.org/wiki/OpenStack-SDK-DotNet" target="_top">
Wiki
</a>
</dd>
<dd>
<a class="link" href="https://github.com/stackforge/openstack-sdk-dotnet" target="_top">
Source Code
</a>
</dd>
<dd>
<a class="link" href="https://blueprints.launchpad.net/openstack-sdk-dotnet" target="_top">
Blueprints
</a>
</dd>
</dl>
</div>
<div class="span-6 prepend-1">
<dl>
<dt>
Community Links
</dt>
<dd>
<strong>
IRC:
</strong>
<a href="irc://irc.freenode.net/openstack-sdks">
#openstack-sdks
</a>
on freenode
</dd>
<dd>
<strong>
Mailing List:
</strong>
<a href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev">
Register
</a>
|
<a href="http://lists.openstack.org/pipermail/openstack-dev/">
Archive
</a>
</dd>
<dd>
<strong>
Report Issues:
</strong>
<a href="https://bugs.launchpad.net/openstack-sdk-dotnet">
Issue Tracker
</a>
</dd>
</dl>
</div>
</div>
<div class="span-24" id="php">
<h3 class="lang-name">
PHP
</h3>
<div class="span-6 prepend-1">
<p>
Work In Progress
</p>
</div>
<div class="span-3">
<dl>
<dt>
SDK
</dt>
<dd>
PHP
</dd>
</dl>
</div>
<div class="span-4 prepend-1">
<dl>
<dt>
Docs and Resources
</dt>
<dd>
<a class="link" href="https://wiki.openstack.org/wiki/OpenStack-SDK-PHP" target="_top">
Wiki
</a>
</dd>
<dd>
<a class="link" href="https://github.com/stackforge/openstack-sdk-php" target="_top">
Source Code
</a>
</dd>
<dd>
<a class="link" href="https://blueprints.launchpad.net/openstack-sdk-php" target="_top">
Blueprints
</a>
</dd>
</dl>
</div>
<div class="span-6 prepend-1">
<dl>
<dt>
Community Links
</dt>
<dd>
<strong>
IRC:
</strong>
<a href="irc://irc.freenode.net/openstack-sdks">
#openstack-sdks
</a>
on freenode
</dd>
<dd>
<strong>
Mailing List:
</strong>
<a href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev">
Register
</a>
|
<a href="http://lists.openstack.org/pipermail/openstack-dev/">
Archive
</a>
</dd>
<dd>
<strong>
Report Issues:
</strong>
<a href="https://bugs.launchpad.net/openstack-sdk-php">
Issue Tracker
</a>
</dd>
</dl>
</div>
</div>
<div class="span-24" id="python">
<h3 class="lang-name">
Python
</h3>
<div class="span-6 prepend-1">
<p>
Work In Progress
</p>
</div>
<div class="span-3">
<dl>
<dt>
SDK
</dt>
<dd>
Python
</dd>
</dl>
</div>
<div class="span-4 prepend-1">
<dl>
<dt>
Docs and Resources
</dt>
<dd>
<a class="link" href="https://wiki.openstack.org/wiki/SDK-Development/PythonOpenStackSDK" target="_top">
Wiki
</a>
</dd>
<dd>
<a class="link" href="https://github.com/stackforge/python-openstacksdk" target="_top">
Source Code
</a>
</dd>
<dd>
<a class="link" href="https://blueprints.launchpad.net/unifiedsdk" target="_top">
Blueprints
</a>
</dd>
</dl>
</div>
<div class="span-6 prepend-1">
<dl>
<dt>
Community Links
</dt>
<dd>
<strong>
IRC:
</strong>
<a href="irc://irc.freenode.net/openstack-sdks">
#openstack-sdks
</a>
on freenode
</dd>
<dd>
<strong>
Mailing List:
</strong>
<a href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev">
Register
</a>
|
<a href="http://lists.openstack.org/pipermail/openstack-dev/">
Archive
</a>
</dd>
<dd>
<strong>
Report Issues:
</strong>
<a href="https://bugs.launchpad.net/unifiedsdk">
Issue Tracker
</a>
</dd>
</dl>
</div>
</div>
</div>
<div class="span-24" id="cli">
<h2>
Command Line Interfaces
</h2>
<p>
An OpenStack Command Line Interface (CLI) is a text based client that helps you to create scripts for interacting with OpenStack clouds.
</p>
<div class="span-24" id="python">
<div class="span-3">
<dl>
<dt>
Official CLI
</dt>
<dd>
<a href="https://git.openstack.org/cgit/openstack/python-openstackclient/">
OpenStack Client
</a>
</dd>
<dd>
<a href="https://git.openstack.org/cgit/openstack/python-cinderclient/">
Block Storage
</a>
</dd>
<dd>
<a href="https://git.openstack.org/cgit/openstack/python-novaclient/">
Compute
</a>
</dd>
<dd>
<a href="https://git.openstack.org/cgit/openstack/python-saharaclient/">
Database Processing
</a>
</dd>
<dd>
<a href="https://git.openstack.org/cgit/openstack/python-troveclient/">
Database Service
</a>
</dd>
<dd>
<a href="https://git.openstack.org/cgit/openstack/python-keystoneclient/">
Identity Service
</a>
</dd>
<dd>
<a href="https://git.openstack.org/cgit/openstack/python-glanceclient/">
Image Service
</a>
</dd>
<dd>
<a href="https://git.openstack.org/cgit/openstack/python-neutronclient/">
Networking
</a>
</dd>
<dd>
<a href="https://git.openstack.org/cgit/openstack/python-swiftclient/">
Object Storage
</a>
</dd>
<dd>
<a href="https://git.openstack.org/cgit/openstack/python-heatclient/">
Orchestration
</a>
</dd>
<dd>
<a href="https://git.openstack.org/cgit/openstack/python-ceilometerclient/">
Telemetry
</a>
</dd>
</dl>
</div>
<div class="span-4 prepend-1">
<dl>
<dt>
Docs and Resources
</dt>
<dd>
<a class="link" href="http://docs.openstack.org/user-guide/content/ch_cli.html" target="_top">
Getting Started Guide
</a>
</dd>
<dd>
<a class="link" href="http://docs.openstack.org/cli-reference/content/" target="_top">
CLI Reference Manual
</a>
</dd>
</dl>
</div>
<div class="span-6 prepend-1">
<dl>
<dt>
Community Links
</dt>
<dd>
<strong>
Twitter:
</strong>
<a href="https://twitter.com/openstack">
@openstack
</a>
</dd>
<dd>
<strong>
IRC:
</strong>
<a href="irc://irc.freenode.net/openstack">
#openstack
</a>
</dd>
<dd>
<strong>
Mailing List:
</strong>
<a href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack">
Register
</a>
|
<a href="http://openstack.markmail.org/">
Archive
</a>
</dd>
<dd>
<strong>
Report Issues:
</strong>
<a href="https://bugs.launchpad.net/">
Issue Tracker
</a>
</dd>
<dd>
<strong>
Support:
</strong>
<a href="https://ask.openstack.org/">
Ask
</a>
</dd>
</dl>
</div>
</div>
</div>
<div class="span-24" id="api">
<h2>
Application Programming Interfaces
</h2>
<p>
An Application Programming Interface (API) offers a way to use the capabilities of a service by using predefined functions. Use the API when the programming language you're using is not supported in an SDK. Please consider contributing that work to one of the
<a href="https://wiki.openstack.org/wiki/SDKs#Known_SDKs">
Known SDKs</a>. The <a href="http://docs.openstack.org/api/quick-start/content/">
OpenStack API Quick Start
</a> gives you the basics for interacting with the services.
</p>
<div class="span-24" id="api-docs">
<div class="span-8 last">
<dl>
<dt>
References
</dt>
<dd>
<a href="http://developer.openstack.org/api-ref-blockstorage-v2.html">
Block Storage v2
</a>
</dd>
<dd>
<a href="http://developer.openstack.org/api-ref-compute-v2.html">
Compute v2
</a>
</dd>
<!-- <dd>
<a href="https://">
Database Processing
</a>
</dd> -->
<dd>
<a href="http://developer.openstack.org/api-ref-databases-v1.html">
Database Service v1.0
</a>
</dd>
<dd>
<a href="http://developer.openstack.org/api-ref-identity-v3.html">
Identity Service v3
</a>
</dd>
<dd>
<a href="http://developer.openstack.org/api-ref-identity-v2.html">
Identity Service v2.0
</a>
</dd>
<dd>
<a href="http://developer.openstack.org/api-ref-image-v2.html">
Image Service v2
</a>
</dd>
<dd>
<a href="http://developer.openstack.org/api-ref-image-v1.html">
Image Service v1
</a>
</dd>
<dd>
<a href="http://developer.openstack.org/api-ref-networking-v2.html">
Networking v2.0
</a>
</dd>
<dd>
<a href="http://developer.openstack.org/api-ref-objectstorage-v1.html">
Object Storage v1
</a>
</dd>
<dd>
<a href="http://developer.openstack.org/api-ref-orchestration-v1.html">
Orchestration v1
</a>
</dd>
<dd>
<a href="http://developer.openstack.org/api-ref-telemetry-v2.html">
Telemetry
</a>
</dd>
</dl>
</div>
</div>
</div>
<!-- End Page Content -->
<div class="container">
<div id="footer">
<hr/>
<p>
Documentation treated like code, powered by the community - interested? Here's
<a href="http://wiki.openstack.org/Documentation/HowTo">
how to contribute
</a>
.
</p>
<p>
The OpenStack project is provided under the Apache 2.0 license. Openstack.org is powered by
<a href="http://www.rackspacecloud.com/">
Rackspace Cloud Computing
</a>
.
</p>
</div>
</div>
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.4.2/jquery.js" type="text/javascript">
</script>
<script charset="utf-8" src="/common/jquery/jquery.hoverIntent.minified.js" type="text/javascript">
</script>
<script charset="utf-8" type="text/javascript">
//<![CDATA[
$(document).ready(function() {
function addMenu(){
$(".dropDown").addClass("menuHover");
}
function removeMenu(){
$(".dropDown").removeClass("menuHover");
}
var menuConfig = {
interval: 500,
sensitivity: 4,
over: addMenu,
timeout: 500,
out: removeMenu
};
$(".dropDownTrigger").hoverIntent(menuConfig);
});
//]]>
</script>
</body>
</html>