Versions Compared

Old Version 22

changes.mady.by.user Eroma

Saved on

compared with

New Version Current

changes.mady.by.user Eroma

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

...

  1. Create a folder (ex: SciGaP) in a preferable location in your local machine to clone download the PHP samples from GitHub. Open the created SciGaP folder (...../ cd SciGaP) and clone the files using GitHuB ‘HTTPS clone URL’    
    git clone https://git-wip-usdist.apache.org/repos/asf?p=airavata.git
    Once the cloning is completed you would get a completed message. dist/dev/airavata/0.13/RC0/. 
  2. In the given location download the apache-airavata-php-sdk-0.13-SNAPSHOT-bin.tar.gz
  3. Open the folder which contains the PHP sample scripts. 
    SciGaP → airavata/airavataapache-api/airavata-clientphp-sdks/airavata-php-sdk/src/main/resourcessdk-0.13-SNAPSHOT/php-cli-samples
  4. client-samples  folder contains PHP scripts to exercise currently existing Airavata API methods;
      1. GetAPIVersion.php (a sanity check) 
      2. createProject.php
      3. updateProject.php
      4. getAllUserProjects.php
      5. createExperiment.php
      6. getExperiment.php
      7. updateExperiment.php
      8. cloneExperiment.php
      9. getAllExperimentsInProject.php
      10. getAllUserExperiments.php
      11. search_experiments_by_name.php
      12. search_experiments_by_description.php
      13. search_experiments_by_application.php
      14. launchExperiment.php
      15. terminateExperiment.php 
      16. getExperimentStatus.php
      17. getExperimentOutputs.php
      18. registerComputeResource.php
      19. registerApplicationModulegetAllComputeResourceNames.php

      20. getComputeResource.php

      21. deleteComputeResource.php

      22. registerApplicationModule.php
      23. getApplicationModule.php
      24. getApplicationDeployedResourcesgetAppModule.php
      25. registerApplicationInterface.php
      26. updateApplicationInterface.php
      27. getAllApplicationInterfaceNames.php
      28. deleteApplicationInterface.php
      29. getAvailableAppInterfaceComputeResources.php
      30. registerApplicationDeployment.php
      31. getApplicationDeployedResourcesgetApplicationDeployment.php

      32. getApplicationInputs.php

      33. getApplicationOutputs.php
      34. deleteGatewayComputeResourcePreference.php
      35. getGatewayComputeResourcePreference.php
      36. airavata-client-api-tester.php
  5. Apart for the scripts for the API methods the folder contains;
    1. getAiravataClient.php - This script is referred by all other scripts to obtain Airavata client. Not for stand alone execution.
    2. README.txt - Gives an introduction to the scripts and also reference links to wiki pages with command line script execution information
  6. Navigation to working directory; 
    cd SciGaP/airavata/airavata-api/airavata-client-sdks/airavata-php-sdk/src/main/resources/php-cli-samples

...

  1. Verify the existence of the above created project by using getAllUserProjects.php file 
  2. User = Project owner who creates the Project. User name is given as a command line argument.
    1. Format;
      php getAllUserProjects.php <space><user><space><user>
    2. Sample values;
      user: ThomasPeter
  3. Execute the file; all the projects created by the given user will get listed with project information.

    Image - Project Detail Listing

...

  1. Create an experiment with above created project using createExperiment.php script. When creating experiment User, Experiment name and Project ID (username, experiment_name, project_ID) are passed as arguments to the script.
    1. Format;
      php createExperiment.php<space><username><space><experiment_name><space><project_ID>
  2. Changing other parameters require opening the script and modifying and saving values inside the script. 
    Sample values;

     

    Parameter

    Sample Values

    NOTE

    Project ID

    TestPHP_ProjectEXP1_4063b44017a34aa5-332a68cb-49af41e6-a6deb189-aea21d77bb2f dc94548660a6

    Project iD is validated against existing projects

    Passed as an argument to the script

    Creating User

    ThomasDonald

    Users are validated against existing Airavata gateway users.

    Passed as an argument to the script

    Experiment Name

    Exp_Test_Project_1PHP_EXP

    Not a unique value. Use can enter any value

    Passed as an argument to the script

    Resource Host ID

    stampede.tacc.xsede.org_8f20b832-c11a-444b-8e73-bf15f4760b9a

    		 

    Computational Project Account

    		  

     

    		From Application Catalog

    Total CPU Count

    10

    Number of CPUs required for the experiment

    nodeCount

    10

    Number of nodes required in each CPU

    Number of Threads

    10

    Number of threads per node

    Queue Name

    normal

    if left blank it will pick default queue

    Wall Time Limit

    10

    This is given in minutes

    JobStartTime Application ID

    0 

    		 

    Total Physical Memory

    0

    		 

    Application ID

    SimpleEcho3_ca40f7c6-69ba-4f89-918d-9937cea0ca8f'

    Existing application in the selected resource

    Input Key

    echo_input

    		 

    From Application Catalog

    Input Key

    echo_input

    		 

    Input Input Value

    echo_output=Hello World

    		 

    Output Key

    echo_output

    		 
    Depending on the computational resource used the resource scheduling data part need to be entered by the user. Other defined resource scheduling parts should be commented. 
    Image Removed
    Image - PHP Script Sample
  3. Script has all the resource listed; User has to select a resource to run the experiment and comment the others. User can change existing other parameters as well in the script.
  4. Execute the file; experiment will be created and experiment ID will be generated; ID is the unique value which identifies the experiment in Airavata.
  5. Experiment creation confirmation message;
    Experiment<space><exp_ID><space>created!

...

  1. To clone above modified experiment use cloneExperiment.php.
  2. Cloning will create exact copy of the existing experiment with a new experiment ID, new experiment name in CREATED state. 
  3. To clone the experiment use;
    1. php cloneExperiment.php
    2. Format:
      php cloneExperiment.php<space><exp<space><experiment_ID>id>
  4. Experiment modification confirmation message;
    1. Experiment<space><exp_ID><space>cloned!

      Created<space>clone<space>with<space>ID<space><Experiment_id><space>named<space><experiment_name>

  5. User can clone any experiment created by him/her irrespective of the experiment status.
  6. User can change existing information by updating the newly created experiment.
  7. Tutorial tryout;
    1. Try adding parameters to the script to change other data in the new experiment. E.g.: Exp name, Application, Resource, etc… and execute.

...

  1. Experiments can be searched by providing username along with experiment name or part of the experiment name.
    1. Format;
      php search_experiments_by_name.php<space><username><space><experiment_name>
    2. Example;
      php search_experiments_by_name.php Test_User Exp
  2. When the script is executed; all the experiments which has the given text as part of the name will be listed along with all experiment information.
  3. To view all experiments created by the user use star (*) or percentage percentage mark (%) in the place of experiment name. 

...

  1. Experiments can be searched by providing username along with experiment description or part of the experiment description.
    1. Format;
      php search_experiments_by_description.php<space><username><space><experiment_description>
    2. Example;
      php search_experiments_by_description.php Test_User Test
  2. When the script is executed; all the experiments which has the given text as part of the description will be listed along with all experiment information.
  3. To view all experiments created by the user use star (*) or percentage mark (%) in the place of experiment description. This would list experiment which has no description as well.

...

  1. Experiments can be searched by providing username along with applicationId or part of the applicationId.
    1. Format;
      php search_experiments_by_application.php<space><username><space><applicationID>
    2. Example;
      php search_experiments_by_application.php Test_User Echo
  2. When the script is executed; all the experiments which has the given text as part of the application ID will be listed along with all experiment information.
  3. To view all experiments created by the user use star (*) or percentage mark (%) in the place of applicationID.

...

  1. Once the experiment is COMPLETED (Status of the experiment is checked using above getExperimentStatus.php) user can check the output. 
  2. To check the output  
    1. Format; 
      php getExperimentOutputs.php<space><experiment_id>

...

    1. Image Added 

Image - Sample output

Tutorial VIII - Computational Resources

...

  1. To add computational resources use script; registerComputeResource.php
  2. In order to run the script hostName and resourceDescription are passed as command line arguments.
    1. Format;
      php registerComputeResource.php<space><hostName><space><resourceDescription>
  3. Execute the above and a confirmation message will be prompted along with the resource ID (computResourceId)
    Compute Resource<space><computeResourceId><space>is<space>registered!
  4. Tutorial Tryout;
    Add other parameters to the script as command line arguments and improve the script.
    1. hostAliases

    2. ipAddresses

Tutorial IX - Application Modules

Register Application Module
View Computational Resource
  1. To view computational resource information after creating above; use the script getComputeResource.php
    1. Format;
    2. php getComputeResource.php<space><computeResourceId>

  2. Given information will be available when the script is executed;

    Image Added

View All Computational Resources
  1. User can view all existing resources linked with the gateway using script; getAllComputeResourceNames.php
  2. To add new application module use the script; registerApplicationModule.php
  3. Parameters appModuleName, appModuleVersion and appModuleDescription are passed as command line arguments to the script.
    1. Format;
      php registerApplicationModulegetAllComputeResourceNames.php<space><appModuleName><space><appModuleVersion><space><appModuleDescription>
  4. Successful execution of the script will display the created application module object along with the confirmation message
    Image Removed
  5. Confirmation message contains the application module ID generated at module creation.
    Application Module <appModuleId><space>is<space>registered!
View Application Module 
    1. php
  2. Computational resource names and their IDs will be listed at the script execution.
    Image Added
Delete Computational Resource
  1. User can delete existing computational resource form the gateway by using script; deleteComputeResourceGateway user can view a particular application module details using script; getAppModule.php
    1. Format;
      php getAppModule.php<space><appModuleID>
    Executing the script will display application module object with Application module ID, Application Module name, Description and version.
    Image Removed

Tutorial X - Application Interfaces

Register Application Interface
    1. php deleteComputeResource.php <computeResourceId>
  2. Once the script is executed user will be prompted a successfully deleted message
    Computational Resource<space><computeResourceId><space>successfully<space>deleted

Tutorial IX - Application Modules

Register Application Module
  1. To add new application To register a new application interface using above created application module use the script; registerApplicationInterfaceregisterApplicationModule.php
  2. Along with application interface name and description also need to provide application module ID as  command Parameters appModuleName, appModuleVersion and appModuleDescription are passed as command line arguments to the script.
    1. Format;
      php registerApplicationInterfaceregisterApplicationModule.php<space><appName><space><appDescription><space><appModuleId><appModuleName><space><appModuleVersion><space><appModuleDescription>
  3. Successful execution of the script will display the created application interface module object along with the confirmation message
    Image RemovedImage Added
  4. Confirmation message contains the application interface module ID generated at module creation.
    Application Interface <applicationInterfaceId><space>is<space>registeredModule <appModuleId><space>is<space>registered!

...

View Application

...

Module 
  1. Gateway user can view a particular application module details using script; getApplicationModule.php

...

  1. Application interface registration is required to indicate gateway user, what inputs and outputs required for an application. To register an application interface use script updateApplicationInterface.php to update the above registered application interface.
    1. Format;
      php updateApplicationInterfacegetApplicationModule.php<space><appInterfaceId>php<space><appModuleID>
  2. Execution of Executing the script will update name of the application input and application output.
    Image Removed
  3. Confirmation message contains the application interface ID generated at update.
    Application Interface <applicationInterfaceId><space>is<space>updated!
List Application Interfaces
  1. display application module object with Application module ID, Application Module name, Description and version.
    Image Added
Search Application Deployments 
  1. To view all application deployments of a particle application module use the script; getApplicationDeployedResources.php
  2. By providing the application module ID can view all available application deployments of the applicationFor user to view all existing applications and their application interface ID use; getAllApplicationInterfaceNames.php script.
    1. Format;
      php getAllApplicationInterfaceNamesphp getApplicationDeployedResources.php
  3. All the applications used within the gateway will be listed along with the application interface ID.
    Image Removed
Delete Application Interface
    1. <space><appModuleID>
  2. Output will look like;
    Image Added

Tutorial X - Application Interfaces

Register Application Interface
  1. To register a new application interface using above created application module use User can delete existing application interface by providing the application interface ID as a command line argument to the script; deleteApplicationInterfaceregisterApplicationInterface.php
  2. Format;
    php deleteApplicationInterface.php<space><appInterfaceId>
  3. At sucesful execution a confirmation message will be prompted to coinfrm the deletion
    Application Interface <applicationInterfaceId><space>successfully<space>deleted
List Computational Resources by the Application Interface
  1. User can view all the computational resources which has a particular Application interface deployed by using the script; getAvailableAppInterfaceComputeResources.php
    1. Format;
      php getAvailableAppInterfaceComputeResources.php<space><appInterfaceId>
  2. name and computational resource ID of all the resources with the provided application interface.

Tutorial XI - Application Deployments

Register Application Deployment
  1. When an application module is registered in the system AIravat need to register the deployment of the application module in one or many computational resources. In order to do so user can execute the script;
    registerApplicationDeployment.php
    1. Format;
      php registerApplicationDeployment.php<space><appModuleId><space><computeHostId><space><executablePath>
  2. In order to do deploy user has to give application module ID, computational Host ID and also the executable path of the application deployment.
Search Application Deployments
  1. To view all application deployments of a particle application module use the script; getApplicationDeployedResources.php
  2. By providing the application module ID can view all available application deployments of the application.
    1. Format;
      php getApplicationDeployedResources.php<space><appModuleID>
  3. Output will look like;
    Image Removed

Tutorial XII - View Application Input & Output

View Application Input

...

  1. Format;
    php getApplicationInputs.php

...

Tutorial X - Airavata API tester

  1. This special script consist of several API method executions. 
    1. Format;
      php airavata-client-api-tester.php<space><username>
  2. By this single script user can create project, update the project, create experiment, launch experiment, view experiment, clone experiment, etc... 
  3. Explore the script for more infomration and build on this script.

Useful Commands

...

Action

...

Command

...

Make a directory

...

mkdir <directory name>

...

Navigate to directory

...

cd <directory name>

...

List directory content

...

ls <directory name>

...

Navigate to a directory giving path

...

cd <..../….../…../ directory name>

cd SciGaP/Airavata-PHP-Client-Samples/client-samples

...

Check for PHP existence

...

php –v

...

Install PHP & GIT

...

sudo apt-get install php5-cli

sudo apt-get install git

...

The given sequence will ensure getting a new copy from git reverting all the local changes have made  to the local scripts

...

git reset --hard HEAD

git pull

  1. Along with application interface name and description also need to provide application module ID as  command line arguments to the script.
    1. Format;
      php registerApplicationInterface.php<space><appName><space><appDescription><space><appModuleId>
  2. Successful execution of the script will display the created application interface object along with the confirmation message
    Image Added
  3. Confirmation message contains the application interface ID generated at creation.
    Application Interface <applicationInterfaceId><space>is<space>registered!
Update Application Interface
  1. Application interface registration is required to indicate gateway user, what inputs and outputs required for an application. To register an application interface use script updateApplicationInterface.php to update the above registered application interface.
    1. Format;
      php updateApplicationInterface.php<space><appInterfaceId>
  2. Execution of the script will update name of the application input and application output.
    Image Added
  3. Confirmation message contains the application interface ID generated at update.
    Application Interface <applicationInterfaceId><space>is<space>updated!
List Application Interfaces
  1. For user to view all existing applications and their application interface ID use; getAllApplicationInterfaceNames.php script.
    1. Format;
      php getAllApplicationInterfaceNames.php
  2. All the applications used within the gateway will be listed along with the application interface ID.
    Image Added
Delete Application Interface
  1. User can delete existing application interface by providing the application interface ID as a command line argument to the script; deleteApplicationInterface.php
    1. Format;
      php deleteApplicationInterface.php<space><appInterfaceId>
  2. At sucesful execution a confirmation message will be prompted to coinfrm the deletion
    Application Interface <applicationInterfaceId><space>successfully<space>deleted
List Computational Resources by the Application Interface
  1. User can view all the computational resources which has a particular Application interface deployed by using the script; getAvailableAppInterfaceComputeResources.php
    1. Format;
      php getAvailableAppInterfaceComputeResources.php<space><appInterfaceId>
  2. name and computational resource ID of all the resources which has the provided application deployed will get listed.

Tutorial XI - Application Deployments

Register Application Deployment
  1. When an application module is registered in the system AIravat need to register the deployment of the application module in one or many computational resources. In order to do so user can execute the script;
    registerApplicationDeployment.php
    1. Format;
      php registerApplicationDeployment.php<space><appModuleId><space><computeHostId><space><executablePath>
  2. In order to do deploy user has to give application module ID, computational Host ID and also the executable path of the application deployment.
  3. Tutorial tryout; User can enhance the script to add other parameters such as appDeploymentDescription, libPrependPaths, etc... as command line arguments.
View Application Deployment
  1. Execution of getApplicationDeployment.php script will show all the information related to the application deployment.
    1. Format;
      php getApplicationDeployment.php<space>< appDeploymentId>
  2. When the script is executed it will show;
    Image Added

Tutorial XII - View Application Input & Output

View Application Input
  1. In order to view a particular application input data this script can be used with providing application interface ID
    1. Format;
      php getApplicationInputs.php
  2. At script execution user will be provided with information on application inputs.
    Sample inout information on Echo application
    Image Added

View Application Output
  1. In order to view a particular application output data this script can be used with providing application interface ID
    1. Format;
      php getApplicationOutputs.php
  2. At script execution user will be provided with information on application outputs.
    Sample: Application Output Name: Echoed_Output   Output Type STRING

Tutorial XIII - Gateway Preferences

View Gateway Preference
  1. A gateway can have a resource preference to execute an application when the same application is available in multiple reseoruces.
  2. To find out the gateway preference user can use getGatewayComputeResourcePreference.php script.
    1. Format;
    2. php getGatewayComputeResourcePreference.php<space> <gateway id><space><compute resource id>
Delete Gateway Preference
  1. To delete an existing gateway preference one can use deleteGatewayComputeResourcePreference.php script.

Tutorial XIV - Airavata API tester

  1. This special script consist of several API method executions. 
    1. Format;
      php airavata-client-api-tester.php<space><username>
  2. By this single script user can create project, update the project, create experiment, launch experiment, view experiment, clone experiment, etc... 
  3. Explore the script for more infomration and build on this script.

 

...