From 301c30132b43992f1bfd7273380a02116a00d721 Mon Sep 17 00:00:00 2001 From: Vitaly Gridnev Date: Mon, 6 Apr 2015 14:29:18 +0300 Subject: [PATCH] Repair Data Processing API docs 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 --- .../src/docbkx/ch_data-processing-v1.1.xml | 265 ++++++++++-------- .../src/v1.1/wadl/event-log.wadl | 33 ++- 2 files changed, 167 insertions(+), 131 deletions(-) diff --git a/api-ref/src/docbkx/ch_data-processing-v1.1.xml b/api-ref/src/docbkx/ch_data-processing-v1.1.xml index 27d2e34f9..ce71a179b 100644 --- a/api-ref/src/docbkx/ch_data-processing-v1.1.xml +++ b/api-ref/src/docbkx/ch_data-processing-v1.1.xml @@ -56,91 +56,6 @@ -
- Jobs - - A job object lists the binaries that a job needs to run. To - run a job, you must specify data sources and job parameters. - - - You can run a job on an existing or new transient cluster. - - - - - - - - - - - - - - -
-
- Job types - - 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. - - - The job types provide information about which plugins support - which job types and how to configure the job types. - - - - - - -
-
- Job executions - - 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. - - - - - - - - - - - - - - - - -
-
- Data sources - - A data source object defines the location of input or output for - MapReduce jobs and might reference different types of storage. - - - The Data Processing service does not validate data source - locations. - - - - - - - - - - - -
Node group templates @@ -165,6 +80,76 @@
+
+ Cluster templates + + 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. + + + + + + + + + + + + +
+
+ Clusters + + A cluster is a group of nodes with the same configuration. + + + + + + + + + + + + +
+
+ Event log + + The event log feature provides information about cluster provisioning. + In the event of errors, the event log shows the reason for the failure. + + + + + + +
+
+ Data sources + + A data source object defines the location of input or output for + MapReduce jobs and might reference different types of storage. + + + The Data Processing service does not validate data source + locations. + + + + + + + + + + + +
Job binary internals @@ -188,44 +173,88 @@
- Job binaries - - Job binary objects represent data processing applications and - libraries that are stored in either the internal database or the - Object Storage service. - - - - - - - - - - - - - - -
-
- Cluster templates + Job binaries - 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. + Job binary objects represent data processing applications and + libraries that are stored in either the internal database or the + Object Storage service. - - - + + + - - - - + + + + + +
+
+ Jobs + + A job object lists the binaries that a job needs to run. To + run a job, you must specify data sources and job parameters. + + + You can run a job on an existing or new transient cluster. + + + + + + + + + + + + + + +
+
+ Job executions + + 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. + + + + + + + + + + + + + + + + +
+
+ Job types + + 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. + + + The job types provide information about which plugins support + which job types and how to configure the job types. + + + + + + +
diff --git a/api-ref/src/wadls/dataprocessing-api/src/v1.1/wadl/event-log.wadl b/api-ref/src/wadls/dataprocessing-api/src/v1.1/wadl/event-log.wadl index b7db8c156..6af827d23 100644 --- a/api-ref/src/wadls/dataprocessing-api/src/v1.1/wadl/event-log.wadl +++ b/api-ref/src/wadls/dataprocessing-api/src/v1.1/wadl/event-log.wadl @@ -5,7 +5,7 @@ - + @@ -16,24 +16,26 @@ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" 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"> + xml:id="event-log-v1.1"> - + The unique identifier of the tenant or account. - - + + - The unique identifier of the cluster. + The ID of the cluster - + @@ -42,13 +44,18 @@ - - + - - Shows cluster with provisioning progress information. - + Shows provisioning progress of cluster. + + + + Flag, which show cluster provisioning progress. + + +