Page History

Table of Contents

The intention of these tutorials is to provide a quick glimpse into the Airavata middleware by exercising its features through the hosted version of Airavata Reference Gateway written in PHP hence called PGA (PHP Reference Gateway for Airavata). The user can follow the tutorials in order to experience general capabilities of the middleware.

Airavata Reference Gateway

Airavata PHP Gateway is set of user interfaces to demonstrate the core functionalities provided by Airavata. This tutorial provides step-by-step information for obtaining a complete science gateway experience for science and scholarly communities using Airavata as a middleware platform. Here we would also discuss main features and services provided for gateway communities via Airavata.

...

• Gateway user registration and account verification steps

• How to create and modify use projects

• How to create, execute and monitor experiments.

• How to share experiments and projects

• How to set up own cluster accounts for job submissions.

• How to seek assistance, submit issues and provide user feedback.

For more details on Airavata please visit Airavata site

Test/Demo Environment Details

1. PHP Reference Gateway link;
   https://testdrive.airavata.org
2. Download application input files from;
   Generic sample application inputs 
   Sample application inputs for Gaussian and Gamess

Tutorial I - Gateway User Account

Create Account

1. A new user has to create an account using ‘Create account’ link on top right-hand corner of the gateway top banner.
2. To create an account;
   1. Please enter User information and submit.
   2. Important;
      1. Username cannot have spaces.
      2. Username & password must be longer than 5 characters.
      3. Password need to at least have (a) one lower case letter (b) one upper case letter (c) one number (d) One special character from !@#$%
      4. Enter all the mandatory fields indicated by a star; *.
   3. Account creation page
      1. Link:https://testdrive.airavata.org/create
   
   
3. Account activation;
   1. The user will receive an email upon creating the account in the provided email address to confirm the account creation. The user needs to use the link in the email and provide the gateway username and password.
   2. When the user account is first created it is not active; the user cannot submit jobs to resources. Gateway admin has to activate the user account after validating each user request for a gateway account.
   3. If the account confirmation fails, please contact you gateway admin through the Contact us.
   4. Gateway user will receive an email notifying change of privileges in the gateway when the account is active.
   5. If already logged in, the gateway user needs to log out and log-in again.

Login to Account

1. Once the account is created successfully; log in to the gateway using the created account.
2. Gateway login screen link
   1. https://testdrive.airavata.org/login

Image II I - Login

Password Recovery

1. Gateway user can recover the forgotten password using '(Forgot Password? Click here)' link in the login page.
2. The user needs to provide the username then will receive an URL to add the new password.

Tutorial II -

...

Using Projects

Create Project

1. A Project is simply a grouping for experiments. Every user will have a 'Default Project' which exists when the user logs into the gateway for the first time.
2. To create Projects navigate to ‘Project --> Create’ from the main menu. Enter Project Name (Mandatory) & Project Description (Optional) and save.
3. Project creation screen
   
   Image II - Create Project
4. Upon successful creation, the user is directed to Project Summary page.

Browse Projects

1. Navigation 'Project --> Browse' from the main menu.
2. Search keys are;
   1. Project Name
   2. Project Description
3. Browse Project page;
   
   Image III - Browse Project
4. The user can search for projects by using (*) as a wild character. The * can be used when searching either option; Project name or description.
5. When projects are listed by clicking ‘View’ at the end of the row user can navigate to ‘Project Summary’ page. 
6. In 'Project Summary' all experiments created under the project will be listed along with the list of shared users.
   Image Modified
   Image IV - Project Summary
7. The user can click on the experiment ‘Name’ and navigate to ‘Experiment Summary’ page.

...

Image Removed

...

Share Projects

1. Projects are also used to share with other gateway users. e.g.: Sharing a project with another user will give him access to all his experiments in the project.

2. When sharing projects, the project owner can share with 'write' or 'read' access.

3. Once a project is shared with other users, they will be listed on the project summary page. Refer Image Image IV - Project Summary

...

2. Sharing with 'read' access will enable the users to view the project and experiment in the project. Only the owner can modify the project details and sharing.

3. Sharing with 'write' access will enable the users to view the project and experiment in the project, modify the project and create new experiments using this project. Still, only the owner can modify the project sharing.

4. The project owner can remove, modify sharing of existing users and share with new users at any given time.

Tutorial III - Configure Individual Account on Clusters

...

1. Gateway user can use their own compute resource (cluster) allocation (if exists. if not can use the community allocation) within the gateway to launch jobs.
2. Prior to using the allocation users need to set up the allocation account details in the gateway.

Add Allocation

1. Navigate to User Settings (This is under gateway username in the menu on the righthand side.
   Image Added
   Image V - User Settings Navigation
2. User Settings screen
   Image Added
   Image VI - User Settings 
3. Select 'Compute Resources' from above to add allocation details.
4. Click 'Add a Compute Resource Account'
5. Select the resource from the drop-down list.
6. Provide the required information. NOTE: You may not have allocation project, QOS or Reservation. The minimum requirement is the login username and the scratch location and SSH key.
7. When assigning SSH key by default the default SSH key will be assigned. If the user prefers, can generate a new key and assign here.

Credential Store

1. For individual users to generate new SSH key navigate to User Settings → Credential Store
2. In Credential store you will have the default key displayed and it can be copied to add to your account's 'authorized_keys' file.
3. To generate a new key provide a description and add.
   Image Added
   Image VII - User Settings → Credential Store
4. User can delete keys and also tag any key as the 'default' SSH key.

Add SSH Key to Authorized Keys

1. SSH keys are generated for secure communication between airavata middleware and compute resource.
2. Once SSH key is generated, it needs to be added to the authorized keys file for the user in the respective compute resource/cluster.
3. To add the SSH key login to your account in the cluster.
4. Navigate to .SSH directory and open authorized_keys.
5. Add the SSH key assigned in user settings and save.
6. If you have don't have .ssh directory or the authorized_keys file, create them.

Credentials

TBD

Add Accounts

...

Tutorial IV - Create & Launch Experiment

Create Experiment

1.  Navigation to experiment creation page Main Menu --> Experiment --> Create Experiment
2. Create Experiment Page - Experiment Information
   
   Image VI VIII - Create Experiment
   
   
3. First enter/select given fields;
   1. Experiment Name (Mandatory)
   2. Experiment Description (Optional)
   3. Project (Select from the available LOV. Latest will be on top; auto selected)
   4. Application (Select from the available LOV)
   and click ‘Continue’. At this point, the user can clear any entered fields by clicking ‘Reset Values’ before continuing.
4. Then continue entering Application configuration information.
   1. Experiment application input (Mandatory) - Application input can be in the form of entering data or uploading required input files.
      NOTE: Uploading file validity is not checked by the gateway. User has the responsibility of uploading correct files.
   2. Compute Resource (select from the available LOV. If the application is existing in a single resource, it will be the default value)
   3. Queue (a default value will be taken if not changed by the user)
   4. Node Count (If not entered default value will be taken as the input)
   5. Total Core Count (If not entered default value will be taken as the input)
   6. Wall Time Limit (If not entered default value will be taken as the input)
   7. Total Physical Memory (If not entered default value 0 will be taken as the input)
   8. Notifications: Add email address if required to receive job starting and completing notifications from compute resource itself.
      NOTE: For some compute resources, above default values will not be correct. User needs to change the node count in such cases.
5. Create Experiment - Application Configuration Part
   
   Image VII IX - Create Experiment Contd..
   
   
6. While entering application configurations user can start over from the beginning using ‘Start Over’ button.
7. Once saved or saved and launched user will be directed to ‘Experiment Summary’ page; from summary page can monitor experiment status changes.
8. Experiment Summary Page
   
   Image VIII X - Experiment Summary

Launch Experiment

1. The experiment can be launched using 'Create Experiment' screen. Click  'Save & Launch' button to directly launch the experiment.
2. If the experiment was just CREATED for a later launch, the user can launch from 'Experiment Summary' Page. For experiments that are 'launchable' 'Launch' button will be enabled in summary page.
   NOTE: Experiments only in CREATED state can be launched.

Tutorial V - Browse Experiments

1. User can search for experiment created by him/her through
   1. Experiments → Browse
      OR
   2. Browse Projects → View Project → View Experiment (by clicking on the status of the experiment) - Please refer Search Projects in "Tutorial II" above.

2. In Browe Experiments search keys are;

1. Experiment Name

2. Experiment Description

3. Application

4. Creation Time - User can provide 'From Date' and 'To Date'

   
   

   Image IX XI - Browse Experiments

3. All the experiments of the user will be listed; latest on top. The user can also search using provided keys with partial values, complete values, (*) wildcard. Above search can be narrowed by combining with experiment status as well.

4. By clicking on the 'Status' user will be navigated to ‘Experiment Summary’ screen of each experiment.

5. Experiment summary can be used to;

   1. Launch experiment - Explained in above Tutorial III

   2. Cancel experiment

   3. Clone experiment

   4. Edit experiment

   5. View experiment data files (Inputs, outputs, archived files)

Tutorial VI - Modify, Cancel, Clone & Share Experiments

Modify Experiment

1. Modify experiment by clicking on the edit icon (pencil) next to experiment name (In Browse Experiment, Project Summary) OR by clicking on ‘Edit’ button in Experiment Summary Page.
2. User can modify all available fields except experiment status, project, application & experiment ID of experiments only in CREATED state.  

Image X XII - Edit Experiment

Cancel Experiment 

1. To cancel use 'Cancel' button in 'Experiment Summary’ screen.
2. Experiment with statuses LAUNCHED and EXECUTING can only be canceled.
3. When canceled, immediately the Experiment status will change to CANCELING.
4. If the job is already processed in the remote resource (already COMPLETED in the resource) the job will have COMPLETE state and experiment status will change to CANCELLED. Since the user requested a cancellation generated output will not be provided back to the gateway.
5. If the job was successfully CANCELLED upon changing the job state to CANCELLED experiment status will also change to CANCELED.
6. Once canceled, experiments are only available for cloning, cannot resume.

Clone Experiment

1. Experiments can be cloned irrespective of the experiment status by clicking ‘Clone’ in ‘Experiment Summary’ page.
2. When clicks ‘Clone’ from experiment summary user will be navigated to ‘Edit Experiment’ page of the new experiment. The new experiment will have exact same information as the earlier existing experiment.   
3. The new experiment will have a new experiment ID and the status will always be CREATED.
   New experiment name = Clone of + Old experiment name
4. The user can change existing information (except the Application) in ‘Edit Experiment’ page and save or save & launch.

Share Experiment

1. A user can share his or her work with other gateway users at experiment level and at a project level. Project level sharing details 

Tutorial VII - User Assistance

Report Issue

1. Gateway user can report issues faced within the gateway through this page.

2. Page navigation: Help → Report Issue

3. Raise a Bug Page

Image Removed

Image XII - Raise a Bug

Request Feature

1. Gateway allows users to provide feedback as well as request for new applications via Request Feature Page.

2. Page Navigation; Help → Request Feature

3. Got Feedback? Page

Image Removed

...

'Contact Us' in home page provides communication with the gateway admin via email. Gateway users can use this for all gateway related communications such as

1. Report an issue
2. Request for a feature
3. Feature clarification