Tutorial 06 - Running Airavata Server Locally Using Latest Release in GIT

Running Airavata Server in Local Machine Using Latest Release from GIT

Prerequisites

1. JAVA 8 or above is required

2. Requires RabbitMQ server running in our local machine.

3. Download the RabbitMQ from 

   https://www.rabbitmq.com/download.html

4. Install RabbitMQ as per

   https://www.rabbitmq.com/install-standalone-mac.html

5. Once RabbitMQ is installed and launched In airavata-server.properties file

   1.  for simple scenarios add rabbitmq.broker.url

      rabbitmq.broker.url=amqp://localhost:5672
   2. for production scenarios, give url as #amqp://userName:password@hostName:portNumber/virtualHost
      For this you have to create a new user, virtualhost and give permissions, refer: http://blog.dtzq.com/2012/06/rabbitmq-users-and-virtual-hosts.html
   3. Sample URL rabbitmq.broker.url=amqp://airavata:airavata@localhost:5672/messaging
   4. Commands  you need to execute in order to create a user, virtual host and allow permissions.

      rabbitmqctl add_user airavata airavata

      rabbitmqctl add_vhost messaging

      rabbitmqctl set_permissions -p messaging airavata ".*" ".*" ".*"

      rabbitmqctl set_user_tags airavata administrator
      For more information, refer  http://blog.dtzq.com/2012/06/rabbitmq-users-and-virtual-hosts.htm, https://www.rabbitmq.com/management.html, https://www.rabbitmq.com/man/rabbitmqctl.1.man.html

6. Unzip the downloaded RabbitMQ tar file into a folder in your local machine. To unzip use;

   tar -xvf rabbitmq-server-mac-standalone-3.4.1.tar.gz

7. Start the RabbitMQ server in the bin folder using;

   ./sbin/rabbitmq-server start

   (For  detailed information on getting RabbitMQ started, stoped, etc please visit https://www.rabbitmq.com/download.html)

8. Requires maven (java based code building tool)

   http://maven.apache.org/download.cgi

   http://maven.apache.org/download.cgi#Installation

Start Airavata

1. Create a folder in your local machine to get  copy of Airavata (E.g.: mkdir LocalAiravata). Clone the source (If you have not taken a clone prior) code from github (git clone https://git-wip-us.apache.org/repos/asf/airavata.git) to the above created folder.
2. After the above is completed build the source code by executing following maven command;
   mvn clean install
   Hint: Use mvn clean install -Dmaven.test.skip=true to avoid tests and is recommended for first timers.

3. Copy the tar file to your local folder created above in step 1
   cp airavata/modules/distribution/server/target/apache-airavata-server-0.15-SNAPSHOT-bin.tar.gz ./
   OR
   cp airavata/modules/distribution/server/target/apache-airavata-server-0.15-SNAPSHOT-bin.zip ./ 

4. In the new location where the copied tar/zip file exists; unzip either the tar or zip file of Airavata server distribution using

   unzip apache-airavata-server-0.14-SNAPSHOT-bin.zip

   OR

   tar -xvf apache-airavata-server-0.14-SNAPSHOT-bin.tar.gz

5. Navigate to bin folder which contains file airavata-server.properties;

   cd apache-airavata-server-0.14-SNAPSHOT/bin

   Hint: For users who downloaded the already built version can directly navigate to this bin folder to start Airavata server.

6. Open the airavata-server.properties (vi airavata-server.properties) file and update relevant necesary properties to run Airavata locally.

   <Give more info as for what is important>

7. gfac-config.yaml file updates. explain the content it has

8. In bin start the Airavata server; This may require JAVA_HOME to be defined. Some configurations such as in  bin/zoo.cfg and bin/airavata-server.properties  may have to be adjusted if some ports are already in use. Ports need to be open as well.

   sh airavata-server.sh start (This will run the airavata server in the backgroud in demon mode)

   If you are in the target folder use given to start Airavata server;

   sh apache-airavata-server-0.14-SNAPSHOT/bin/airavata-server.sh start

9. To monitor the server starting up, view the airavata server log;

   tail -f airavata-server.out

10. For subsequent Airavata updates; in the local Airavata folder where source code is cloned, do a git clone https://git-wip-us.apache.org/repos/asf/airavata.git for the latest trunk. Continue from step 2 under 'Start Airavata' in this tutorial.