Initial verion of API specification

This commit is contained in:
tengqm 2015-01-07 21:48:46 +08:00
parent d847bbdb13
commit f2b8929c16
53 changed files with 2970 additions and 0 deletions

139
doc/api-site/README.rst Normal file
View File

@ -0,0 +1,139 @@
API-Site repository
+++++++++++++++++++
This repository contains documentation for the OpenStack project.
For more details, see the `OpenStack Documentation wiki page
<http://wiki.openstack.org/Documentation>`_.
It includes these pages and PDFs:
* API Quick Start
* API Complete Reference (web pages)
* API Reference PDFs
* API Guide (in progress)
In addition to these, this repository contains:
* developer.openstack.org: ``www``
Prerequisites
=============
`Apache Maven <http://maven.apache.org/>`_ must be installed to build the
documentation.
To install Maven 3 for Ubuntu 12.04 and later,and Debian wheezy and later::
apt-get install maven
On Fedora 20 and later::
yum install maven
Build and update API docs
=========================
For more details about the Gerrit workflow, see `Gerrit Workflow <http://docs.openstack.org/infra/manual/developers.html#development-workflow>`_.
To build and updates any of the API documents:
#. Open a Terminal window.
#. Change into a directory where you want to clone api-site.
#. Run this command to clone openstack/api-site::
git clone https://github.com/openstack/api-site
#. CD into the api-site directory.
#. Run these commands to ensure you have the latest changes::
git remote update
git checkout master
git pull origin master
#. To checkout a new branch::
git checkout -b "*my_branch*"
Otherwise, to checkout an existing review::
git review d change-number /* where change-number is the change number of the review
#. Make your changes.
#. Run this command to build the docs locally::
mvn clean generate-sources
#. To check in your changes, see `Gerrit Workflow <http://docs.openstack.org/infra/manual/developers.html#development-workflow>`_.
- The root of the generated HTML (API site) documentation is::
api-site/api-ref/target/docbkx/html/api-ref.html
- The root of the generated API guide (in progress) is::
api-site/api-guide/target/docbkx/webhelp/api-guide/index.html
- The generated PDFs for the API pages are at::
api-site/api-ref-guides/target/docbkx/pdf/*.pdf
- The root of the API quick start is at::
api-site/api-quick-start/target/docbkx/webhelp/api-quick-start-onepager-external/api-quick-start-onepager.pdf
Run tests
=========
Install the python tox package and run ``tox`` from the top-level
directory to use the same tests that are done as part of our Jenkins
gating jobs.
If you like to run individual tests, run:
* ``tox -e checkniceness`` - to run the niceness tests
* ``tox -e checksyntax`` - to run syntax checks
* ``tox -e checkdeletions`` - to check that no deleted files are referenced
* ``tox -e checkbuild`` - to actually build the manual
tox will use the `openstack-doc-tools package
<https://github.com/openstack/openstack-doc-tools>`_ for execution of
these tests. openstack-doc-tools has a requirement on maven for the
build check.
Contribute
==========
Our community welcomes all people interested in open source cloud
computing, and encourages you to join the `OpenStack Foundation
<http://www.openstack.org/join>`_.
The best way to get involved with the community is to talk with others online
or at a meetup and offer contributions through our processes, the `OpenStack
wiki <http://wiki.openstack.org>`_, blogs, or on IRC at ``#openstack``
on ``irc.freenode.net``.
We welcome all types of contributions, from blueprint designs to documentation
to testing to deployment scripts.
If you would like to contribute to the documents, please see the
`Documentation HowTo <https://wiki.openstack.org/wiki/Documentation/HowTo>`_.
Bugs
====
Bugs should be filed on Launchpad, and not GitHub:
https://bugs.launchpad.net/openstack-api-site/
Install
=======
See `OpenStack <http://www.openstack.org/>`_ to learn more about the OpenStack project.

View File

@ -0,0 +1,87 @@
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<parent>
<groupId>org.openstack.docs</groupId>
<artifactId>parent-pom</artifactId>
<version>1.0.0-SNAPSHOT</version>
<relativePath>../pom.xml</relativePath>
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>openstack-api-ref-guides</artifactId>
<packaging>jar</packaging>
<name>OpenStack API Complete Reference Guides</name>
<properties>
<!-- This is set by Jenkins according to the branch. -->
<release.path.name>local</release.path.name>
<comments.enabled>0</comments.enabled>
</properties>
<!-- ################################################ -->
<!-- USE "mvn clean generate-sources" to run this POM -->
<!-- ################################################ -->
<build>
<!--
Setting the source and resource directories is not required for building the
project, but it provides certain IDEs with information necessary to show the
proper folder structure when the pom.xml is opened as a project.
-->
<sourceDirectory>src</sourceDirectory>
<resources>
<resource>
<directory>locale</directory>
</resource>
</resources>
<plugins>
<plugin>
<groupId>com.rackspace.cloud.api</groupId>
<artifactId>clouddocs-maven-plugin</artifactId>
<!-- version is set in ../pom.xml file -->
<executions>
<!-- Configuration for OpenStack API Guide -->
<execution>
<id>os-api-ref</id>
<goals>
<goal>generate-pdf</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<includes> bk-api-ref.xml </includes>
<pdfFilenameBase>api-ref</pdfFilenameBase>
</configuration>
</execution>
<execution>
<id>os-api-ref-clustering-v1</id>
<goals>
<goal>generate-pdf</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<includes> bk-api-ref-clustering-v1.xml </includes>
<pdfFilenameBase>api-ref-clustering-v1</pdfFilenameBase>
</configuration>
</execution>
</executions>
<configuration>
<webhelpDirname>api-ref-guides</webhelpDirname>
<generateToc> appendix toc,title
article/appendix nop
article toc,title
book toc,title
part toc,title
qandadiv toc
qandaset to
reference toc,title
set toc,title</generateToc>
<xincludeSupported>true</xincludeSupported>
<sourceDirectory>src</sourceDirectory>
<branding>openstack</branding>
<trimWadlUriCount>1</trimWadlUriCount>
<showXslMessages>true</showXslMessages>
<highlightSource>false</highlightSource>
<security>external</security>
<suppressFooterNavigation>0</suppressFooterNavigation>
</configuration>
</plugin>
</plugins>
</build>
</project>

View File

@ -0,0 +1,35 @@
<?xml version="1.0" encoding="UTF-8"?>
<book xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:linkend="http://www.w3.org/1999/linkend"
xmlns:xref="http://www.w3.org/1999/xref"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
version="5.0-extension RackBook-2.0"
xml:id="api.openstack.org-clustering-pdf">
<info>
<title>OpenStack Clustering API v1 Reference</title>
<titleabbrev>Clustering API Reference</titleabbrev>
<author>
<personname>
<firstname/>
<surname/>
</personname>
<affiliation>
<orgname>OpenStack Foundation</orgname>
</affiliation>
</author>
<copyright>
<year>2010-2014</year>
<holder>OpenStack Foundation</holder>
</copyright>
<productname>OpenStack Orchestration</productname>
<pubdate/>
<legalnotice role="apache2">
<annotation>
<remark>Copyright details are filled in by the template.</remark>
</annotation>
</legalnotice>
</info>
<xi:include href="../../api-ref/src/docbkx/ch_clustering-v1.xml"/>
</book>

View File

@ -0,0 +1,37 @@
<?xml version="1.0" encoding="UTF-8"?>
<book xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:linkend="http://www.w3.org/1999/linkend"
xmlns:xref="http://www.w3.org/1999/xref"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
version="5.0-extension RackBook-2.0"
xml:id="api.openstack.org-pdf">
<info>
<title>OpenStack API Complete Reference</title>
<titleabbrev>API Complete Reference</titleabbrev>
<author>
<personname>
<firstname/>
<surname/>
</personname>
<affiliation>
<orgname>OpenStack Foundation</orgname>
</affiliation>
</author>
<copyright>
<year>2010-2014</year>
<holder>OpenStack Foundation</holder>
</copyright>
<productname>OpenStack</productname>
<pubdate/>
<legalnotice role="apache2">
<annotation>
<remark>Copyright details are filled in by the
template.</remark>
</annotation>
</legalnotice>
</info>
<!-- <xi:include href="preface.xml"/>-->
<xi:include href="../../api-ref/src/docbkx/ch_clustering-v1.xml"/>
</book>

View File

@ -0,0 +1,27 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE preface[
<!-- Some useful entities borrowed from HTML -->
<!ENTITY nbsp "&#160;">
]>
<preface xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:linkend="http://www.w3.org/1999/linkend"
xmlns:xref="http://www.w3.org/1999/xref"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
version="5.0-extension RackBook-2.0" xml:id="Overview">
<title>Preface</title>
<para>Use the OpenStack APIs and extensions in your OpenStack cloud.</para>
<xi:include href="../../api-ref/src/docbkx/itemizedlist-service-list.xml"/>
<para>You must install the packages for each API separately. After
you authenticate through the <link
xlink:href="api-ref-identity.html">Identity API</link>,
you can use the other APIs and extensions to launch server
instances, create images, assign metadata to instances and
images, create containers and objects, and complete other
actions in your OpenStack cloud. To get started with the APIs,
see the <link
xlink:href="http://docs.openstack.org/api/quick-start/content/"
>OpenStack API Quick Start</link>.</para>
<para>&nbsp;</para>
</preface>

3
doc/api-site/api-ref/.gitignore vendored Normal file
View File

@ -0,0 +1,3 @@
*.bak
*.DS_Store
target/

View File

View File

@ -0,0 +1,91 @@
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<!-- POM Build file for api.openstack.org/api-ref.html -->
<!-- ################################################ -->
<!-- USE "mvn clean generate-sources" to run this POM -->
<!-- ################################################ -->
<parent>
<groupId>org.openstack.docs</groupId>
<artifactId>parent-pom</artifactId>
<version>1.0.0-SNAPSHOT</version>
<relativePath>../pom.xml</relativePath>
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>openstack-api-ref</artifactId>
<packaging>jar</packaging>
<name>OpenStack API Complete Reference</name>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>
<build>
<!--
Setting the source and resource directories is not required for building the
project, but it provides certain IDEs with information necessary to show the
proper folder structure when the pom.xml is opened as a project.
-->
<sourceDirectory>src</sourceDirectory>
<resources>
<resource>
<directory>locale</directory>
</resource>
</resources>
<plugins>
<plugin>
<groupId>com.rackspace.cloud.api</groupId>
<artifactId>clouddocs-maven-plugin</artifactId>
<!-- version is set in ../pom.xml file -->
<executions>
<execution>
<id>os-api-ref</id>
<goals>
<goal>generate-html</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<includes>api-ref.xml</includes>
<pdfFilename>bk-api-ref</pdfFilename>
</configuration>
</execution>
<execution>
<id>os-api-ref-clustering-v1</id>
<goals>
<goal>generate-html</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<includes>api-ref-clustering-v1.xml</includes>
<pdfFilename>bk-api-ref-clustering-v1</pdfFilename>
</configuration>
</execution>
<!-- Configuration for OpenStack API References (pdf) -->
<!-- see ../api-ref-guides/pom.xml -->
</executions>
<configuration>
<!-- These parameters apply to pdf and webhelp -->
<generateToc> appendix toc,title
article/appendix nop
article toc,title
book toc,title
chapter toc,title
section toc,title
part toc,title
qandadiv toc
qandaset toc
reference toc,title
set toc,title</generateToc>
<xincludeSupported>true</xincludeSupported>
<sourceDirectory>src/docbkx</sourceDirectory>
<branding>openstack</branding>
<trimWadlUriCount>1</trimWadlUriCount>
<showXslMessages>true</showXslMessages>
<profileSecurity>reviewer</profileSecurity>
<highlightSource>false</highlightSource>
<enableGoogleAnalytics>1</enableGoogleAnalytics>
<googleAnalyticsId>UA-17511903-1</googleAnalyticsId>
</configuration>
</plugin>
</plugins>
</build>
</project>

View File

@ -0,0 +1,23 @@
<?xml version="1.0" encoding="UTF-8"?>
<book xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:linkend="http://www.w3.org/1999/linkend"
xmlns:xref="http://www.w3.org/1999/xref"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
version="5.0-extension RackBook-2.0"
xml:id="api.openstack.org-clustering" status="CURRENT">
<info xreflabel="api-ref-clustering.html">
<title>OpenStack Orchestration API v1</title>
<copyright>
<year>2010-2014</year>
</copyright>
<legalnotice role="apache2">
<para/>
</legalnotice>
<annotation>
<xi:include href="itemizedlist-service-list.xml"/>
</annotation>
</info>
<xi:include href="ch_clustering-v1.xml"/>
</book>

View File

@ -0,0 +1,23 @@
<?xml version="1.0" encoding="UTF-8"?>
<book xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:linkend="http://www.w3.org/1999/linkend"
xmlns:xref="http://www.w3.org/1999/xref"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:id="api.openstack.org">
<!-- version="5.0-extension RackBook-2.0" -->
<info xreflabel="api-ref-identity-v3.html">
<title>OpenStack API Reference</title>
<copyright>
<year>2010-2014</year>
</copyright>
<legalnotice role="apache2">
<para/>
</legalnotice>
<annotation>
<xi:include href="itemizedlist-service-list.xml"/>
</annotation>
</info>
<xi:include href="preface.xml"/>
</book>

View File

@ -0,0 +1,159 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:linkend="http://www.w3.org/1999/linkend"
xmlns:xref="http://www.w3.org/1999/xref"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
version="5.0-extension RackBook-2.0" xml:id="clustering-v1">
<title>Clustering API v1 (CURRENT)</title>
<para>Clustering service for OpenStack.</para>
<section xml:id="senlin-versions">
<title>API versions</title>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/clustering-api/src/v1/clustering-api.wadl#versions">
<wadl:method href="#getVersions-senlin-v1"/>
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="profile_types">
<title>Profile Types</title>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/clustering-api/src/v1/clustering-api.wadl#profile_types">
<wadl:method href="#profile_type_list"/>
</wadl:resource>
<wadl:resource href="../wadls/clustering-api/src/v1/clustering-api.wadl#profile_schema">
<wadl:method href="#profile_type_get"/>
</wadl:resource>
<wadl:resource href="../wadls/clustering-api/src/v1/clustering-api.wadl#profile_template">
<wadl:method href="#profile_type_template"/>
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="profiles">
<title>Profiles</title>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/clustering-api/src/v1/clustering-api.wadl#pofiles">
<wadl:method href="#profile_list"/>
<wadl:method href="#profile_create"/>
</wadl:resource>
<wadl:resource href="../wadls/clustering-api/src/v1/clustering-api.wadl#profile_id">
<wadl:method href="#profile_get"/>
<wadl:method href="#profile_update"/>
<wadl:method href="#profile_delete"/>
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="policy_types">
<title>Policy Types</title>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/clustering-api/src/v1/clustering-api.wadl#policy_types">
<wadl:method href="#policy_type_list"/>
</wadl:resource>
<wadl:resource href="../wadls/clustering-api/src/v1/clustering-api.wadl#policy_schema">
<wadl:method href="#policy_type_get"/>
</wadl:resource>
<wadl:resource href="../wadls/clustering-api/src/v1/clustering-api.wadl#policy_template">
<wadl:method href="#policy_type_template"/>
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="policies">
<title>Policies</title>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/clustering-api/src/v1/clustering-api.wadl#policies">
<wadl:method href="#policy_list"/>
<wadl:method href="#policy_create"/>
</wadl:resource>
<wadl:resource href="../wadls/clustering-api/src/v1/clustering-api.wadl#policy_id">
<wadl:method href="#policy_get"/>
<wadl:method href="#policy_update"/>
<wadl:method href="#policy_delete"/>
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="clusters">
<title>Clusters</title>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/clustering-api/src/v1/clustering-api.wadl#clusters">
<wadl:method href="#cluster_list"/>
<wadl:method href="#cluster_create"/>
</wadl:resource>
<wadl:resource href="../wadls/clustering-api/src/v1/clustering-api.wadl#cluster_id">
<wadl:method href="#cluster_get"/>
<wadl:method href="#cluster_update"/>
<wadl:method href="#cluster_delete"/>
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="nodes">
<title>Nodes</title>
<para>Manages node colections.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/clustering-api/src/v1/clustering-api.wadl#nodes">
<wadl:method href="#node_list"/>
<wadl:method href="#node_create"/>
</wadl:resource>
<wadl:resource href="../wadls/clustering-api/src/v1/clustering-api.wadl#node_id">
<wadl:method href="#node_get"/>
<wadl:method href="#node_update"/>
<wadl:method href="#node_delete"/>
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="cluster_nodes">
<title>Cluster Nodes</title>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/clustering-api/src/v1/clustering-api.wadl#cluster_nodes">
<wadl:method href="#cluster_add_node"/>
</wadl:resource>
<wadl:resource href="../wadls/clustering-api/src/v1/clustering-api.wadl#cluster_node_id">
<wadl:method href="#cluster_del_node"/>
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="cluster_policies">
<title>Cluster Policies</title>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/clustering-api/src/v1/clustering-api.wadl#cluster_policies">
<wadl:method href="#cluster_list_policy"/>
<wadl:method href="#cluster_attach_policy"/>
</wadl:resource>
<wadl:resource href="../wadls/clustering-api/src/v1/clustering-api.wadl#cluster_policy_id">
<wadl:method href="#cluster_detach_policy"/>
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="actions">
<title>Actions</title>
<para>Examine data and status of actions.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/clustering-api/src/v1/clustering-api.wadl#actions">
<wadl:method href="#action_list"/>
</wadl:resource>
<wadl:resource href="../wadls/clustering-api/src/v1/clustering-api.wadl#action_id">
<wadl:method href="#action_get"/>
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="events">
<title>Events</title>
<para>Examine data and status of events.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/clustering-api/src/v1/clustering-api.wadl#events">
<wadl:method href="#event_list"/>
</wadl:resource>
<wadl:resource href="../wadls/clustering-api/src/v1/clustering-api.wadl#event_id">
<wadl:method href="#event_get"/>
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="build-info">
<title>Build info</title>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/clustering-api/src/v1/clustering-api.wadl#build_info">
<wadl:method href="#build_info_show"/>
</wadl:resource>
</wadl:resources>
</section>
</chapter>

View File

@ -0,0 +1,161 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:linkend="http://www.w3.org/1999/linkend"
xmlns:xref="http://www.w3.org/1999/xref"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
version="5.0-extension RackBook-2.0" xml:id="clustering-v1">
<title>Clustering API v1 (CURRENT)</title>
<para>Clustering service for OpenStack.</para>
<section xml:id="senlin-versions">
<title>API versions</title>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/clustering-api/src/v1/clustering-api.wadl#versions">
<wadl:method href="#getVersions-senlin-v1"/>
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="profile_types">
<title>Profile Types</title>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/clustering-api/src/v1/clustering-api.wadl#profile_types">
<wadl:method href="#profile_type_list"/>
</wadl:resource>
<wadl:resource href="../wadls/clustering-api/src/v1/clustering-api.wadl#profile_schema">
<wadl:method href="#profile_type_get"/>
</wadl:resource>
<wadl:resource href="../wadls/clustering-api/src/v1/clustering-api.wadl#profile_template">
<wadl:method href="#profile_type_template"/>
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="profiles">
<title>Profiles</title>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/clustering-api/src/v1/clustering-api.wadl#profiles">
<wadl:method href="#profile_list"/>
<wadl:method href="#profile_create"/>
</wadl:resource>
<wadl:resource href="../wadls/clustering-api/src/v1/clustering-api.wadl#profile_id">
<wadl:method href="#profile_get"/>
<wadl:method href="#profile_update"/>
<wadl:method href="#profile_delete"/>
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="policy_types">
<title>Policy Types</title>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/clustering-api/src/v1/clustering-api.wadl#policy_types">
<wadl:method href="#policy_type_list"/>
</wadl:resource>
<wadl:resource href="../wadls/clustering-api/src/v1/clustering-api.wadl#policy_schema">
<wadl:method href="#policy_type_get"/>
</wadl:resource>
<wadl:resource href="../wadls/clustering-api/src/v1/clustering-api.wadl#policy_template">
<wadl:method href="#policy_type_template"/>
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="policies">
<title>Policies</title>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/clustering-api/src/v1/clustering-api.wadl#policies">
<wadl:method href="#policy_list"/>
<wadl:method href="#policy_create"/>
</wadl:resource>
<wadl:resource href="../wadls/clustering-api/src/v1/clustering-api.wadl#policy_id">
<wadl:method href="#policy_get"/>
<wadl:method href="#policy_update"/>
<wadl:method href="#policy_delete"/>
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="clusters">
<title>Clusters</title>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/clustering-api/src/v1/clustering-api.wadl#clusters">
<wadl:method href="#cluster_list"/>
<wadl:method href="#cluster_create"/>
</wadl:resource>
<wadl:resource href="../wadls/clustering-api/src/v1/clustering-api.wadl#cluster_id">
<wadl:method href="#cluster_get"/>
<wadl:method href="#cluster_update"/>
<wadl:method href="#cluster_delete"/>
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="nodes">
<title>Nodes</title>
<para>Manages node colections.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/clustering-api/src/v1/clustering-api.wadl#nodes">
<wadl:method href="#node_list"/>
<wadl:method href="#node_create"/>
</wadl:resource>
<wadl:resource href="../wadls/clustering-api/src/v1/clustering-api.wadl#node_id">
<wadl:method href="#node_get"/>
<wadl:method href="#node_update"/>
<wadl:method href="#node_delete"/>
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="cluster_nodes">
<title>Cluster Nodes</title>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/clustering-api/src/v1/clustering-api.wadl#cluster_nodes">
<wadl:method href="#cluster_add_node"/>
</wadl:resource>
<wadl:resource href="../wadls/clustering-api/src/v1/clustering-api.wadl#cluster_node_id">
<wadl:method href="#cluster_get_node"/>
<wadl:method href="#cluster_del_node"/>
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="cluster_policies">
<title>Cluster Policies</title>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/clustering-api/src/v1/clustering-api.wadl#cluster_policies">
<wadl:method href="#cluster_list_policies"/>
<wadl:method href="#cluster_attach_policy"/>
</wadl:resource>
<wadl:resource href="../wadls/clustering-api/src/v1/clustering-api.wadl#cluster_policy_id">
<wadl:method href="#cluster_get_policy"/>
<wadl:method href="#cluster_detach_policy"/>
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="actions">
<title>Actions</title>
<para>Examine data and status of actions.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/clustering-api/src/v1/clustering-api.wadl#actions">
<wadl:method href="#action_list"/>
</wadl:resource>
<wadl:resource href="../wadls/clustering-api/src/v1/clustering-api.wadl#action_id">
<wadl:method href="#action_get"/>
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="events">
<title>Events</title>
<para>Examine data and status of events.</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/clustering-api/src/v1/clustering-api.wadl#events">
<wadl:method href="#event_list"/>
</wadl:resource>
<wadl:resource href="../wadls/clustering-api/src/v1/clustering-api.wadl#event_id">
<wadl:method href="#event_get"/>
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="build-info">
<title>Build info</title>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/clustering-api/src/v1/clustering-api.wadl#build_info">
<wadl:method href="#build_info_show"/>
</wadl:resource>
</wadl:resources>
</section>
</chapter>

View File

@ -0,0 +1,14 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE itemizedlist [
]>
<itemizedlist xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:linkend="http://www.w3.org/1999/linkend"
xmlns:xref="http://www.w3.org/1999/xref"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
version="5.0-extension RackBook-2.0" xml:id="service-list">
<listitem>
<para><link xlink:href="api-ref-clustering-v1.html">Clustering API v1 (CURRENT)</link></para>
</listitem>
</itemizedlist>

View File

@ -0,0 +1,39 @@
<?xml version="1.0" encoding="UTF-8"?>
<preface xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:linkend="http://www.w3.org/1999/linkend"
xmlns:xref="http://www.w3.org/1999/xref"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
version="5.0-extension RackBook-2.0" xml:id="Overview">
<title>OpenStack API Complete Reference</title>
<para>Use the OpenStack APIs and extensions to launch server
instances, create images, assign metadata to instances and
images, create containers and objects, and complete other
actions in your OpenStack cloud.</para>
<para>The API <emphasis role="bold">status</emphasis> reflects the
state of the endpoint on the service. <emphasis role="bold"
>CURRENT</emphasis> is a stable version that is
up-to-date, recent, and might receive future versions. This
endpoint should be prioritized over all others. <emphasis
role="bold">SUPPORTED</emphasis> is a stable version that
is available on the server. However, it is not likely the most
recent available and might not be updated or might be
deprecated at some time in the future. <emphasis role="bold"
>DEPRECATED</emphasis> is a stable version that is still
available but is being deprecated and might be removed in the
future. <emphasis role="bold">EXPERIMENTAL</emphasis> is not a
stable version. This version is under development or contains
features that are otherwise subject to change. For more
information about API <emphasis role="bold">status</emphasis>
values and version information, see <link
xlink:href="https://wiki.openstack.org/wiki/VersionDiscovery"
>Version Discovery</link>.</para>
<para>You must install the packages for each API separately. You
can use the APIs and extensions after you authenticate through
the <link xlink:href="api-ref-identity-v3.html">Identity
API</link>:</para>
<para>To get started with the APIs, see the <link
xlink:href="http://docs.openstack.org/api/quick-start/content/"
>OpenStack API Quick Start</link>.</para>
</preface>

View File

@ -0,0 +1,105 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="../../xslt/schema.xsl"?>
<xs:schema elementFormDefault="qualified" attributeFormDefault="unqualified"
targetNamespace="http://www.w3.org/2005/Atom"
xmlns:html="http://www.w3.org/1999/xhtml"
xmlns:atom="http://www.w3.org/2005/Atom"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
xmlns:xml="http://www.w3.org/XML/1998/namespace"
xmlns:xs="http://www.w3.org/2001/XMLSchema"
xsdxt:base="../..">
<xs:annotation>
<xs:appinfo
xml:lang="EN"
xmlns="http://www.w3.org/1999/xhtml">
<xsdxt:title>Atom Link</xsdxt:title>
</xs:appinfo>
<xs:documentation
xml:lang="EN"
xmlns="http://www.w3.org/1999/xhtml">
<p>
This schema file simple defines an atom link according
to <a
href="http://tools.ietf.org/html/rfc4287">RFC4287</a>
</p>
</xs:documentation>
</xs:annotation>
<xs:import namespace="http://www.w3.org/XML/1998/namespace" schemaLocation="xml.xsd"/>
<!-- Common Link Relations -->
<xs:simpleType name="relation">
<xs:restriction base="xs:string">
<xs:enumeration value="alternate" />
<xs:enumeration value="appendix" />
<xs:enumeration value="archives" />
<xs:enumeration value="author" />
<xs:enumeration value="bookmark" />
<xs:enumeration value="chapter" />
<xs:enumeration value="contents" />
<xs:enumeration value="copyright" />
<xs:enumeration value="current" />
<xs:enumeration value="describedby" />
<xs:enumeration value="edit" />
<xs:enumeration value="edit-media" />
<xs:enumeration value="first" />
<xs:enumeration value="glossary" />
<xs:enumeration value="help" />
<xs:enumeration value="hub" />
<xs:enumeration value="icon" />
<xs:enumeration value="index" />
<xs:enumeration value="last" />
<xs:enumeration value="latest-version" />
<xs:enumeration value="license" />
<xs:enumeration value="monitor" />
<xs:enumeration value="monitor-group" />
<xs:enumeration value="next" />
<xs:enumeration value="next-arvhice" />
<xs:enumeration value="nofollow" />
<xs:enumeration value="payment" />
<xs:enumeration value="predecessor-version" />
<xs:enumeration value="prefetch" />
<xs:enumeration value="prev" />
<xs:enumeration value="previous" />
<xs:enumeration value="prev-archive" />
<xs:enumeration value="replies" />
<xs:enumeration value="search" />
<xs:enumeration value="section" />
<xs:enumeration value="self" />
<xs:enumeration value="service" />
<xs:enumeration value="start" />
<xs:enumeration value="stylesheet" />
<xs:enumeration value="subsection" />
<xs:enumeration value="successor-version" />
<xs:enumeration value="up" />
<xs:enumeration value="version-history" />
<xs:enumeration value="via" />
<xs:enumeration value="working-copy" />
<xs:enumeration value="working-copy-of" />
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="extRelation">
<xs:union memberTypes="atom:relation xs:string"/>
</xs:simpleType>
<xs:element name="link" type="atom:link" />
<xs:complexType name="link">
<xs:annotation>
<xs:documentation>
<html:p>See section 3.4 of the ATOM RFC <html:a href="http://tools.ietf.org/html/rfc4287">RFC4287</html:a></html:p>
</xs:documentation>
</xs:annotation>
<xs:attribute name="rel" use="required" type="atom:extRelation" />
<xs:attribute name="type" use="optional" type="xs:string" />
<xs:attribute name="href" use="required" type="xs:anyURI" />
<xs:attribute name="hreflang" use="optional" type="xs:NMTOKEN" />
<xs:attribute name="title" use="optional" type="xs:string" />
<xs:attribute ref="xml:base" />
<xs:attribute ref="xml:lang" />
</xs:complexType>
</xs:schema>

View File

@ -0,0 +1,219 @@
<?xml version='1.0'?>
<?xml-stylesheet type="text/xsl" href="../../xslt/schema.xsl"?>
<xs:schema targetNamespace="http://www.w3.org/XML/1998/namespace"
xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" xsdxt:base="../..">
<xs:annotation>
<xs:appinfo xml:lang="EN" xmlns="http://www.w3.org/1999/xhtml">
<xsdxt:title>The XML Namespace</xsdxt:title>
</xs:appinfo>
<xs:documentation>
<div>
<h1>About the XML namespace</h1>
<div class="bodytext">
<p>This schema document describes the XML namespace, in a form
suitable for import by other schema documents.</p>
<p>See <a href="http://www.w3.org/XML/1998/namespace.html">
http://www.w3.org/XML/1998/namespace.html</a> and <a
href="http://www.w3.org/TR/REC-xml">
http://www.w3.org/TR/REC-xml</a> for information about this
namespace.</p>
<p>Note that local names in this namespace are intended to be
defined only by the World Wide Web Consortium or its subgroups.
The names currently defined in this namespace are listed below.
They should not be used with conflicting semantics by any
Working Group, specification, or document instance.</p>
<p>See further below in this document for more information about
<a href="#usage">how to refer to this schema document from your
own XSD schema documents</a> and about <a href="#nsversioning"
>the namespace-versioning policy governing this schema
document</a>.</p>
</div>
</div>
</xs:documentation>
</xs:annotation>
<xs:attribute name="lang">
<xs:annotation>
<xs:documentation>
<div>
<h3>lang (as an attribute name)</h3>
<p>denotes an attribute whose value is a language code for the
natural language of the content of any element; its value is
inherited. This name is reserved by virtue of its definition in
the XML specification.</p>
</div>
<div>
<h4>Notes</h4>
<p>Attempting to install the relevant ISO 2- and 3-letter codes
as the enumerated possible values is probably not
a realistic possibility.</p>
<p>See BCP 47 at <a
href="http://www.rfc-editor.org/rfc/bcp/bcp47.txt">
http://www.rfc-editor.org/rfc/bcp/bcp47.txt</a> and the IANA
language sub tag registry at <a
href="http://www.iana.org/assignments/language-subtag-registry"
> http://www.iana.org/assignments/language-subtag-registry</a>
for further information.</p>
<p>The union allows for the 'un-declaration' of xml:lang with the
empty string.</p>
</div>
</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:union memberTypes="xs:language">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value=""/>
</xs:restriction>
</xs:simpleType>
</xs:union>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="space">
<xs:annotation>
<xs:documentation>
<div>
<h3>space (as an attribute name)</h3>
<p>denotes an attribute whose value is a keyword indicating what
whitespace processing discipline is intended for the content of
the element; its value is inherited. This name is reserved by
virtue of its definition in the XML specification.</p>
</div>
</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:NCName">
<xs:enumeration value="default"/>
<xs:enumeration value="preserve"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="base" type="xs:anyURI">
<xs:annotation>
<xs:documentation>
<div>
<h3>base (as an attribute name)</h3>
<p>denotes an attribute whose value provides a URI to be used as
the base for interpreting any relative URIs in the scope of the
element on which it appears; its value is inherited. This name
is reserved by virtue of its definition in the XML Base
specification.</p>
<p>See <a href="http://www.w3.org/TR/xmlbase/"
>http://www.w3.org/TR/xmlbase/</a> for information about this
attribute.</p>
</div>
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="id" type="xs:ID">
<xs:annotation>
<xs:documentation>
<div>
<h3>id (as an attribute name)</h3>
<p>denotes an attribute whose value should be interpreted as if
declared to be of type ID. This name is reserved by virtue of
its definition in the xml:id specification.</p>
<p>See <a href="http://www.w3.org/TR/xml-id/"
>http://www.w3.org/TR/xml-id/</a> for information about this
attribute.</p>
</div>
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attributeGroup name="specialAttrs">
<xs:attribute ref="xml:base"/>
<xs:attribute ref="xml:lang"/>
<xs:attribute ref="xml:space"/>
<xs:attribute ref="xml:id"/>
</xs:attributeGroup>
<xs:annotation>
<xs:documentation>
<div>
<h3>Father (in any context at all)</h3>
<div class="bodytext">
<p>denotes Jon Bosak, the chair of the original XML Working
Group. This name is reserved by the following decision of the
W3C XML Plenary and XML Coordination groups:</p>
<blockquote>
<p>In appreciation for his vision, leadership and dedication the
W3C XML Plenary on this 10th day of February, 2000, reserves
for Jon Bosak in perpetuity the XML name "xml:Father".</p>
</blockquote>
</div>
</div>
</xs:documentation>
</xs:annotation>
<xs:annotation>
<xs:documentation>
<div xml:id="usage" id="usage">
<h2><a name="usage">About this schema document</a></h2>
<div class="bodytext">
<p>This schema defines attributes and an attribute group suitable
for use by schemas wishing to allow <code>xml:base</code>,
<code>xml:lang</code>, <code>xml:space</code> or
<code>xml:id</code> attributes on elements they define.</p>
<p>To enable this, such a schema must import this schema for the
XML namespace, e.g. as follows:</p>
<pre>
&lt;schema . . .>
. . .
&lt;import namespace="http://www.w3.org/XML/1998/namespace"
schemaLocation="http://www.w3.org/2001/xml.xsd"/>
</pre>
<p>or</p>
<pre>
&lt;import namespace="http://www.w3.org/XML/1998/namespace"
schemaLocation="http://www.w3.org/2009/01/xml.xsd"/>
</pre>
<p>Subsequently, qualified reference to any of the attributes or
the following group has the desired effect. For example:</p>
<pre>
&lt;type . . .>
. . .
&lt;attributeGroup ref="xml:specialAttrs"/>
</pre>
<p>This defines a type that schema-validates an instance element
with any of those attributes.</p>
</div>
</div>
</xs:documentation>
</xs:annotation>
<xs:annotation>
<xs:documentation>
<div id="nsversioning" xml:id="nsversioning">
<h2><a name="nsversioning">Versioning policy for this schema
document</a></h2>
<div class="bodytext">
<p>In keeping with the XML Schema WG's standard versioning
policy, this schema document will persist at <a
href="http://www.w3.org/2009/01/xml.xsd">
http://www.w3.org/2009/01/xml.xsd</a>.</p>
<p>At the date of issue it can also be found at <a
href="http://www.w3.org/2001/xml.xsd">
http://www.w3.org/2001/xml.xsd</a>.</p>
<p>The schema document at that URI might change in the future to
remain compatible with the latest version of XML Schema itself,
or with the XML namespace itself. If the XML Schema or XML
namespaces changes, the version of this document at <a
href="http://www.w3.org/2001/xml.xsd">
http://www.w3.org/2001/xml.xsd </a> changes accordingly; the
version at <a href="http://www.w3.org/2009/01/xml.xsd">
http://www.w3.org/2009/01/xml.xsd </a> does not change.</p>
<p>Previous dated (and unchanging) versions of this schema
document are at:</p>
<ul>
<li><a href="http://www.w3.org/2009/01/xml.xsd">
http://www.w3.org/2009/01/xml.xsd</a></li>
<li><a href="http://www.w3.org/2007/08/xml.xsd">
http://www.w3.org/2007/08/xml.xsd</a></li>
<li><a href="http://www.w3.org/2004/10/xml.xsd">
http://www.w3.org/2004/10/xml.xsd</a></li>
<li><a href="http://www.w3.org/2001/03/xml.xsd">
http://www.w3.org/2001/03/xml.xsd</a></li>
</ul>
</div>
</div>
</xs:documentation>
</xs:annotation>
</xs:schema>

File diff suppressed because it is too large Load Diff

View File

@ -0,0 +1,25 @@
{
"action": {
"id": "dfb0e58c-955d-478e-a512-e8cb17e2d478",
"name": "node-create",
"context": {},
"target": "3c7faa4040-a110-2ecf-a92c-0474bfdf73",
"action": "NODE_CREATE",
"cause": "Cluster creation",
"owner": "admin",
"interval": 0,
"start_time": "",
"end_time": "",
"time_out": null,
"status": "RUNNING",
"status_reason": "",
"inputs": {
"profile_id": "9dc26f35-9c46-4d7a-88b4-a9ca3b0b68de",
"name": "node-001",
"timeout": 60
}
"outputs": {},
"depends_on": [],
"depended_by": [],
}
}

View File

@ -0,0 +1,27 @@
{
"actions": [
{
"id": "dfb0e58c-955d-478e-a512-e8cb17e2d478",
"name": "node-create",
"context": {},
"target": "3c7faa4040-a110-2ecf-a92c-0474bfdf73",
"action": "NODE_CREATE",
"cause": "Cluster creation",
"owner": "admin",
"interval": 0,
"start_time": "",
"end_time": "",
"time_out": null,
"status": "RUNNING",
"status_reason": "",
"inputs": {
"profile_id": "9dc26f35-9c46-4d7a-88b4-a9ca3b0b68de",
"name": "node-001",
"timeout": 60
}
"outputs": {},
"depends_on": [],
"depended_by": [],
}
]
}

View File

@ -0,0 +1,8 @@
{
"api": {
"revision": "{api_build_revision}"
},
"engine": {
"revision": "{engine_build_revision}"
}
}

View File

@ -0,0 +1,9 @@
{
"name": "testcluster",
"profile_id": "40be8d1a-3eb9-40de-8abd-43237517384f",
"size": 5,
"timeout": 60,
"tags": {
"owner": "Thomas",
}
}

View File

@ -0,0 +1,11 @@
{
"cluster": {
"id": "3095aefc-09fb-4bc7-b1f0-f21a304e864c",
"links": [
{
"href": "http://192.168.12.34:8778/v1/eb1c63a4f77141548385f113a28f0f52/clusters/3095aefc-09fb-4bc7-b1f0-f21a304e864c",
"rel": "self"
}
]
}
}

View File

@ -0,0 +1,13 @@
{
"node": {
"created_time": "2014-12-25T07:00:21Z",
"id": "7c4e1ef4-bf1b-41ab-a0c8-ce01f4ffdfa1",
"index": "1",
"name": "node-001",
"profile_id": "40be8d1a-3eb9-40de-8abd-43237517384f",
"role": null,
"status": "ACTIVE",
"status_reason": "Node created successfully",
"tags": {}
}
}

View File

@ -0,0 +1,8 @@
{
"policy": {
"policy_id": "ae83991b-6645-41c1-82c3-66be51a30c00",
"cooldown": 60,
"level": 50,
"enabled": true,
}
}

View File

@ -0,0 +1,19 @@
{
"cluster": {
"created_time": "2014-06-03T20:59:46Z",
"id": "3095aefc-09fb-4bc7-b1f0-f21a304e864c",
"links": [
{
"href": "http://192.168.12.34:8778/v1/eb1c63a4f77141548385f113a28f0f52/clusters/3095aefc-09fb-4bc7-b1f0-f21a304e864c",
"rel": "self"
}
],
"name": "test_cluster",
"profile_id": "40be8d1a-3eb9-40de-8abd-43237517384f",
"size": "5",
"status": "ACTIVE",
"status_reason": "Cluster created successfully",
"timeout_mins": "60",
"updated_time": ""
}
}

View File

@ -0,0 +1,26 @@
{
"nodes": [
{
"created_time": "2014-12-25T07:00:21Z",
"id": "7c4e1ef4-bf1b-41ab-a0c8-ce01f4ffdfa1",
"index": "1",
"name": "node-001",
"profile_id": "40be8d1a-3eb9-40de-8abd-43237517384f",
"role": null,
"status": "ACTIVE",
"status_reason": "Node created successfully",
"tags": {}
},
{
"created_time": "2014-12-25T07:02:34Z",
"id": "c81f4ff4-4e1e-41ab-80ca-cebdfa1f1b0f",
"index": "2",
"name": "node-002",
"profile_id": "40be8d1a-3eb9-40de-8abd-43237517384f",
"role": null,
"status": "ACTIVE",
"status_reason": "Node created successfully",
"tags": {}
},
],
}

View File

@ -0,0 +1,16 @@
{
"policies": [
{
"policy_id": "ae83991b-6645-41c1-82c3-66be51a30c00",
"cooldown": 60,
"level": 50,
"enabled": true,
},
{
"policy_id": "10098d53-0252-4853-8016-d88769011feb",
"cooldown": 60,
"level": 40,
"enabled": false,
},
],
}

View File

@ -0,0 +1,20 @@
{
"clusters": [
{
"created_time": "2014-06-03T20:59:46Z",
"id": "3095aefc-09fb-4bc7-b1f0-f21a304e864c",
"links": [
{
"href": "http://192.168.12.34:8778/v1/eb1c63a4f77141548385f113a28f0f52/stacks/3095aefc-09fb-4bc7-b1f0-f21a304e864c",
"rel": "self"
}
],
"name": "test_cluster",
"profile_id": "40be8d1a-3eb9-40de-8abd-43237517384f",
"size": 5,
"status": "ACTIVE",
"status_reason": "Cluster created successfully",
"updated_time": ""
}
]
}

View File

@ -0,0 +1,8 @@
{
"profile_id": "e8d140ba-40de-8abd-4323-3eb7384f9751",
"size": "6",
"tags": {
"new_key": "value",
}
"timeout": "60"
}

View File

@ -0,0 +1,22 @@
{
"events": [
{
"obj_name": "node-002",
"timestamp": "2014-07-23T08:10:22Z",
"obj_id": "3c7faa4040-a110-2ecf-a92c-0474bfdf73",
"obj_type": "NODE",
"level": "ERROR",
"status": "ERROR",
"status_reason": "Failed contacting Heat service endpoint",
},
{
"obj_name": "test_cluster",
"timestamp": "2014-07-23T08:14:47Z",
"obj_id": "474bfdf0-a450-46ec-a78a-0c7faa404073",
"obj_type": "CLUSTER",
"level": "ERROR",
"status": "ERROR",
"status_reason": "Only 2 nodes were ACTIVE before timeout",
},
]
}

View File

@ -0,0 +1,7 @@
{
"name": "node-254",
"cluster_id": "3095aefc-09fb-4bc7-b1f0-f21a304e864c",
"profile_id": "e8d140ba-40de-8abd-4323-3eb7384f9751",
"role": "Worker",
"tags": {},
}

View File

@ -0,0 +1,11 @@
{
"node": {
"id": "56e68239-13b2-4d4b-92f1-4ec472fd83bd",
"links": [
{
"href": "http://192.168.12.34:8778/v1/eb1c63a4f77141548385f113a28f0f52/nodes/56e68239-13b2-4d4b-92f1-4ec472fd83bd",
"rel": "self"
}
]
}
}

View File

@ -0,0 +1,34 @@
{
"nodes": [
{
"cluster_id": "3095aefc-09fb-4bc7-b1f0-f21a304e864c",
"created_time": "2014-12-25T07:00:21Z",
"id": "7c4e1ef4-bf1b-41ab-a0c8-ce01f4ffdfa1",
"index": 1,
"name": "node-001",
"physical_id": "dd06b8ae-93ba-45b1-a58e-521ff35341d8",
"profile_id": "40be8d1a-3eb9-40de-8abd-43237517384f",
"project": "ac21bddf-7f53-4bb9-903b-6453b21571ba",
"role": null,
"status": "ACTIVE",
"status_reason": "Node created successfully",
"tags": {},
"updated_time": ""
},
{
"cluster_id": "3095aefc-09fb-4bc7-b1f0-f21a304e864c",
"created_time": "2014-12-25T07:02:34Z",
"id": "c81f4ff4-4e1e-41ab-80ca-cebdfa1f1b0f",
"index": 2,
"name": "node-002",
"physical_id": "ae83991b-6645-41c1-82c3-66be51a30c00",
"profile_id": "40be8d1a-3eb9-40de-8abd-43237517384f",
"project": "ac21bddf-7f53-4bb9-903b-6453b21571ba",
"role": null,
"status": "ACTIVE",
"status_reason": "Node created successfully",
"tags": {},
"updated_time": ""
},
],
}

View File

@ -0,0 +1,6 @@
{
"name": "new_name",
"profile_id": "e8d140ba-40de-8abd-4323-3eb7384f9751",
"role": "Master"
}

View File

@ -0,0 +1,10 @@
{
"level": 50,
"name": "my_deletion_policy",
"spec": {
"criteria": "oldest_first",
"grace_period": 60,
"reduce_desired_capacity": false,
},
"type": "os.senlin.deletion_policy",
}

View File

@ -0,0 +1,11 @@
{
"policy": {
"id": "913e4dea-334e-4e1b-a7e0-507d3bd0271c",
"links": [
{
"href": "http://192.168.12.34:8778/v1/eb1c63a4f77141548385f113a28f0f52/policies/913e4dea-334e-4e1b-a7e0-507d3bd0271c",
"rel": "self"
}
]
}
}

View File

@ -0,0 +1,13 @@
{
"policy": {
"id": "913e4dea-334e-4e1b-a7e0-507d3bd0271c",
"level": 50,
"name": "my_deletion_policy",
"spec": {
"criteria": "oldest_first",
"grace_period": 60,
"reduce_desired_capacity": false,
},
"type": "os.senlin.deletion_policy",
}
}

View File

@ -0,0 +1,15 @@
{
"policies": [
{
"id": "913e4dea-334e-4e1b-a7e0-507d3bd0271c",
"level": 50,
"name": "my_deletion_policy",
"spec": {
"criteria": "oldest_first",
"grace_period": 60,
"reduce_desired_capacity": false,
},
"type": "os.senlin.deletion_policy",
}
]
}

View File

@ -0,0 +1,40 @@
{
"type": "os.senlin.deletion_policy",
"spec": {
"criteria": {
"description": "A string specifying how to select candidates for "
"deletion, can be one of 'oldest_first', "
"'youngest_first', 'random'",
"required": "True",
"type": "String",
},
"grace_period": {
"description": "Number of seconds before actual deletion",
"required": "False",
"type": "Number",
},
"reduce_desired_capacity": {
"description": "Whether to reduce the desired capacity of cluster",
"required": "False",
"type": "Bool",
},
},
"level": {
"description": "A string indicating enforcement level of the policy, "
"can be one of 'CRITICAL', 'ERROR', 'WARNING', 'INFO', "
" or 'DEBUG'",
"required": "False",
"type": "String",
},
"cooldown": {
"description": "An integer indicating enforcement level of the policy, can be one of 'CRITICAL', 'ERROR', 'WARNING', 'INFO' or 'DEBUG'",
"required": "False",
"type": "String",
},
"tags": {
"description": "A map of tag-values to attach to this profile.",
"required": "False",
"type": "Map",
}
}

View File

@ -0,0 +1,9 @@
{
"policy_types": [
"os.senlin.deletion_policy",
"os.senlin.health_policy",
"os.senlin.lb_policy",
"os.senlin.scaling_policy",
"os.senlin.placement_policy",
]
}

View File

@ -0,0 +1,12 @@
{
"policy": {
"level": 0,
"name": "",
"spec": {
"criteria": "oldest_first",
"grace_period": 0,
"reduce_desired_capacity": false,
},
"type": "os.senlin.deletion_policy",
}
}

View File

@ -0,0 +1,5 @@
{
"spec": {
"criteria": "youngest_first",
},
}

View File

@ -0,0 +1,39 @@
{
"name": "my_stack_profile",
"permission": "",
"spec": {
"context": {
"region_name": "RegionTwo",
},
"environment": {},
"files": {
"file1": "contents",
},
"parameters": {
"key_name": "JohnKey",
},
"template": {
"heat_template_version": "2014-10-16",
"parameters": {
"length": {
"type": "integer",
"default": "32",
},
},
"outputs": {
"random_value": {
"value": {
"get_attr": ["random1", "value"],
},
},
},
"resources": {
"random1": {
"type": "OS::Heat::RandomString",
},
},
},
}
"tags": {}
"type": "os.heat.stack",
}

View File

@ -0,0 +1,11 @@
{
"profile": {
"id": "9dc26f35-9c46-4d7a-88b4-a9ca3b0b68de",
"links": [
{
"href": "http://192.168.12.34:8778/v1/eb1c63a4f77141548385f113a28f0f52/profiles/9dc26f35-9c46-4d7a-88b4-a9ca3b0b68de",
"rel": "self"
}
]
}
}

View File

@ -0,0 +1,28 @@
{
"profile": {
"id": "9dc26f35-9c46-4d7a-88b4-a9ca3b0b68de",
"name": "my_stack_profile",
"type": "os.heat.stack",
"spec": {
"context": {
"region_name": "RegionTwo"
},
"environment": {}
"files": {}
"parameters": {
"key_name": "my_key"
},
"template": {
"heat_template_version": "2014-10-16",
"parameters": {}
"resources": {
"random1": {
"type": "OS::Heat::RandomString",
},
},
},
},
"permission": "",
"tags": {}
}
}

View File

@ -0,0 +1,30 @@
{
"profiles": [
{
"id": "9dc26f35-9c46-4d7a-88b4-a9ca3b0b68de",
"name": "my_stack_profile",
"type": "os.heat.stack",
"spec": {
"context": {
"region_name": "RegionTwo"
},
"environment": {}
"files": {}
"parameters": {
"key_name": "my_key"
},
"template": {
"heat_template_version": "2014-10-16",
"parameters": {}
"resources": {
"random1": {
"type": "OS::Heat::RandomString",
},
},
},
},
"permission": "",
"tags": {}
}
]
}

View File

@ -0,0 +1,40 @@
{
"type": "os.heat.stack",
"spec": {
"context": {
"description": "A map used for customizing stack context",
"required": "False",
"type": "Map",
},
"environment": {
"description": "A map providing additional settings for stack",
"required": "False",
"type": "Map",
},
"files": {
"description": "A map of name and contents used for stack operation",
"required": "False",
"type": "Map",
},
"parameters": {
"description": "A list of parameters for the template",
"required": "False",
"type": "List",
},
"template": {
"description": "Heat template to be used",
"required": "True",
"type": "Map",
},
},
"permission": {
"description": "A string reserved for permission checking.",
"required": "False",
"type": "String",
},
"tags": {
"description": "A map of tag-values to attach to this profile.",
"required": "False",
"type": "Map",
}
}

View File

@ -0,0 +1,7 @@
{
"profile_types": [
"os.heat.stack",
"os.heat.resource",
"os.nova.server"
]
}

View File

@ -0,0 +1,12 @@
{
"type": "os.heat.stack",
"spec": {
"context": {},
"environment": {},
"files": {},
"parameters": [],
"template": {}
},
"permission": "",
"tags": {}
}

View File

@ -0,0 +1,38 @@
{
"name": "my_stack_profile",
"permission": "",
"spec": {
"context": {
"region_name": "RegionTwo",
},
"environment": {},
"files": {
"file1": "new contents",
},
"parameters": {
"key_name": "JohnKey",
},
"template": {
"heat_template_version": "2014-10-16",
"parameters": {
"length": {
"type": "integer",
"default": "32",
},
},
"outputs": {
"random_value": {
"value": {
"get_attr": ["random1", "value"],
},
},
},
"resources": {
"random1": {
"type": "OS::Heat::RandomString",
},
},
},
}
"tags": {}
}

View File

@ -0,0 +1,6 @@
{
"metadata": {
"some_key": "some_value",
"some_other_key": "some_other_value"
}
}

View File

@ -0,0 +1,14 @@
{
"versions": [
{
"status": "CURRENT",
"id": "v1.0",
"links": [
{
"href": "http://192.168.12.34:8778/v1/",
"rel": "self"
}
]
}
]
}

44
doc/api-site/pom.xml Normal file
View File

@ -0,0 +1,44 @@
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>org.openstack.docs</groupId>
<artifactId>parent-pom</artifactId>
<version>1.0.0-SNAPSHOT</version>
<packaging>pom</packaging>
<modules>
<module>api-ref</module>
<module>api-ref-guides</module>
</modules>
<profiles>
<profile>
<id>Rackspace Research Repositories</id>
<activation>
<activeByDefault>true</activeByDefault>
</activation>
<repositories>
<repository>
<id>rackspace-research</id>
<name>Rackspace Research Repository</name>
<url>http://maven.research.rackspacecloud.com/content/groups/public/</url>
</repository>
</repositories>
<pluginRepositories>
<pluginRepository>
<id>rackspace-research</id>
<name>Rackspace Research Repository</name>
<url>http://maven.research.rackspacecloud.com/content/groups/public/</url>
</pluginRepository>
</pluginRepositories>
</profile>
</profiles>
<build>
<plugins>
<plugin>
<groupId>com.rackspace.cloud.api</groupId>
<artifactId>clouddocs-maven-plugin</artifactId>
<version>2.1.3</version>
</plugin>
</plugins>
</build>
</project>