Author: smarru
Date: Sat Jan 26 16:07:36 2013
New Revision: 1438906
URL: http://svn.apache.org/viewvc?rev=1438906&view=rev
Log:
updating tutorial instructions to match current distribution
Modified:
airavata/site/trunk/content/documentation/system/airavata-in-5-minutes.mdtext
Modified:
airavata/site/trunk/content/documentation/system/airavata-in-5-minutes.mdtext
URL:
http://svn.apache.org/viewvc/airavata/site/trunk/content/documentation/system/airavata-in-5-minutes.mdtext?rev=1438906&r1=1438905&r2=1438906&view=diff
==============================================================================
---
airavata/site/trunk/content/documentation/system/airavata-in-5-minutes.mdtext
(original)
+++
airavata/site/trunk/content/documentation/system/airavata-in-5-minutes.mdtext
Sat Jan 26 16:07:36 2013
@@ -48,31 +48,56 @@ The Tutorial is divided into 3 simple se
###Setting Up Environment
<p name="section1"/>
- 1. [Build from source][1] or download a binary distribution
- 2. If JAVA_HOME is not already set;
- - add/modify following entries in ~/.bashrc file.
+ 1. If JAVA_HOME is not already set, please set it.
+ - Examples:
- export JAVA_HOME=/home/user/installations/jdk1.6.0_27
- export PATH=$JAVA_HOME/bin/
- 3. Extract the Airavata binary distribution to some path in the file system
(say `AIRAVATA_HOME`)
- 1. If you built from source then your binary is in
modules/distribution/target
- 2. If you are using Windows + Cygwin you need to set permissions on some
files with "chmod 755 bin/*.sh"
- - we provide bat scripts for the following actions as well.
- 4. Start airavata:<br>
- * Start SimpleAxis2Server on port 8080<br>
- `$ AIRAVATA_HOME/bin/airavata-server.sh`
- * Start XBaya<br>
- `$ AIRAVATA_HOME/bin/xbaya-gui.sh`
-*The SimpleAxis2Server will expose **SimpleMathServcie**. We will invoke this
service in our XBaya workflow.*
+###Download binaries or build from source
+<p name="section1"/>
+
+ 1. You can download the binaries from [Downloads Page][download]/Release
Vote threads, or [build airavata from source][build].
+ * If you have built from source then the binaries will be in
modules/distribution directory. Please look into appropriate target directory
of airavata-client, airavata-server or xbaya-gui
+ * If you are using Windows + Cygwin you need to set permissions on some
files
+
+ 2. Extract the Airavata Server binary distribution (refering in following
instructions as `AIRAVATA_SERVER_HOME`). The directory name is typically
apache-airavata-server-$version.
+
+ 3. Extract the Airavata XBaya GUI binary distribution (refering in following
instructions as `AIRAVATA_XBAYA_HOME`). The directory name is typically
apache-airavata-xbaya-gui-$version.
+
+ 3. Change persmisisons of shell scripts on both server and xbaya-gui bin
directories
+ * "chmod 755 bin/*.sh"
+ * For windows, there are bat scripts
+
+###Start Airavata Server and Luanch GUI
+<p name="section1"/>
+
+ 1. For quick start purposes, Airavata server is distributed as a standalone
server. The server starts up by defualt on port 8080.
+ * `$ AIRAVATA_SERVER_HOME/bin/airavata-server.sh`
+ 2. Launch Airavata XBaya GUI
+ * `$ AIRAVATA_XBAYA_HOME/bin/xbaya-gui.sh`
-###Creating XBaya Workflows
+**The binary distribution bundles a simple math service to a get a feel for
Airavata and run a helloworld style example. The tutorial intended to
demonstrate construction, execution and monitoring of a workflow using this
simple service.**
+
+###Construct a simple workflow
<p name="section2"/>
-1. Configure XBaya to use the Airavata repository.
+1. Configure XBaya GUI to use the Airavata repository.
- From the main menu select: `Registry` -> `Setup Airavata Registry`
- If you are using the default derby database as your registry from
Airavata use the following information,
<table border="1">
<tr>
+ <td><b>URL</b></td>
+ <td>http://localhost:8080/airavata-registry/api</td>
+ </tr>
+ <tr>
+ <td><b>Gateway</b></td>
+ <td>defualt</td>
+ </tr>
+ <tr>
+ <td><b>Gateway</b></td>
+ <td>defualt</td>
+ </tr>
+ <tr>
<td><b>Username</b></td>
<td>admin</td>
</tr>
@@ -82,20 +107,20 @@ The Tutorial is divided into 3 simple se
</tr>
</table>
- - You will notice a new Component (Application Services) added in
Components view (located in left side of XBaya window).
+ - This step will only succeed if you have previously started the Airavata
Server. If it fails, please verify the server is up and running on port 8080.
-2. Make XBaya aware of simple-math-service.
+2. Import the pre-registered simple-math-service workflow from registry.
- From the main menu select:
- `XBaya` -> `Import` -> `WSDL from URL...`
- Specify the WSDL URL as follows:
-
`http://gw8.quarry.iu.teragrid.org:8090/axis2-samples/services/SimpleMathService?wsdl`
- - If the WSDL was successfully added you will see another Component in
Components view. Expand the new Component
+ - If the WSDL was successfully added you will see another Component in
Left Side Components view. Expand the new Component
until you see the available operations for SimpleMathServcie.
-3. Create the workflow.
+3. Construct a simple workflow.
- - Now create a new workflow from XBaya -> New -> Workflow so you will
get a new workflow sheet in to XBaya.
- - In our workflow we will invoke the greet method in SimpleMathServcie.
+ - First create a new workflow from XBaya -> New -> Workflow so you will
see a new workflow panel loaded into XBaya.
+ - Create a workflow to invoke the greet method in SimpleMathServcie.
- From Components view select & drag-drop the following in to workflow
sheet in the center of XBaya window.
- the `greet` Method
- `Components` -> `System Components` -> `Input`
@@ -105,18 +130,21 @@ The Tutorial is divided into 3 simple se
- You have now successfully created a workflow to invoke the greet
operation in the SimpleMathService.
-###Executing & Monitoring XBaya Workflows
-<p name="section3"/>
+###Executing & Monitoring a Workflow
+
+4. Launch the workflow constructed in previosu steps.
-1. Now Its time to invoke the workflow.
+ - Run the workflow by clicking `Run` -> `Run workflow...`<br> Or just
click on the red play icon at the top panel of XBaya.
+ - Specify the input value a string to greet and a experiment name.
+ - The Workflow Interpreter and and GFac URL can be left with default
values.
+ - Click OK to launch this worklow
- - Inorder to invoke, from the main menu select:
- - `Run` -> `Run workflow...`<br> Or just click on the red play icon
at the top of XBaya.
- - Specify the input Value (Notification topic and GFac URL will work
with default values).
- - Click OK.
+5. The workflow will now launch and the **Monitoring** view at the bottom of
XBaya will show you the progress of the workflow execution.<br>
-2. Your workflow will now launch and the **Monitoring** view at the bottom of
XBaya will show you the progress of
- the workflow execution.<br>
+6. The steps can be repeated to constructed to create simple workflows for
other methods (add, substract and multiply) in the simple math service.
+** This simple tutorial is to demonstrate the use of pre-registered services
and construct simple worklfows. Airavata allows easy creation of such
application services, the [Airavata in 10 minutes tutorial][10minute] will
demonstrate such an example.
-[1]: ../../development/build.html
+[download]: /about/downloads.html
+[build]: /development/build.html
+[10minute]: /documentation/system/airavata-in-10-minutes.html