PGA Configurations

You Need to Have

  1. Airavata & PGA installed and running.
  2. Tenant created in WSO2 IS hosted by you or Airavata team.
  3. Administrator privileges to the gateway. (How do you know? - Can you view Admin Dashboard and view buttons to create applications)

Apache Airavata Component Configuration

  1. For this we use ‘Admin Dashboard’
  2. Gateway Admin need to configure;
    • Compute Resources
    • Storage Resources
    • Gateway Management
    • Application Catalog
      • Application Module
      • Application Interface
      • Application Deployment
    • Credential Store
      • Generate Credential Store Token + SSH Key.
      • Add these to authorized key files and into resource preferences.
    • Notices
      • Notices for all active gateway users.
    • Identity Management

NOTE: for gateways hosted by SciGaP gateway admins/PIs not required to register the compute resources and storage resource. Please skip the 1st and 2nd and go to Gateway Management section.
###Compute Resources

  1. Navigate to Admin Dashboard ⇒ Compute Resources ⇒ Register
  2. Add Host Name, Description and create the resource.
    Hint: host name is used when ssh to the resource from airavata.
  3. Then keep adding information on rest of the appeared tabs.
    • Queues (Queue name is unique and cannot be updated. Can delete and create new if required)
    • File Systems (This is only for information capturing for future use. Currently this information is not used. So can skip if you want)
    • Job Submission Interfaces
    • Data Movement Interfaces
  4. Similarly you can add multiple compute resources in to your gateway by selecting ‘Register’ from the left-hand-side menu.
  5. To view the added compute resources navigate to Admin Dashboard ⇒ Compute Resource ⇒ Browse
  6. All the resources will be listed. Gateway admin can view, edit, delete and enable and disable them.

    ###Storage Resources
  7. Navigate to Admin Dashboard ⇒ Storage Resources ⇒ Register
  8. Add Storage Name, Description and create the resource.
  9. Then add data storage information in
    • Data Movement Interfaces
  10. Similarly you can add multiple storage resources in to your gateway by selecting ‘Register’ from the left-hand-side menu.
  11. To view the added resources navigate to Admin Dashboard ⇒ Storage Resources ⇒ Browse
  12. All the resources will be listed. Gateway admin can view, edit, delete them.
  13. Although enable and disable can be done in registration it's functionality is not yet implemented.

    ###Gateway Management of Resources
  14. Navigate Admin Dashboard ⇒ Gateway Management
  15. Both compute resource and storage resource specific preferences are defined here.
  16. To add compute resource related preferences click “Add a Compute Resource Preference” and select the resource from the drop-down list.
  17. Add/select preferred options and click “Set preferences”.
    Repeat this for all the resources used within the gateway.
  18. For each compute resource, gateway admin need to specify;
    • Preferences can be overridden by Airavata - Yes/No?
    • Resource login name
    • Preferred job submission protocols
    • Preferred data movement protocols
    • Preferred queue
    • Scratch location
    • Project allocation number
    • Resource specific credential store token
      (When added Base Credential Store Token is not valid for the specific resource)
    • Gateway ID for usage reporting
      (This field will only appear if the compute resource registration is set to report usage details back to the resource)
    • Quality of service
    • Reservation name
    • Reservation start and end date time
  19. For adding storage resource preference click “Add a Storage Resource Preferences”, and rest is similar to adding a compute resource preference.
  20. For a gateway currently when a storage resource is selected, that resource ID need to be added in to the pga_config.php file in config folder of the hosted gateway.
  21. For storage resource preference, gateway admin need to add;
    • Login username
    • File System Root Location
    • Resource Specific Credential Store Token
  22. Apart from adding preference the same interface is used to assign a 'Base Credential Store Token". If this is added this is the token used across the gateway for communication with all the compute resources and storage resource.

Application Catalog

  1. Gateway admin add applications in to the gateway. Adding an application is a 3 step process.
  2. Admin need to add application module, interface and deployment information in order to launch specific application jobs on compute resources.
  3. Relationship between application module, interface and deployments. Screenshot
  4. What each step means?
    • Application Module
      • Navigation: Admin Dashboard ⇒ App Catalog ⇒ Module
      • This is the simple introduction of the application; Name, Version and Description.
      • Click ‘Create a New Application Module’, provide information and create. On creation Application Module ID will be generated for the module.
      • All existing modules are listed; Search by name is available for a particular module.
      • Gateway admin can edit, delete existing modules.
      • Deleting a module will be restricted if it has application interfaces and deployments linked.
    • Application interface
      • Navigation: Admin Dashboard ⇒ App Catalog ⇒ Interface
      • Application interface defines the required inputs, outputs produced and their characteristics.
      • Click on ‘Create a New Application Interface’, provide information and create. On creation Application Interface ID will be generated for the module.
      • All available interfaces are also listed; admin has the option of searching for a particular interface by providing the name in the search.
      • Gateway admin can edit, delete existing interfaces.
      • Gateway admin cal also clone an existing interface in order to create a new similar interface with slight changes.
    • Application deployment
      • Navigation: Admin Dashboard ⇒ App Catalog ⇒ Deployment
        • Application deployment describes application deployment details on a specific resource.
        • For an application for each resource there is a separate deployment.
        • A single application can be deployed in multiple resources.
        • Multiple application modules can be deployed in a single resource. E.g: Gaussian09 and Gaussian16 both exists in and they both use same application interface.

Credential Store

  1. Navigation: Admin Dashboard ⇒ Credential Store
  2. This interface is used to generate SSH key + token pairs.
  3. These generated keys can be added in to the authorized key files in each resource for SSH key based communication.
  4. Generated key can be either assigned at gateway level; one key + token pair for all the resources OR have separate key for each resource.
  5. SSH keys are used for communication with compute resources, storage resources and WSO2 identity server.

Identity Server Configuration

  1. Setting up WSO2 IS for the new gateway.
  2. Once PGA is cloned all information related to user identity will be in app/config/pga_config.php. No modifications required for users who are using hosted IS.
  3. For user identity management we could either use Airavata WSO2 IS or users own WSO2 IS.
  4. Download WSO2 Identity Server 5.0 from
  5. Extract the downloaded IS binary archive to a location <IS_HOME>.
  6. Set JAVA_HOME variable and add jdk bin directory to the PATH variable.
  7. Open <IS_HOME>/repository/conf/carbon.xml and change the following property to false <HideAdminServiceWSDLs>false</HideAdminServiceWSDLs>
  8. Execute the following command to run the server sh <IS_HOME>/bin/ You should be able to login to the Identity Server Web App using your browser with url http://localhost:9443/carbon . Default admin credentials are username: admin, password: admin
  9. For more information regarding WSO2 Identity Server refer WSO2 IS Server
    Gateway admin will be provided with;
    • Domain URL for the Gateway
    • Admin User name