openstack/api-site
Code Issues Proposed changes

Repair Data Processing API docs

Browse Source 
Some Data Processing sections were removed in this commit
(I22edf77b873ef6073043654d28e895140ee9774a). This
patchs returns these sections.

Also reorder sections in same way like in Sahara.

Change-Id: Ifc6aec2cd9f7ff7a1999d638ab69fcb28f7fcaa6
This commit is contained in:
Vitaly Gridnev 2015-04-06 14:29:18 +03:00
parent 2f51c7bf23
commit 301c30132b
2 changed files with 167 additions and 131 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

265
api-ref/src/docbkx/ch_data-processing-v1.1.xml
View File

@ -56,91 +56,6 @@
</wadl:resource> </wadl:resource>
</wadl:resources> </wadl:resources>
</section> </section>
<section xml:id="v1.1jobs">
<title>Jobs</title>
<para>
A job object lists the binaries that a job needs to run. To
run a job, you must specify data sources and job parameters.
</para>
<para>
You can run a job on an existing or new transient cluster.
</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/jobs.wadl#jobs">
<wadl:method href="#jobsList"/>
<wadl:method href="#jobCreate"/>
</wadl:resource>
<wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/jobs.wadl#jobId">
<wadl:method href="#jobInfo"/>
<wadl:method href="#jobDelete"/>
</wadl:resource>
<wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/jobs.wadl#execute">
<wadl:method href="#jobExecute"/>
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="v1.1jobtypes">
<title>Job types</title>
<para>
Each plugin that supports EDP also supports specific job types.
Different versions of a plugin might actually support different job
types. Configuration options vary by plugin, version, and
job type.
</para>
<para>
The job types provide information about which plugins support
which job types and how to configure the job types.
</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/job-types.wadl#job-types">
<wadl:method href="#jobTypesList"/>
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="v1.1jobexecutions">
<title>Job executions</title>
<para>
A job execution object represents a Hadoop job that runs on a
specified cluster. A job execution polls the status of a running
job and reports it to the user. Also a user can cancel a running job.
</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/job-executions.wadl#job-executions">
<wadl:method href="#job-executions-list"/>
</wadl:resource>
<wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/job-executions.wadl#job_execution_id">
<wadl:method href="#job-executions-show"/>
<wadl:method href="#job-executions-delete"/>
</wadl:resource>
<wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/job-executions.wadl#refresh-status">
<wadl:method href="#job-executions-refresh"/>
</wadl:resource>
<wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/job-executions.wadl#cancel">
<wadl:method href="#job-executions-cancel"/>
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="v1.1datasources">
<title>Data sources</title>
<para>
A data source object defines the location of input or output for
MapReduce jobs and might reference different types of storage.
</para>
<para>
The Data Processing service does not validate data source
locations.
</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/data-sources.wadl#data-sources">
<wadl:method href="#dataSourcesList"/>
<wadl:method href="#dataSourcesCreate"/>
</wadl:resource>
<wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/data-sources.wadl#dataSourceId">
<wadl:method href="#dataSourceInfo"/>
<wadl:method href="#dataSourceDelete"/>
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="v1.1nodegrouptemplate"> <section xml:id="v1.1nodegrouptemplate">
<title>Node group templates</title> <title>Node group templates</title>
<para> <para>
@ -165,6 +80,76 @@
</wadl:resource> </wadl:resource>
</wadl:resources> </wadl:resources>
</section> </section>
<section xml:id="v1.1clustertemplate">
<title>Cluster templates</title>
<para>
A cluster template configures a Hadoop cluster. A cluster template
lists node groups with the number of instances in each group. You
can also define cluster-scoped configurations in a cluster
template.
</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/cluster-templates.wadl#cluster-templates">
<wadl:method href="#cluster-templates-list"/>
<wadl:method href="#cluster-templates-create"/>
</wadl:resource>
<wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/cluster-templates.wadl#cluster_template_id">
<wadl:method href="#cluster-templates-show"/>
<wadl:method href="#cluster-templates-update"/>
<wadl:method href="#cluster-templates-delete"/>
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="v1.1clusters">
<title>Clusters</title>
<para>
A cluster is a group of nodes with the same configuration.
</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/clusters.wadl#clusters">
<wadl:method href="#clusters-list"/>
<wadl:method href="#clusters-create"/>
</wadl:resource>
<wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/clusters.wadl#cluster_id">
<wadl:method href="#clusters-get"/>
<wadl:method href="#clusters-delete"/>
<wadl:method href="#clusters-scale"/>
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="v1.1event-log">
<title>Event log</title>
<para>
The event log feature provides information about cluster provisioning.
In the event of errors, the event log shows the reason for the failure.
</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/event-log.wadl#cluster_id">
<wadl:method href="#show-progress"/>
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="v1.1datasources">
<title>Data sources</title>
<para>
A data source object defines the location of input or output for
MapReduce jobs and might reference different types of storage.
</para>
<para>
The Data Processing service does not validate data source
locations.
</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/data-sources.wadl#data-sources">
<wadl:method href="#dataSourcesList"/>
<wadl:method href="#dataSourcesCreate"/>
</wadl:resource>
<wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/data-sources.wadl#dataSourceId">
<wadl:method href="#dataSourceInfo"/>
<wadl:method href="#dataSourceDelete"/>
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="v1.1jobbinary-internals"> <section xml:id="v1.1jobbinary-internals">
<title>Job binary internals</title> <title>Job binary internals</title>
<para> <para>
@ -188,44 +173,88 @@
</wadl:resources> </wadl:resources>
</section> </section>
<section xml:id="v1.1jobbinaries"> <section xml:id="v1.1jobbinaries">
<title>Job binaries</title> <title>Job binaries</title>
<para>
Job binary objects represent data processing applications and
libraries that are stored in either the internal database or the
Object Storage service.
</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/job-binaries.wadl#job-binaries">
<wadl:method href="#job-binaries-list"/>
<wadl:method href="#job-binaries-create"/>
</wadl:resource>
<wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/job-binaries.wadl#job-binaries-id">
<wadl:method href="#job-binaries-show"/>
<wadl:method href="#job-binaries-delete"/>
</wadl:resource>
<wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/job-binaries.wadl#job-binaries-id-data">
<wadl:method href="#job-binaries-data"/>
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="v1.1clustertemplate">
<title>Cluster templates</title>
<para> <para>
A cluster template configures a Hadoop cluster. A cluster template Job binary objects represent data processing applications and
lists node groups with the number of instances in each group. You libraries that are stored in either the internal database or the
can also define cluster-scoped configurations in a cluster Object Storage service.
template.
</para> </para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02"> <wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/cluster-templates.wadl#cluster-templates"> <wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/job-binaries.wadl#job-binaries">
<wadl:method href="#cluster-templates-list"/> <wadl:method href="#job-binaries-list"/>
<wadl:method href="#cluster-templates-create"/> <wadl:method href="#job-binaries-create"/>
</wadl:resource> </wadl:resource>
<wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/cluster-templates.wadl#cluster_template_id"> <wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/job-binaries.wadl#job-binaries-id">
<wadl:method href="#cluster-templates-show"/> <wadl:method href="#job-binaries-show"/>
<wadl:method href="#cluster-templates-update"/> <wadl:method href="#job-binaries-delete"/>
<wadl:method href="#cluster-templates-delete"/> </wadl:resource>
<wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/job-binaries.wadl#job-binaries-id-data">
<wadl:method href="#job-binaries-data"/>
</wadl:resource> </wadl:resource>
</wadl:resources> </wadl:resources>
</section> </section>
<section xml:id="v1.1jobs">
<title>Jobs</title>
<para>
A job object lists the binaries that a job needs to run. To
run a job, you must specify data sources and job parameters.
</para>
<para>
You can run a job on an existing or new transient cluster.
</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/jobs.wadl#jobs">
<wadl:method href="#jobsList"/>
<wadl:method href="#jobCreate"/>
</wadl:resource>
<wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/jobs.wadl#jobId">
<wadl:method href="#jobInfo"/>
<wadl:method href="#jobDelete"/>
</wadl:resource>
<wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/jobs.wadl#execute">
<wadl:method href="#jobExecute"/>
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="v1.1jobexecutions">
<title>Job executions</title>
<para>
A job execution object represents a Hadoop job that runs on a
specified cluster. A job execution polls the status of a running
job and reports it to the user. Also a user can cancel a running job.
</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/job-executions.wadl#job-executions">
<wadl:method href="#job-executions-list"/>
</wadl:resource>
<wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/job-executions.wadl#job_execution_id">
<wadl:method href="#job-executions-show"/>
<wadl:method href="#job-executions-delete"/>
</wadl:resource>
<wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/job-executions.wadl#refresh-status">
<wadl:method href="#job-executions-refresh"/>
</wadl:resource>
<wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/job-executions.wadl#cancel">
<wadl:method href="#job-executions-cancel"/>
</wadl:resource>
</wadl:resources>
</section>
<section xml:id="v1.1jobtypes">
<title>Job types</title>
<para>
Each plugin that supports EDP also supports specific job types.
Different versions of a plugin might actually support different job
types. Configuration options vary by plugin, version, and
job type.
</para>
<para>
The job types provide information about which plugins support
which job types and how to configure the job types.
</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource href="../wadls/dataprocessing-api/src/v1.1/wadl/job-types.wadl#job-types">
<wadl:method href="#jobTypesList"/>
</wadl:resource>
</wadl:resources>
</section>
</chapter> </chapter>

33
api-ref/src/wadls/dataprocessing-api/src/v1.1/wadl/event-log.wadl
View File

@ -5,7 +5,7 @@
<!-- --> <!-- -->
<!-- You can resolve the entities with xmllint --> <!-- You can resolve the entities with xmllint -->
<!-- --> <!-- -->
<!-- xmllint -noent node-group-template.wadl --> <!-- xmllint -noent cluster.wadl -->
<!--*******************************************************--> <!--*******************************************************-->
<!DOCTYPE application [ <!DOCTYPE application [
<!ENTITY % common_project SYSTEM "../../../../common_project.ent"> <!ENTITY % common_project SYSTEM "../../../../common_project.ent">
@ -16,24 +16,26 @@
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0" xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
xmlns:wadl="http://wadl.dev.java.net/2009/02"> xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns:csapi="http://docs.openstack.org/compute/api/v2">
<resources base="https://servers.api.openstack.com" <resources base="https://servers.api.openstack.com"
xml:id="cluster-templates-v1.1"> xml:id="event-log-v1.1">
<resource id="v1.1" path="//v1.1"> <resource id="v1.1" path="//v1.1">
<resource id="tenant_id" path="{tenant_id}"> <resource id="tenant_id" path="{tenant_id}">
<param name="tenant_id" style="template" type="capi:UUID"> <param name="tenant_id" style="template" type="csapi:UUID">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The unique identifier of the tenant or account.</para> <para>The unique identifier of the tenant or account.</para>
</wadl:doc> </wadl:doc>
</param> </param>
<resource id="clusters" path="clusters"> <resource id="clusters" path="clusters">
<resource id="cluster_id" path="{cluster_id}?show_progress=True"> <resource id="cluster_id"
<param name="cluster_id" style="template" type="capi:UUID"> path="{cluster_id}">
<param name="cluster_id" style="template" type="csapi:UUID">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The unique identifier of the cluster.</para> <para>The ID of the cluster</para>
</wadl:doc> </wadl:doc>
</param> </param>
<method href="#cluster-show-progress"/> <method href="#show-progress"/>
</resource> </resource>
</resource> </resource>
</resource> </resource>
@ -42,13 +44,18 @@
<!-- *******************************************************--> <!-- *******************************************************-->
<!-- Event log actions --> <!-- Event log actions -->
<!--********************************************************--> <!--********************************************************-->
<method name="GET" id="cluster-show-progress"> <method name="GET" id="show-progress">
<wadl:doc xml:lang="EN" title="Show cluster with provisioning progress" <wadl:doc xml:lang="EN" title="Show progress"
xmlns="http://docbook.org/ns/docbook"> xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc"> <para role="shortdesc">Shows provisioning progress of cluster.</para>
Shows cluster with provisioning progress information.
</para>
</wadl:doc> </wadl:doc>
<request>
<param name="show-progress" style="plain" type="xsd:boolean" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>Flag, which show cluster provisioning progress.</para>
</wadl:doc>
</param>
</request>
<response status="200"> <response status="200">
<representation mediaType="application/json"> <representation mediaType="application/json">
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"> <wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook">