openstack
/
sahara
Code Issues Proposed changes

Updated REST API documentation 

* Removed old rest api samples from etc dir
* Updated res_api_v1.0 and v1.1 pages with actual state of Sahara and its
  api
  - list of plugins shows more plugins - 'vanilla,spark,hdp,cdh'
  - image examples work with latest image with vanilla 2.4.1
  - updated node-group templates and cluster templates  examples with
    2.4.1 node-processes
  - updated cluster related ops in docs
  - edp ops looks correct and clear, nothing to change
  - removed rest-api-samples dir both for cluster and edp ops

Implements blueprint: move-rest-samples-to-docs

Change-Id: I158549bf8fda383e1b3356b7751e28c9f83f8598
This commit is contained in:
Alexander Ignatov 2014-07-25 11:12:57 +04:00
parent 8f5895588e
commit 884fadf6f4
11 changed files with 1151 additions and 760 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1773
doc/source/restapi/rest_api_v1.0.rst
View File

File diff suppressed because it is too large Load Diff

3
doc/source/restapi/rest_api_v1.1_EDP.rst
View File

@ -153,6 +153,9 @@ Errors: none
This operation returns the created Data Source.
**Example**:
This example creates a Swift data source.
**request**
.. sourcecode:: http

27
etc/rest-api-samples/cluster_create_full.json
View File

@ -1,27 +0,0 @@
{
"name": "sl-cluster-42",
"plugin_name": "vanilla",
"hadoop_version": "1.2.1",
"user_keypair_id": "slukjanov",
"default_image_id": "51752c61-f73a-456c-98fb-192c0a448554",
"cluster_configs": {
"general": {
"some_overridden_config": "asdfgh"
}
},
"node_groups": [
{
"name": "master",
"node_group_template_id": "0fe82f67-5453-41bb-b913-36775c1f50be",
"flavor_id": "42",
"count": 1
},
{
"name": "worker",
"flavor_id": "42",
"node_processes": ["tasktracker", "datanode"],
"node_configs": {},
"count": 2
}
]
}

6
etc/rest-api-samples/cluster_create_minimal.json
View File

@ -1,6 +0,0 @@
{
"name": "cluster-1",
"plugin_name": "vanilla",
"hadoop_version": "1.2.1",
"cluster_template_id" : "3ebd3aa9-2252-4830-b814-25bf0d58abfe"
}

25
etc/rest-api-samples/cluster_tmpl_create.json
View File

@ -1,25 +0,0 @@
{
"name": "demo-cluster-template",
"description": "Demo Cluster template",
"plugin_name": "vanilla",
"hadoop_version": "1.2.1",
"cluster_configs": {
"general": {
"some_general_conf": "qwerty"
}
},
"node_groups": [
{
"name": "master",
"node_group_template_id": "0fe82f67-5453-41bb-b913-36775c1f50be",
"count": 1
},
{
"name": "worker",
"flavor_id": "42",
"node_processes": ["tasktracker", "datanode"],
"node_configs": {},
"count": 2
}
]
}

10
etc/rest-api-samples/edp/data_source_create.json
View File

@ -1,10 +0,0 @@
{
"description": "This is input",
"url": "swift://container.sahara/text",
"credentials": {
"password": "swordfish",
"user": "admin"
},
"type": "swift",
"name": "text"
}

9
etc/rest-api-samples/edp/job_binary_create.json
View File

@ -1,9 +0,0 @@
{
"url": "swift://container/jar-example.jar",
"name": "jar-example.jar",
"description": "This is job binary",
"extra": {
"password": "swordfish",
"user": "admin"
}
}

7
etc/rest-api-samples/edp/job_create.json
View File

@ -1,7 +0,0 @@
{
"description": "This is pig job example",
"mains": ["84248975-3c82-4206-a58d-6e7fb3a563fd"],
"libs": ["508fc62d-1d58-4412-b603-bdab307bb926"],
"type": "Pig",
"name": "pig-job-example"
}

19
etc/rest-api-samples/edp/job_execute.json
View File

@ -1,19 +0,0 @@
{
"cluster_id": "776e441b-5816-4d47-9e07-7ded58f9a5f6",
"input_id": "af7dc864-6331-4c30-80f5-63d74b667eaf",
"output_id": "b63780f3-13d7-4286-b731-88270fb204de",
"job_configs": {
"configs": {
"mapred.map.tasks": "1",
"mapred.reduce.tasks": "1"
},
"args": {
"arg1": "val1",
"arg2": "val2"
},
"params": {
"param2": "value2",
"param1": "value1"
}
}
}

17
etc/rest-api-samples/node_group_tmpl_create.json
View File

@ -1,17 +0,0 @@
{
"name": "test-master-tmpl",
"description": "Test template for master node",
"flavor_id": "m1.xlarge",
"plugin_name": "vanilla",
"hadoop_version": "1.2.1",
"node_processes": ["tasktracker", "namenode"],
"node_configs": {
"hdfs": {
"some_hdfs_config_1": "value_1",
"some_hdfs_config_2": "value_2"
},
"mapreduce": {
"some_mapreduce_config_1": "value_3"
}
}
}

15
etc/rest-api-samples/scale_cluster.json
View File

@ -1,15 +0,0 @@
{
"add_node_groups":[
{
"node_group_template_id": "9e1225e0-b7ce-425b-9555-3a61166167c8",
"count":1,
"name": "test_ng"
}
],
"resize_node_groups":[
{
"name" : "worker",
"count":2
}
]
}