Repository: airavata Updated Branches: refs/heads/0.14_release c6953df57 -> 7e8b48b07
update README Project: http://git-wip-us.apache.org/repos/asf/airavata/repo Commit: http://git-wip-us.apache.org/repos/asf/airavata/commit/7e8b48b0 Tree: http://git-wip-us.apache.org/repos/asf/airavata/tree/7e8b48b0 Diff: http://git-wip-us.apache.org/repos/asf/airavata/diff/7e8b48b0 Branch: refs/heads/0.14_release Commit: 7e8b48b07f20756ebbe164d5386581360c462152 Parents: c6953df Author: Chathuri Wimalasena <[email protected]> Authored: Mon Dec 29 11:49:30 2014 -0500 Committer: Chathuri Wimalasena <[email protected]> Committed: Mon Dec 29 11:49:30 2014 -0500 ---------------------------------------------------------------------- .../server/src/main/resources/README | 211 ++++++++++--------- 1 file changed, 111 insertions(+), 100 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/airavata/blob/7e8b48b0/modules/distribution/server/src/main/resources/README ---------------------------------------------------------------------- diff --git a/modules/distribution/server/src/main/resources/README b/modules/distribution/server/src/main/resources/README index fb064a1..c2223ff 100644 --- a/modules/distribution/server/src/main/resources/README +++ b/modules/distribution/server/src/main/resources/README @@ -1,4 +1,4 @@ -Apache Airavata Server - README.txt +Apache Airavata Source - README.txt Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0 -------------------------------------------------------------------------------- @@ -6,110 +6,111 @@ About ===== Apache Airavata, a software framework to executing and managing computational jobs on distributed computing resources including local clusters, supercomputers, national grids, -academic and commercial clouds. Airavata can be used as individual components or -as an integrated solution to build science gateways or general-purpose distributed -application and workflow management systems. Users can use Airavata back end services -and build gadgets to deploy in open social containers such as Apache Rave and modify them -to suit their needs. Airavata builds on general concepts of service oriented computing, -distributed messaging, and workflow composition and orchestration. - -This distribution allows you to run a standalone Airavata Server which includes all the -airavata services shipped with a default derby database as the backend registry. - -Release Notes -============= -0.14 is the thirteenth release of Airavata (skipped 0.1-INCUBATNG). For detailed tasks list, please see RELEASE_NOTES. - -Building from source -==================== -For brief installation instructions, see INSTALL -For detailed installation and further instructions refer http://airavata.apache.org/ - Documentation section in left hand panel. Step by step with proper documentation are provided. - - -Airavata Binary Distribution Directory Structure -================================================ - - AIRAVATA_HOME - âââ INSTALL - âââ LICENSE - âââ NOTICE - âââ README - âââ RELEASE_NOTES - âââ bin - â  âââ PBSTemplate.xslt - â  âââ SGETemplate.xslt - â  âââ SLURMTemplate.xslt - â  âââ airavata-server.bat - â  âââ airavata-server.properties - â  âââ airavata-server.sh - â  âââ api-server.sh - â  âââ database_scripts - â  â  âââ appcatalog-derby.sql - â  â  âââ appcatalog-mysql.sql - â  â  âââ cleanDBScript.sql - â  â  âââ msgBox-derby.sql - â  â  âââ msgBox-mysql.sql - â  â  âââ msgBroker-derby.sql - â  â  âââ msgBroker-mysql.sql - â  â  âââ registry-derby.sql - â  â  âââ registry-mysql.sql - â  âââ derby.sh - â  âââ gfac-config.xml - â  âââ gfac-server.sh - â  âââ gsissh.properties - â  âââ log4j.properties - â  âââ logo.txt - â  âââ orchestrator-server.sh - â  âââ setenv.bat - â  âââ setenv.sh - â  âââ startNetworkServer - â  âââ workflow-server.sh - â  âââ zoo.cfg - âââ lib - âââ samples - âââ registerSample.sh - âââ scripts - âââ add.sh - âââ echo.sh - âââ multiply.sh - âââ subtract.sh - - -How to test and run samples -=========================== -* If you built Airavata from source, and if you see "BUILD SUCCESS", then the test cases should have passes. -* The test cases are beyond unit level, they startup embedded services and run through basic workflow use cases. -* To walk through Airavata features, follow "Airavata in Five Minutes" tutorial at http://airavata.apache.org/documentation/tutorials/airavata-in-5-minutes.html -* For intermediate level Airavata features, follow "Airavata in Ten Minutes" tutorial at http://airavata.apache.org/documentation/tutorials/airavata-in-10-minutes.html -* For advanced use cases, please contact mailing lists - http://airavata.apache.org/community/mailing-lists.html - -Description of Directory Structure +academic and commercial clouds. Airavata builds on general concepts of service oriented computing, +distributed messaging, and workflow composition and orchestration. Airavata bundles a server package +with an API, client software development Kits and a general purpose GUI XBaya as a application registration, workflow +construction execution and monitoring. XBaya GUI also provides capabilities to access the workflow +produced data. + +Contact +======== +For additional information about Apache Airavata, please contact the user or dev mailing lists: +http://airavata.apache.org/community/mailing-lists.html + +Description of Airavata Directory Structure ================================== - - bin - This contains all the configuration files & the executable scripts to run the Airavata Server (Axis2 server - with Airavata services which include messageBroker and messageBox with GFac Axis2 services), & a standalone Apache Derby server. + - airavata-api + This directory contains Airavata API related data models, api methods, generated server skeletons, client stubs, server implementations and client samples. - - bin - database_scripts - Contains the database scripts which are used to create tables for messagebox and messagebroker services + - modules + This contains the source code of all the airavata maven projects organized as libraries, services and distributions - samples - This contains sample workflow to try out & sample application scripts. - - - lib - This contains all the libraries required to run the airavata server and/or derby server. + This contains all the system wide samples provided in Airavata distribution. All the sample are having its README file + So users have to refer each readme file before running each sample. - - repository - services - Contains deployed services in Axis2 runtime. + - tools + This contains source code libraries that can enhance Airavata features. - README This document. + + - RELEASE_NOTES + The describe the key features and know issues with the current release. - INSTALL This document will contain information on installing Apache-Airavata. +Airavata Source Distribution Directory Structure +================================================ + + AIRAVATA_MASTER + âââ airavata-api + âââ modules + â âââ airavata-client + â âââ app-catalog + â âââ commons + â â âââ gfac-schema + â â âââ utils + â â âââ workflow-execution-context + â â âââ workflow-tracking + â âââ credential-store-service + â âââ distribution + â â âââ api-server + â â âââ client + â â âââ gfac-server + â â âââ orchestrator-server + â â âââ server + â â âââ release + â â âââ xbaya-gui + â âââ gfac + â â âââ airavata-gfac-service + â â âââ gfac-bes + â â âââ gfac-core + â â âââ gfac-ec2 + â â âââ gfac-gram + â â âââ gfac-gsissh + â â âââ gfac-hadoop + â â âââ gfac-local + â â âââ gfac-monitor + â â âââ gfac-ssh + â â âââ gfac-thrift-descriptions + â âââ integration-tests + â âââ messaging + â âââ orchestrator + â âââ registry + â â âââ airavata-jpa-registry + â â âââ registry-cpi + â âââ security + â âââ credential-store + â âââ server + â âââ test-suite + â âââ workflow-model + â â âââ workflow-engine + â â âââ workflow-model-component-node + â â âââ workflow-model-core + â âââ ws-messenger + â â âââ commons + â â âââ distribution + â â âââ messagebox + â â âââ messagebroker + â â âââ message-monitor + â â âââ samples + â âââ xbaya-gui + âââ samples + âââ tools + â âââ gsissh + â âââ gsissh-cli-tools + â âââ phoebus-integration + â âââ registry-migrate + âââ INSTALL + âââ LICENSE + âââ NOTICE + âââ README + âââ RELEASE_NOTES -Other Available Distributions -============================= +Available Binary Distributions +============================== Server Distributions -------------------- @@ -117,10 +118,14 @@ Server Distributions The Airavata Server binary distribution allows you to run a standalone Airavata Server which includes all the airavata services shipped with a default derby database as the backend registry. For stable purposes, a mysql configuration is recommended. -* Airavata Server Web Application - This is similar package as the Airavata Server but is distributed as the server Web Application archive. - This war is compatible with Apache Tomcat application server. The war bundles all airavata services - enabled by defualt to startup a derby database as the backend registry. For stable purposes, a mysql configuration is recommended. +* Airavata API Server + This is the server that contains Airavata API Server. + +* Airavata Orchestrator Server + This is the stand-alone orchestrator server + +* Airavata GFac Server + This is the standalone GFac Server Client Distributions -------------------- @@ -128,7 +133,13 @@ Client Distributions The Airavata XBaya distribution is a client GUI application with features to register applications as web services, construct workflows, execute and monitor workflows and browse the generated results from the airavata registry. -* Airavata XBaya JNLP - The Airavata XBaya JNLP distribution is the simular GUI distribution but prepackeged to be ready to be deployed to - a web server as a web start application. The GUI provides features to register applications as web services, construct workflows, - execute and monitor workflows and browse the generated results from the airavata registry. +* Airavata Client + The Airavata Client distribution is a set of libraries and configurations files that allow a 3rd party application to programatically + access Airavata functionality through Airavata API. + + How to test and run samples +=========================== +* If you built Airavata from source, and if you see "BUILD SUCCESS", then the test cases should have passes. +* The test cases are beyond unit level, they startup embedded services and run through basic workflow use cases. +* To walk through Airavata features, follow "XBAYA Quick-Start Tutorial" tutorial at https://cwiki.apache.org/confluence/display/AIRAVATA/XBAYA+Quick-Start+Tutorial. +* For advanced use cases, please contact mailing lists - http://airavata.apache.org/community/mailing-lists.html
