You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airavata.apache.org by la...@apache.org on 2011/10/31 17:34:46 UTC
svn commit: r1195556 - in /incubator/airavata/trunk/modules/distribution:
resources/INSTALL.txt resources/README.txt src/main/assembly/bin-assembly.xml
Author: lahiru
Date: Mon Oct 31 16:34:45 2011
New Revision: 1195556
URL: http://svn.apache.org/viewvc?rev=1195556&view=rev
Log:
adding documentation to distirbution.
Added:
incubator/airavata/trunk/modules/distribution/resources/INSTALL.txt
incubator/airavata/trunk/modules/distribution/resources/README.txt
Modified:
incubator/airavata/trunk/modules/distribution/src/main/assembly/bin-assembly.xml
Added: incubator/airavata/trunk/modules/distribution/resources/INSTALL.txt
URL: http://svn.apache.org/viewvc/incubator/airavata/trunk/modules/distribution/resources/INSTALL.txt?rev=1195556&view=auto
==============================================================================
--- incubator/airavata/trunk/modules/distribution/resources/INSTALL.txt (added)
+++ incubator/airavata/trunk/modules/distribution/resources/INSTALL.txt Mon Oct 31 16:34:45 2011
@@ -0,0 +1,172 @@
+Installing Apache Airavata 0.0.1-SNAPSHOT
+------------------------------------------------
+
+Build Apache Airavata from Source
+------------------------------
+
+Prerequisites
+-------------
+Java 1.5
+Maven (tested on v 3.0.2)
+
+
+1. Check out the code from SVN.
+
+
+2. Go to project folder and type
+
+ mvn clean install -Dmaven.test.skip=true
+
+
+3. The binary distribution is located at
+
+ <PROJECT DIR>/distribution/target
+
+
+Configuring GFac Service
+------------------------
+Given below are teh configurations for GFac service to be loaded during axis2 startup. Default configuration file can be
+found at <extracted location>/standalone-server/conf/repository.properties.
+
+Configuration Description
+============================= ====================================
+
+jcr.class Your JCR Implementation factory class. Currently we support only Jackrabbit in future we
+(org.apache.jackrabbit.rmi. hope to support other JCR implementations too.(So with this release you do not have to change this parameter).
+repository.RmiRepositoryFactory)
+
+repository.url This is the url of your repository.. Currently this should be the url of your Jackrabbit repository.
+(http://localhost:8081)
+
+
+jcr.user This is the jackrabbit admin user name - If you have change the jackrabbit user name in your jackrabbit instance
+(admin) you have to change this parameter.
+
+jcr.pass This is the jackrabbit admin password - If you have change the jackrabbit default password in your jackrabbit instance
+(admin) you have to change this parameter.
+
+
+scheduler.class Schedular class you want to use.. if you have your own class put that jar in to <extracted location>/standalone-server/lib folder and change this parameter.
+(org.apache.airavata.core.
+gfac.scheduler.impl.SchedulerImpl)
+
+
+datachain.classes Data Service plugin classes.. if you have your own class put that jar in to <extracted location>/standalone-server/lib folder and change this parameter.
+(org.apache.airavata.core.
+gfac.extension.data.RegistryDataService)
+
+prechain.classes Pre execution Plugins classes. For example, GridFTP Input Staging. You have to specify all the classes one by one for the same parameter.
+
+postchain.classes Post execution Plugins classes. For example, GridFTP Output Staging, if you have your own class put that jar in to <extracted location>/standalone-server/lib folder and change this parameter
+
+
+
+Configure WS-Messenger messageBroker service.
+----------------------------------------------
+Given below are the configurations for message broker service. configuration file should be named as
+"msgBroker.properties". This should be included in the class path (e.g. <extracted location>/standalone-server/conf) when broker starts.
+
+Configuration Description
+============================= ====================================
+broker.jdbc.driver Database driver.
+broker.jdbc.url Url string used to connect the database
+broker.start.delivery.thread If set to true message delivery thread will be started.
+(true/false) Applicable when only running broker. User must set this to 'false'
+ if he wishes run message deliver component separately ( e.g. messenger servlet).
+broker.socket.timeout Connection timeout in milliseconds.Set this to '0' if user wishes connections never to be timed out.
+ (not recommended)4000
+broker.storage.type Specifies message, subscriptions should be stored in a database or not. memory or persistent
+(memory/persistent)
+broker.delivery.method Specifies what mechanism to be used deliver messages.
+(serial,parallel,pcrew) serial â single threaded delivery
+ parallel â dynamic thread pool based delivery
+ pcrew â fixed thread pool based delivery
+ serial , parallel or pcrew
+broker.msg.delivery.retries Number of message delivery failures before a url become black listed (default is 2) 2
+consumer.expiration.time.gap Time period (in seconds) a url will be kept blacklisted (default is 5 seconds) 5
+sending.batch.size Maximum number of messages to be send to a one consumer/url at time. applicable if 'broker.delivery.method' is 'pcrew'(default is 10)10
+sending.thread.pool.size Size of the thread pool. only applicable if 'broker.delivery.method' is 'pcrew'. (default is 4) 4
+
+
+Configure WS-Messenger messagebox service
+-----------------------------------------
+Configuration Description
+msgBox.jdbc.driver Database driver.
+msgBox.jdbc.url Url string used to connect the data base
+msgBox.usedatabase If set to 'true' use MySql database. If set to 'false' use inmemory implementation.
+(true,false) In this scenario database settings i.e-broker.jdbc.url is not required.
+
+Run Ws-messenger
+-----------------
+1. User has the option to run broker in several modes. Steps for each mode is given below.
+
+Run standalone version supplied with binary distribution
+---------------------------------------------------------
+
+1. Unzip binary distribution.
+
+2. Change default configurations if needed.
+
+- configuration files is located at:
+ <extracted location>/standalone-server/conf/msgBroker.properties
+ <extracted location>/standalone-server/conf/msgBox.properties
+
+ Run axis2 server by running the command:
+ Linux -
+ <extracted location>/standalone-server/bin/axis2server.sh
+ Windows -
+ <extracted location>/standalone-server/bin/axis2server.bat
+
+Run Ws-messenger using axis2 servlet
+-------------------------------------
+(Tested on tomcat v 6.0.20 & axis2 v1.5.1)
+1. Copy broker aar file to axis2 distribution accordingly.
+2. Create database tables (Scripts can be found <extracted location>/bin/database_scripts)
+3. Set configurations appropriately and copy configuration file ( named msgBroker.properties) to
+
+ <Axis-servlet>/webapps/axis2/WEB-INF/classes
+
+Note: a sample configuration file is located at:
+
+<extracted location>/standalone-server/conf/msgBroker.properties
+<extracted location>/standalone-server/conf/msgBox.properties
+
+4. Start tomcat server.
+
+5. For more information follow how to deploy Apache Axis2 as a Web Application.
+
+
+Run Ws-messenger using a external axis2 distribution
+----------------------------------------------------
+
+1. Copy broker aar file to following location:
+ <AXIS2_DIST_HOME>/repository/services
+
+2. Copy msgBroker.properties and msgBroker.properties file to <AXIS2_DIST_HOME>/conf
+
+ Configure msgBroker.properties with broker.start.delivery=false
+
+3. Start axis2 server.
+
+4. Run message delivery component separately.
+
+5. Deploy messenger servlet on tomcat.
+
+Note: messenger servlet can be found at <extracted_location>/messenger directory.
+
+6. Set configurations appropriately.
+
+ <TOMECAT_HOME>/webapps/messenger/WEB-INF/classes/msgBroker.properties
+ <TOMECAT_HOME>/webapps/messenger/WEB-INF/classes/msgBox.properties
+
+Note: Point to the correct database you want to pick the messages and do the message delivery, and check the
+property axis2.repository to the correct location.
+
+7. Start tomcat.
+
+
+Run Samples
+-----------
+
+To Run samples go to <extracted location>/samples and refer the sample level READM files.
+
Added: incubator/airavata/trunk/modules/distribution/resources/README.txt
URL: http://svn.apache.org/viewvc/incubator/airavata/trunk/modules/distribution/resources/README.txt?rev=1195556&view=auto
==============================================================================
--- incubator/airavata/trunk/modules/distribution/resources/README.txt (added)
+++ incubator/airavata/trunk/modules/distribution/resources/README.txt Mon Oct 31 16:34:45 2011
@@ -0,0 +1,99 @@
+Airavata 0.0.1-SNAPSHOT
+---------------
+
+
+
+
+New Features In This Release
+----------------------------
+
+
+
+Key Features
+------------
+
+
+Issues Fixed in This Release
+----------------------------
+
+
+Installation & Running
+----------------------
+
+For installation and further instructions refer www.airavata.org - Documentation section in right hand panel... That
+contains proper documentation with screenshots.
+
+
+
+Known Issues in This Release
+----------------------------
+
+
+
+Including External Dependencies
+--------------------------------
+
+
+WS-Messenger Binary Distribution Directory Structure
+--------------------------------------------
+
+ AIRAVATA_HOME
+ |-- bin <folder>
+ |-- samples <folder>
+ |-- gui <folder>
+ |-- lib <folder>
+ |-- standalone-server <folder>
+ | |-- lib <folder>
+ | |-- conf <folder>
+ | |-- repository <folder>
+ | -- services <folder>
+ | |-- bin <folder>
+ |-- database_scripts
+ |-- LICENSE.txt <file>
+ |-- README.txt <file>
+ |-- INSTALL.txt <file>
+
+
+ - bin
+ This contains all the executable scripts to run required applications in Airavata distribution.
+ Ex: This contains scripts to run XBaya GUI Application, Airavata Server (Axis2 server with Airavata services which
+ include messageBroker and messageBox with GFac Axis2 services), Jackrabbit executables to run.
+ - samples
+
+ 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.
+
+ - lib
+ This contains all the libraries required to run the client side code with the jars required to run XBaya GUI. So you can
+ easilly separate the server side and client side by separating the standalone-server folder and lib directory during the deployment.
+
+ - gui
+ Contains the scripts to run WS Notification Listener GUI tool
+
+ - standalone-server
+ This contains all the artifacts required during axis2Server runtime with required axis2 service archives
+
+ - standalone-server - lib
+ Contains all the libraries required for Axis2 runtime
+
+ - standalone-server - conf
+ Contains all the configuration files for Axis2 Rutime and messenger services (messagebroker and messagebox)
+
+ - standalone-server - repository - services
+ Contains deployed services in Axis2 runtime.
+
+ - standalone-server - bin
+ Commandline scripts to use to start the SimpleAxis2Server and other Axis2 related scripts.
+
+ - standalone-server - bin - database_scripts
+ Contains the database scripts which are used to create tables for messagebox and messagebroker services
+
+ - README.txt
+ This document.
+
+ - INSTALL.txt
+ This document will contain information on installing Apache-Airavata.
+
+
+
+
Modified: incubator/airavata/trunk/modules/distribution/src/main/assembly/bin-assembly.xml
URL: http://svn.apache.org/viewvc/incubator/airavata/trunk/modules/distribution/src/main/assembly/bin-assembly.xml?rev=1195556&r1=1195555&r2=1195556&view=diff
==============================================================================
--- incubator/airavata/trunk/modules/distribution/src/main/assembly/bin-assembly.xml (original)
+++ incubator/airavata/trunk/modules/distribution/src/main/assembly/bin-assembly.xml Mon Oct 31 16:34:45 2011
@@ -312,14 +312,6 @@
<include>repository.properties</include>
</includes>
</fileSet>
-
- <fileSet>
- <directory>../gfac-core/src/main/resources</directory>
- <outputDirectory>standalone-server/conf</outputDirectory>
- <includes>
- <include>service.properties</include>
- </includes>
- </fileSet>
<fileSet>
<directory>../../samples</directory>
<outputDirectory>samples</outputDirectory>
@@ -334,6 +326,20 @@
<include>axis2.xml</include>
</includes>
</fileSet>
+ <fileSet>
+ <directory>resources</directory>
+ <outputDirectory>.</outputDirectory>
+ <includes>
+ <include>INSTALL.txt</include>
+ </includes>
+ </fileSet>
+ <fileSet>
+ <directory>resources</directory>
+ <outputDirectory>.</outputDirectory>
+ <includes>
+ <include>README.txt</include>
+ </includes>
+ </fileSet>
</fileSets>
<dependencySets>