openstack/openstack-manuals
Code Issues Proposed changes

Updating pom files to latest snapshot 1.0.8, updating API Quick Start

Browse Source 
Change-Id: I251ad9cd662010a2b64e35f81a69563fa0f9a097
This commit is contained in:
annegentle
2011-12-06 16:14:11 -06:00
parent 96a7e96dd4
commit beeb2bca8a
6 changed files with 67 additions and 54 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
doc/src/docbkx/api-quick-start/pom.xml
View File

@@ -49,7 +49,7 @@
<plugin>
<groupId>com.rackspace.cloud.api</groupId>
<artifactId>clouddocs-maven-plugin</artifactId>
<version>1.0.5-SNAPSHOT</version>
<version>1.0.8-SNAPSHOT</version>
<executions>
<execution>
<id>goal1</id>

81
doc/src/docbkx/api-quick-start/src/docbkx/api-examples.xml
View File

@@ -3,8 +3,7 @@
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
xml:id="Compute_API_Examples"
version="5.0"
>
version="5.0">
<title>OpenStack API Examples</title>
<para>Here are some examples of the basic API commands you can send to an OpenStack deployment
@@ -23,6 +22,43 @@
API requests. The following sections offer walk-throughs of common API commands. Refer to
<link xlink:href="http://docs.openstack.org/api">docs.openstack.org/api</link> for a
full reference of all API commands for these services.</para>
<para>Many of the APIs support query parameters. For example, to navigate the collection, the parameters limit and marker can be set in the URI. </para>
<variablelist>
<title>Query Parameters</title>
<varlistentry>
<term><code>limit</code></term>
<listitem>
<para>For an integer value <inlineequation>
<mathphrase><emphasis>n</emphasis></mathphrase>
</inlineequation>, limits the number of results to at most <inlineequation>
<mathphrase><emphasis>n</emphasis></mathphrase>
</inlineequation> values.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><code>marker</code></term>
<listitem>
<para>Given a string value <inlineequation>
<mathphrase><emphasis>x</emphasis></mathphrase>
</inlineequation>, return object names greater in value than the specified
marker.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><code>format</code></term>
<listitem>
<para>Specify either <code>json</code> or
<code>xml</code> to return the respective
serialized response. For example, append
<programlisting>?format=json</programlisting>onto
a query to inform the service that you want the
information serialized in JSON when it is returned
to you.</para>
</listitem>
</varlistentry>
</variablelist>
<para>At this time, a <code>prefix</code> query parameter is not supported at the account
level for Object Storage.</para>
<section xml:id="Compute-API-Server-Flavor-Examples-a10234">
@@ -180,42 +216,13 @@
<para>DELETE /images/1/members/tenant1 (revokes tenant's access to an image)</para></section>
<section xml:id="Identity-API-Examples"><title>Identity API Examples</title>
<para>POST /v2.0/tokens</para>
<para>GET /v2.0/tenants</para></section>
<programlisting>
curl -X 'POST' -v http://host.na.me:5000/v2.0/tokens -d '{"passwordCredentials":{"username": "joecool", "password":"coolword"}, "tenantId":"5"}' -H 'Content-type: application/json'
</programlisting>
</section>
<section xml:id="Object-API-Examples"><title>Object API Examples</title>
<variablelist>
<title>Query Parameters</title>
<varlistentry>
<term><code>limit</code></term>
<listitem>
<para>For an integer value <inlineequation>
<mathphrase><emphasis>n</emphasis></mathphrase>
</inlineequation>, limits the number of results to at most <inlineequation>
<mathphrase><emphasis>n</emphasis></mathphrase>
</inlineequation> values.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><code>marker</code></term>
<listitem>
<para>Given a string value <inlineequation>
<mathphrase><emphasis>x</emphasis></mathphrase>
</inlineequation>, return object names greater in value than the specified
marker.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><code>format</code></term>
<listitem>
<para>Specify either <code>json</code> or <code>xml</code> to return the
respective serialized response, for example append
<programlisting>?format=json</programlisting>onto a query to inform the
service that you want the information serialized in JSON when it is returned
to you.</para>
</listitem>
</varlistentry>
</variablelist>
<para>At this time, a <code>prefix</code> query parameter is not supported at the account
level.</para>
<section><title>Storage Account Services</title>
<para>GET /v1.0/&lt;account&gt;</para>
<para>HEAD /v1.0/&lt;account&gt;</para></section>

5
doc/src/docbkx/api-quick-start/src/docbkx/api-quick-start-book.xml
View File

@@ -6,6 +6,7 @@
xmlns:html="http://www.w3.org/1999/xhtml"
version="5.0"
xml:id="openstack-api-quick-start">
<?rax pdf.url="../openstack-api-quick-start-trunk.pdf"?>
<title>OpenStack API Quick Start</title>
<info>
<author>
@@ -24,8 +25,8 @@
</copyright>
<releaseinfo>Diablo</releaseinfo>
<productname>OpenStack Compute, Identity, and Image Services</productname>
<pubdate>2011-10-13</pubdate>
<legalnotice role="cc-by-sa">
<pubdate>2011-12-05</pubdate>
<legalnotice role="apache2">
<annotation>
<remark>Remaining licensing details are filled in by the template.</remark>
</annotation>

27
doc/src/docbkx/api-quick-start/src/docbkx/api-quick-start.xml
View File

@@ -4,21 +4,24 @@
xmlns:xlink="http://www.w3.org/1999/xlink"
xml:id="Compute_API_Quick_Start"
version="5.0">
<title>OpenStack API Quick Start</title>
<para>The OpenStack system has several key projects that are separate installations but can work
together depending on your cloud needs: OpenStack Compute, OpenStack Object Storage,
OpenStack Identity Service, and OpenStack Image Store. With a standalone OpenStack
installation, the OpenStack Compute, OpenStack Identity, and OpenStack Image Store projects
are all working together in the background of your installation. </para>
<para>The OpenStack system has several key projects that are
separate installations but can work together depending on your
cloud needs: OpenStack Compute, OpenStack Object Storage,
OpenStack Identity Service, and OpenStack Image Store.
<!--With a standalone OpenStack installation, the OpenStack Compute, OpenStack Identity, and OpenStack Image Store projects are all working together in the background of your installation. --></para>
<section xml:id="Openstack-API-Concepts-a09234">
<title>OpenStack API Introduction</title>
<para>This page covers the basics for talking to your OpenStack cloud through the Compute API
after authorizing with the Identity Service API. You can then build a cloud by launching
images and assigning metadata to instances, all through the API. For an API reference of
all the possible commands, see the OpenStack Compute API 1.1 specification and the
Identity Service 2.0 Developer Guide published at <link xlink:href="http://docs.openstack.org">docs.openstack.org</link>. </para></section>
<para>This page covers the basics for talking to your OpenStack
cloud through the Compute API after authorizing with the
Identity Service API. You can then build a cloud by
launching images and assigning metadata to instances, all
through the API. For an API reference of all the possible
commands, see the <link xlink:href="http://docs.openstack.org/api/openstack-compute/1.1/content/">OpenStack Compute API 1.1 specification</link>
and the <link xlink:href="http://docs.openstack.org/api/openstack-identity-service/2.0/content/">Identity Service 2.0 specification</link> published at
<link xlink:href="http://docs.openstack.org/api"
>docs.openstack.org/api</link>. </para></section>
<section xml:id="Getting-Credentials-a00665"><title>Getting Credentials</title><para>Credentials are a combination of your username, password, and what tenant (or project) your
cloud is running under. You only need to generate an additional token if you are
interacting with your cloud directly with API endpoints, and not with a client. Your
@@ -32,7 +35,7 @@
administrator gave you, typically http://hostname:5000/v2.0/tokens. You send your
username, password, and what group you are with (the "tenant" in auth-speak). </para>
<para><programlisting>
$ curl -X 'POST' -v http://host.na.me:5000/v2.0/tokens -d '{"auth":{"passwordCredentials":{"username": "joecool", "password":"coolword"}, "tenantId":"5"}}' -H 'Content-type: application/json'
curl -X 'POST' -v http://host.na.me:5000/v2.0/tokens -d '{"passwordCredentials":{"username": "joecool", "password":"coolword"}, "tenantId":"5"}' -H 'Content-type: application/json'
</programlisting></para></listitem>
<listitem><para>The server returns a response in which the 24-hours token is contained :
<programlisting>

3
doc/src/docbkx/openstack-compute-admin/pom.xml
View File

@@ -50,7 +50,7 @@
<plugin>
<groupId>com.rackspace.cloud.api</groupId>
<artifactId>clouddocs-maven-plugin</artifactId>
<version>1.0.5-SNAPSHOT</version>
<version>1.0.8-SNAPSHOT</version>
<executions>
<execution>
<id>goal1</id>
@@ -133,6 +133,7 @@
<includes>
os-compute-adminguide.xml
</includes>
<canonicalUrlBase>http://docs.openstack.org/trunk/openstack-compute/admin/content/</canonicalUrlBase>
<profileSecurity>reviewer</profileSecurity>
<branding>openstack</branding>
</configuration>

3
doc/src/docbkx/openstack-object-storage-admin/pom.xml
View File

@@ -50,7 +50,7 @@
<plugin>
<groupId>com.rackspace.cloud.api</groupId>
<artifactId>clouddocs-maven-plugin</artifactId>
<version>1.0.5-SNAPSHOT</version>
<version>1.0.8-SNAPSHOT</version>
<executions>
<execution>
<id>goal1</id>
@@ -134,6 +134,7 @@
<includes>
os-objectstorage-adminguide.xml
</includes>
<canonicalUrlBase>http://docs.openstack.org/api/openstack-object-storage/admin/content/</canonicalUrlBase>
<profileSecurity>reviewer</profileSecurity>
<branding>openstack</branding>
</configuration>