From d909e960f7d6774252ea906598d9fa69c5c82c8d Mon Sep 17 00:00:00 2001 From: Trevor McKay Date: Thu, 20 Mar 2014 15:42:09 -0400 Subject: [PATCH] Change remaining references in the doc subdir * "_savanna_" properties changed in json output Change-Id: Ief26d2fb496e13c91aa72f7ce6184ad6a2c78065 --- doc/source/devref/quickstart.rst | 10 +++--- doc/source/restapi/rest_api_v1.0.rst | 36 ++++++++++----------- doc/source/restapi/rest_api_v1.1_EDP.rst | 40 ++++++++++++------------ doc/source/userdoc/edp.rst | 2 +- doc/source/userdoc/features.rst | 10 +++--- doc/source/userdoc/hadoop-swift.rst | 10 +++--- doc/source/userdoc/vanilla_plugin.rst | 6 ++-- 7 files changed, 57 insertions(+), 57 deletions(-) diff --git a/doc/source/devref/quickstart.rst b/doc/source/devref/quickstart.rst index ec0793e2..d9c12408 100644 --- a/doc/source/devref/quickstart.rst +++ b/doc/source/devref/quickstart.rst @@ -148,11 +148,11 @@ Save image id. You can get image id from command ``glance image-list``: "description": "None", "id": "3f9fc974-b484-4756-82a4-bff9e116919b", "metadata": { - "_savanna_description": "None", - "_savanna_tag_1.2.1": "True", - "_savanna_tag_ubuntu": "True", - "_savanna_tag_vanilla": "True", - "_savanna_username": "ubuntu" + "_sahara_description": "None", + "_sahara_tag_1.2.1": "True", + "_sahara_tag_ubuntu": "True", + "_sahara_tag_vanilla": "True", + "_sahara_username": "ubuntu" }, "minDisk": 0, "minRam": 0, diff --git a/doc/source/restapi/rest_api_v1.0.rst b/doc/source/restapi/rest_api_v1.0.rst index 4db9ecef..1f4f6984 100644 --- a/doc/source/restapi/rest_api_v1.0.rst +++ b/doc/source/restapi/rest_api_v1.0.rst @@ -410,9 +410,9 @@ This operation does not require a request body. "progress": 100, "minRam": 0, "metadata": { - "_savanna_tag_vanilla": "True", - "_savanna_tag_1.2.1": "True", - "_savanna_username": "ec2-user" + "_sahara_tag_vanilla": "True", + "_sahara_tag_1.2.1": "True", + "_sahara_username": "ec2-user" }, "id": "daa50c37-b11b-4f3d-a586-e5dcd0a4110f" } @@ -462,9 +462,9 @@ This operation does not require a request body. "progress": 100, "minRam": 0, "metadata": { - "_savanna_tag_vanilla": "True", - "_savanna_tag_1.2.1": "True", - "_savanna_username": "ec2-user" + "_sahara_tag_vanilla": "True", + "_sahara_tag_1.2.1": "True", + "_sahara_username": "ec2-user" }, "id": "daa50c37-b11b-4f3d-a586-e5dcd0a4110f" } @@ -515,9 +515,9 @@ This operation does not require a request body. "progress": 100, "minRam": 0, "metadata": { - "_savanna_tag_vanilla": "True", - "_savanna_tag_1.2.1": "True", - "_savanna_username": "ec2-user" + "_sahara_tag_vanilla": "True", + "_sahara_tag_1.2.1": "True", + "_sahara_username": "ec2-user" }, "id": "daa50c37-b11b-4f3d-a586-e5dcd0a4110f" } @@ -568,8 +568,8 @@ This operation returns registered image. "progress": 100, "minRam": 0, "metadata": { - "_savanna_username": "ec2-user", - "_savanna_description": "Fedora image" + "_sahara_username": "ec2-user", + "_sahara_description": "Fedora image" }, "id": "daa50c37-b11b-4f3d-a586-e5dcd0a4110f" } @@ -649,10 +649,10 @@ Add Tags to Image. "progress": 100, "minRam": 0, "metadata": { - "_savanna_username": "ec2-user", - "_savanna_description": "Fedora image", - "_savanna_tag_tag1": "True", - "_savanna_tag_some_other_tag": "True" + "_sahara_username": "ec2-user", + "_sahara_description": "Fedora image", + "_sahara_tag_tag1": "True", + "_sahara_tag_some_other_tag": "True" }, "id": "daa50c37-b11b-4f3d-a586-e5dcd0a4110f" } @@ -703,9 +703,9 @@ Removes Tags form Image. "progress": 100, "minRam": 0, "metadata": { - "_savanna_username": "ec2-user", - "_savanna_description": "Fedora image", - "_savanna_tag_tag1": "True" + "_sahara_username": "ec2-user", + "_sahara_description": "Fedora image", + "_sahara_tag_tag1": "True" }, "id": "daa50c37-b11b-4f3d-a586-e5dcd0a4110f" } diff --git a/doc/source/restapi/rest_api_v1.1_EDP.rst b/doc/source/restapi/rest_api_v1.1_EDP.rst index 311fc8cc..5efd2373 100644 --- a/doc/source/restapi/rest_api_v1.1_EDP.rst +++ b/doc/source/restapi/rest_api_v1.1_EDP.rst @@ -68,7 +68,7 @@ This operation does not require a request body. "data_sources": [ { "description": "This is input", - "url": "swift://container.savanna/text", + "url": "swift://container.sahara/text", "tenant_id": "11587919cc534bcbb1027a161c82cf58", "created_at": "2013-10-09 12:37:19.295701", "updated_at": null, @@ -82,7 +82,7 @@ This operation does not require a request body. }, { "description": "This is output", - "url": "swift://container.savanna/result", + "url": "swift://container.sahara/result", "tenant_id": "11587919cc534bcbb1027a161c82cf58", "created_at": "2013-10-09 12:37:58.155911", "updated_at": null, @@ -140,7 +140,7 @@ This operation does not require a request body. { "data_source": { "description": "", - "url": "swift://container.savanna/text", + "url": "swift://container.sahara/text", "tenant_id": "11587919cc534bcbb1027a161c82cf58", "created_at": "2013-10-09 12:37:19.295701", "updated_at": null, @@ -176,7 +176,7 @@ This operation returns the created Data Source. { "description": "This is input", - "url": "swift://container.savanna/text", + "url": "swift://container.sahara/text", "credentials": { "password": "swordfish", "user": "admin" @@ -197,7 +197,7 @@ This operation returns the created Data Source. { "data_source": { "description": "This is input", - "url": "swift://container.savanna/text", + "url": "swift://container.sahara/text", "tenant_id": "11587919cc534bcbb1027a161c82cf58", "created_at": "2013-10-15 11:15:25.971886", "credentials": { @@ -555,7 +555,7 @@ This operation does not require a request body. { "description": "", "extra": {}, - "url": "sahara-db://d2498cbf-4589-484a-a814-81436c18beb3", + "url": "internal-db://d2498cbf-4589-484a-a814-81436c18beb3", "tenant_id": "11587919cc534bcbb1027a161c82cf58", "created_at": "2013-10-15 12:36:59.375060", "updated_at": null, @@ -565,7 +565,7 @@ This operation does not require a request body. { "description": "", "extra": {}, - "url": "sahara-db://22f1d87a-23c8-483e-a0dd-cb4a16dde5f9", + "url": "internal-db://22f1d87a-23c8-483e-a0dd-cb4a16dde5f9", "tenant_id": "11587919cc534bcbb1027a161c82cf58", "created_at": "2013-10-15 12:43:52.265899", "updated_at": null, @@ -815,7 +815,7 @@ This operation does not require a request body. { "description": "", "extra": {}, - "url": "sahara-db://d2498cbf-4589-484a-a814-81436c18beb3", + "url": "internal-db://d2498cbf-4589-484a-a814-81436c18beb3", "tenant_id": "11587919cc534bcbb1027a161c82cf58", "created_at": "2013-10-15 12:36:59.375060", "updated_at": null, @@ -828,7 +828,7 @@ This operation does not require a request body. { "description": "", "extra": {}, - "url": "sahara-db://22f1d87a-23c8-483e-a0dd-cb4a16dde5f9", + "url": "internal-db://22f1d87a-23c8-483e-a0dd-cb4a16dde5f9", "tenant_id": "11587919cc534bcbb1027a161c82cf58", "created_at": "2013-10-15 12:43:52.265899", "updated_at": null, @@ -971,7 +971,7 @@ This operation shows information about the created Job object. { "description": "", "extra": {}, - "url": "sahara-db://d2498cbf-4589-484a-a814-81436c18beb3", + "url": "internal-db://d2498cbf-4589-484a-a814-81436c18beb3", "tenant_id": "11587919cc534bcbb1027a161c82cf58", "created_at": "2013-10-15 12:36:59.375060", "updated_at": null, @@ -983,7 +983,7 @@ This operation shows information about the created Job object. { "description": "", "extra": {}, - "url": "sahara-db://22f1d87a-23c8-483e-a0dd-cb4a16dde5f9", + "url": "internal-db://22f1d87a-23c8-483e-a0dd-cb4a16dde5f9", "tenant_id": "11587919cc534bcbb1027a161c82cf58", "created_at": "2013-10-15 12:43:52.265899", "updated_at": null, @@ -1214,11 +1214,11 @@ This operation returns the created Job Execution object. Note that different job "cluster_id": "776e441b-5816-4d47-9e07-7ded58f9a5f6", "job_configs": { "configs": { - "fs.swift.service.savanna.username": "myname", - "fs.swift.service.savanna.password": "mypassword", + "fs.swift.service.sahara.username": "myname", + "fs.swift.service.sahara.password": "mypassword", "edp.java.main_class": "org.apache.hadoop.examples.WordCount" }, - "args": ["swift://integration.savanna/demo/make_job.sh", "swift://integration.savanna/friday"] + "args": ["swift://integration.sahara/demo/make_job.sh", "swift://integration.sahara/friday"] } } @@ -1245,12 +1245,12 @@ This operation returns the created Job Execution object. Note that different job "job_configs": { "configs": { "edp.java.main_class": "org.apache.hadoop.examples.WordCount", - "fs.swift.service.savanna.password": "myname", - "fs.swift.service.savanna.username": "mypassword" + "fs.swift.service.sahara.password": "myname", + "fs.swift.service.sahara.username": "mypassword" }, "args": [ - "swift://integration.savanna/demo/make_job.sh", - "swift://integration.savanna/friday" + "swift://integration.sahara/demo/make_job.sh", + "swift://integration.sahara/friday" ] }, "id": "724709bf-2268-46ed-8daf-47898b4630b4" @@ -1361,7 +1361,7 @@ This operation does not require a request body. "consoleUrl": "http://edp-master-001:50030/jobdetails.jsp?jobid=job_201310171352_0001", "toString": "Action name[job-node] status[RUNNING]", "externalStatus": "RUNNING", - "conf": "\r\n edp-master-001:8021\r\n hdfs://edp-master-001:8020\r\n \r\n \r\n fs.swift.service.savanna.password\r\n swordfish\r\n \r\n \r\n fs.swift.service.savanna.username\r\n admin\r\n \r\n \r\n \r\n INPUT=swift://container.savanna/text\r\n OUTPUT=swift://container.savanna/output\r\n", + "conf": "\r\n edp-master-001:8021\r\n hdfs://edp-master-001:8020\r\n \r\n \r\n fs.swift.service.sahara.password\r\n swordfish\r\n \r\n \r\n fs.swift.service.sahara.username\r\n admin\r\n \r\n \r\n \r\n INPUT=swift://container.sahara/text\r\n OUTPUT=swift://container.sahara/output\r\n", "type": "pig", "trackerUri": "edp-master-001:8021", "externalChildIDs": null, @@ -1592,7 +1592,7 @@ The following json response represents Job Execution object returned from Sahara "consoleUrl": "http://edp-master-001:50030/jobdetails.jsp?jobid=job_201310171352_0001", "toString": "Action name[job-node] status[RUNNING]", "externalStatus": "RUNNING", - "conf": "\r\n edp-master-001:8021\r\n hdfs://edp-master-001:8020\r\n \r\n \r\n fs.swift.service.savanna.password\r\n swordfish\r\n \r\n \r\n fs.swift.service.savanna.username\r\n admin\r\n \r\n \r\n \r\n INPUT=swift://container.savanna/text\r\n OUTPUT=swift://container.savanna/output\r\n", + "conf": "\r\n edp-master-001:8021\r\n hdfs://edp-master-001:8020\r\n \r\n \r\n fs.swift.service.sahara.password\r\n swordfish\r\n \r\n \r\n fs.swift.service.sahara.username\r\n admin\r\n \r\n \r\n \r\n INPUT=swift://container.sahara/text\r\n OUTPUT=swift://container.sahara/output\r\n", "type": "pig", "trackerUri": "edp-master-001:8021", "externalChildIDs": null, diff --git a/doc/source/userdoc/edp.rst b/doc/source/userdoc/edp.rst index 66670f52..2002093b 100644 --- a/doc/source/userdoc/edp.rst +++ b/doc/source/userdoc/edp.rst @@ -218,7 +218,7 @@ Sahara Swift URLs have the form: Sahara internal database URLs have the form: - ``sahara-db://sahara-generated-uuid`` + ``internal-db://sahara-generated-uuid`` EDP Requirements diff --git a/doc/source/userdoc/features.rst b/doc/source/userdoc/features.rst index bb492160..9547baf0 100644 --- a/doc/source/userdoc/features.rst +++ b/doc/source/userdoc/features.rst @@ -23,9 +23,9 @@ E.g. : .. sourcecode:: console - $ hadoop distcp -D fs.swift.service.savanna.username=admin \ - -D fs.swift.service.savanna.password=swordfish \ - swift://integration.savanna/temp swift://integration.savanna/temp1 + $ hadoop distcp -D fs.swift.service.sahara.username=admin \ + -D fs.swift.service.sahara.password=swordfish \ + swift://integration.sahara/temp swift://integration.sahara/temp1 How to compose a swift URL? The template is: ``swift://${container}.${provider}/${object}``. We don't need to point out the account because it will be automatically @@ -34,10 +34,10 @@ determined from tenant name from configs. Actually, account=tenant. ${provider} was designed to provide an opportunity to work with several Swift installations. E.g. it is possible to read data from one Swift installation and write it to another one. But as for now, Sahara automatically generates configs only for one Swift installation -with name "savanna". +with name "sahara". Currently user can only enable/disable Swift for a Hadoop cluster. But there is a blueprint about making Swift access -more configurable: https://blueprints.launchpad.net/savanna/+spec/swift-configuration-through-rest-and-ui +more configurable: https://blueprints.launchpad.net/sahara/+spec/swift-configuration-through-rest-and-ui Currently this feature is supported only by :doc:`vanilla_plugin`. diff --git a/doc/source/userdoc/hadoop-swift.rst b/doc/source/userdoc/hadoop-swift.rst index b6293650..62840f48 100644 --- a/doc/source/userdoc/hadoop-swift.rst +++ b/doc/source/userdoc/hadoop-swift.rst @@ -126,12 +126,12 @@ Example ------- By this point Swift and Hadoop is ready for use. All configs in hadoop is ok. -In example below provider's name is ``savanna``. So let's copy one object +In example below provider's name is ``sahara``. So let's copy one object to another in one swift container and account. E.g. /dev/integration/temp to /dev/integration/temp1. Will use distcp for this purpose: http://hadoop.apache.org/docs/r0.19.0/distcp.html -How to write swift path? In our case it will look as follows: ``swift://integration.savanna/temp``. +How to write swift path? In our case it will look as follows: ``swift://integration.sahara/temp``. So the template is: ``swift://${container}.${provider}/${object}``. We don't need to point out the account because it will be automatically determined from tenant name from configs. Actually, account=tenant. @@ -140,9 +140,9 @@ Let's run the job: .. sourcecode:: console - $ hadoop distcp -D fs.swift.service.savanna.username=admin \ - -D fs.swift.service.savanna.password=swordfish \ - swift://integration.savanna/temp swift://integration.savanna/temp1 + $ hadoop distcp -D fs.swift.service.sahara.username=admin \ + -D fs.swift.service.sahara.password=swordfish \ + swift://integration.sahara/temp swift://integration.sahara/temp1 After that just check if temp1 is created. diff --git a/doc/source/userdoc/vanilla_plugin.rst b/doc/source/userdoc/vanilla_plugin.rst index cc7c4239..739bbc33 100644 --- a/doc/source/userdoc/vanilla_plugin.rst +++ b/doc/source/userdoc/vanilla_plugin.rst @@ -6,9 +6,9 @@ Vanilla plugin is a reference plugin implementation which allows to operate with For cluster provisioning prepared images should be used. They already have Apache Hadoop 1.2.1 installed. Here you can find prepared images: -* http://savanna-files.mirantis.com/savanna-icehouse-vanilla-1.2.1-ubuntu-13.10.qcow2 -* http://savanna-files.mirantis.com/savanna-icehouse-vanilla-1.2.1-fedora-19.qcow2 -* http://savanna-files.mirantis.com/savanna-icehouse-vanilla-1.2.1-centos-6.4.qcow2 +* http://sahara-files.mirantis.com/savanna-icehouse-vanilla-1.2.1-ubuntu-13.10.qcow2 +* http://sahara-files.mirantis.com/savanna-icehouse-vanilla-1.2.1-fedora-19.qcow2 +* http://sahara-files.mirantis.com/savanna-icehouse-vanilla-1.2.1-centos-6.4.qcow2 Besides, you may build images by yourself using :doc:`diskimagebuilder`. Keep in mind that if you want to use "Swift Integration" feature ( :doc:`features`),