Tutorial 07 - PHP Reference Gateway for Airavata - Gateway Admin Guide

Introduction to Gateway Admin Portal 

Important

Setting up Gateway Preferences, registering and modifying Compute Resources, Application Modules, Application Interfaces and Application Deployments are tasks for gateway administrators. To follow below steps your user account requires administrator privileges. After you create as User Account send a request to Airavata Mailing List  to obtain admin access.

Tutorial II - Register Compute Resource

1. To register a new compute resource navigate to ‘Compute Resource → Register’ from the main menu.
   Hint: Mandatory fields are tagged with ‘*’
2. In the page; enter
   1. Hostname (Required to communicate with the resource)
   2. Host Aliases
   3. IP addresses
   4. Resource Description
   Click ‘Create’ and save above information. Upon saving another field; Maximum Memory Per Node ( In MB ) will appear. Enter the memory per node and click ‘Save Changes’ button.
3. Upon saving 3 more tabs will appear;
   1. Queues: Enter job queue information in the resource
   2. File System: Enter file path locations of the compute resource
   3. Job Submission Interfaces: Protocol information required for job submissions.
   4. Data Movement Interfaces: Protocol information required for input and output data stagings and transfers.

Queue Tab

1. In Queue tab; click ‘Add Queue’ button and enter;

1. Queue Name (This is a unique and mandatory value. Once entered cannot be modified)

2. Queue Description

3. Queue Max Run Time

4. Queue Max Nodes

5. Queue Max Processors

6. Max Jobs in Queue

7. Max Memory for Queue (in MB)

2. After entering informations click ‘Create’ and save. Can clear any entered information prior to saving by clicking ‘Reset’.

3. After the queue is saved it will get listed under ‘Existing Queues’ and can modify by clicking the <pen image> or can delete by clicking <trash can image>

4. When adding queues can add multiple queues by clicking ‘Add Queue’ Button.

  File System Tab

1. In this tab admin user has to enter information about important or used file locations in the resource.

2. Enter resources file path locations to folders;

1. HOME - HOME folder path of the compute resource

2. LOCAL -

3. LOCALTMP

4. SCRATCH

5. ARCHIVE

3. We use above captured locations for;

1. HOME -

2. LOCAL -

3. LOCALTMP -

4. SCRATCH -

5. ARCHIVE -

Job Submission Interface

1. This is the 4th tab in Register Compute Resource process.
2. Click on ‘Add a New Job Submission Interface’ button
3. Select a relevant job submission protocol from the available protocols;
   1. LOCAL
   2. SSH
   3. GLOBUS
   4. UNCORE
   5. CLOUD
4. If you selected a protocol which is yet to be available, you will see the message; “<Protocol Name> protocol not being set up right now.Please choose another option”
5. Once a protocol is selected enter below parameter for the selected protocol;
   1. Resource Manager - auto populated
   2. Resource Manager Type - Select from existing list; FORK, PBS, SLURM,LSF and UGE
   3. Push Monitoring Endpoint - User has to enter the path
   4. Job Manager Bin Path - User has to enter the path
   5. Job Manager Commands - User can enter commands for;
      1. SUBMISSION
      2. JOB MONITORING
      3. DELETION
      4. CHECK JOB
      5. SHOW QUEUE
      6. SHOW RESERVATION
      7. SHOW START
         IMPORTANT: These commands will be used in the rescue to submit, monitor, delete, etc..submitted jobs.
6. Once all data is entered click ‘Add Job Submission Protocol’ button to save.
7. Once added the particular protocol will not exist to add again.
8. Per resource user can enter multiple protocols and when more than one protocol exists user has to enter priority of them. Click ‘Update Priority’, it will display added protocols and the user can enter priority. These fields are numeric fields.  

Data Movement Interface

1. In the tab click ‘Add a New Data Movement Interface’ button and select a protocol from the available list.

2. For each protocol mandatory fields are be marked with a ‘*’

3. Enter all parameters for the selected data movement interface and click ‘Add Data Movement Protocol’ button to save the parameters.

Search Compute Resource

1. 1. 1. Navigate to the search page through; Main Menu → Compute Resource → Browse.

      2. Name and the ID of all existing compute resources will be displayed. User can also search for the resource by giving the name in the text field above the list.

      3. Through this page user can Edit, View or Delete a compute resources. Icons for each actions are;

      1. To Edit click on the icon ‘Pen’ on the right hand side along with the compute resources name

         1. To View click on the icon ‘Pen’ on the right hand side along with the compute resources name

         1. Depending on the access granted to each user/user role can edit, view or delete the computer resources.

         2. When clicked on ‘Edit’ icon user will be navigated to same set of UIs similar to registraign compute resource.s User can change existing values on each page and update.

Tutorial II - Setting Compute Resource Preferences

1. Navigate through right hand corner 'Dashboard menu item and from there select 'Gateway' from the left top hand corner options.
2. Clicking on 'Gateways' will open Gateway Settings and there the gateway admin can enter gateway preferences for each resource.
3. To add a compute resource first select a resource available for the given list of values.
4. Ones selected a resource parameters required will be listed to enter values;
   1. Login username for the resource
   2. Preferred job submission protocol
   3. Preferred data movement protocol
   4. ...
   5. ...
   6. Scratch location
   7. Project number
5. Above entered values will be picked up at the time of executing experiment jobs at the remote compute resource.

Tutorial III - Create & Search Application Module, Application Interface and Application Deployment

NOTE: Registering and modifying Compute resources, Application Modules, Application Interfaces and Application Deployments are gateway admin’s tasks. When you create an account to follow below steps send a request to obtain admin access to Airavata Mailing List

Create Application Module

1. Navigate to App Catalog → Module and click ‘Create a New Application Module’ button.

2. Enter all required information. Mandatory fields are marked with ‘*’

Search Application Module

1. Navigate to App Catalog → Module. All available application modules will be listed in the page.
2. User can search for a specific module by entering the module name or part of the module name in the text box above the list OR select from the already available list.
3. Her user has the option of;
   1. Editing - Click on the 'Pen' icon in order to edit application module information
   2. Deleting - Click on the 'trash bin' icon in order to delete and user will be displayed with a confirmation message
   3. Viewing - Click on the 'Expandable' icon at the far righthand corner. Will expand and display available information.
      
   available application modules.
4. In an application module the unique key is the auto generated Application ID at the time of saving the application module. In PGA Application Modules name can be repeated if the gateway desires.

Create Application Interface

1. Navigate to App Catalog --> Interface and click on 'Create a new Application Interface' button.
2. Here user can enter;
   1. Application Interface Name (Mandatory)
   2. Application Description
   3. Application Module (User can select multiple modules per interface)
   4. App Application Input and Output (Gateway admin to enter application input and output related parameters. An application interface can have one or many inputs and outputs and also in the form of String, Integer, UR, STDERR. etc...)
3. Click 'Create'

Search Application Interface

1. Navigate to App Catalog --> Interface and click on 'Create a new Application Interface' button.
2. User can search for a specific interface by entering the interface name or part of the interface name in the text box above the list OR select from the already available list.
3. User has the option of;
   1. Editing - Click on the 'Pen' icon in order to edit application interface information
   2. Deleting - Click on the 'trash bin' icon in order to delete and user will be displayed with a confirmation message. User can delete the whole interface or selected output or input form the interface.
   3. Viewing - Click on the 'Expandable' icon at the far righthand corner. Will expand and display available information.
   available application interfaces.
4. In application interface the unique key is the auto generated Application Interface ID at the time of saving the application interface. In PG Application Interface name can be repeated if the gateway desires.
   
   

Create Application Deployment

1. Navigate to App Catalog --> Deployment and click on 'Create a new Application Deployment' button.
2. Here user can select;
   1. Application Module (Mandatory)
   2. Application Compute  Host (Mandatory)
   3. Application Parallelism Path (Mandatory)
3. User can enter;
   
   1. Application Executable Path (Mandatory)
   2. Add Module Load Command
   3. Library Append Path, Prepend Path
   4. Environment
   5. Pre and Post job commands
4. Click 'Create'

Search Application Deployment

1. Navigate to App Catalog --> Deployment and click on 'Create a new Application Deployment' button.
2. User can search for a specific deployment by entering the deployment name or part of the deployment name in the text box above the list OR select from the already available list.
3. User has the option of;
   1. Editing - Click on the 'Pen' icon in order to edit application deployment information
   2. Deleting - Click on the 'trash bin' icon in order to delete and user will be displayed with a confirmation message. User can delete the whole deployment or selected output or input form the deployment.
   3. Viewing - Click on the 'Expandable' icon at the far righthand corner. Will expand and display available information.
   available application deployments.