Added: airavata/site/trunk/content/documentation/api-docs/0.16/airavata_commons.html URL: http://svn.apache.org/viewvc/airavata/site/trunk/content/documentation/api-docs/0.16/airavata_commons.html?rev=1720388&view=auto ============================================================================== --- airavata/site/trunk/content/documentation/api-docs/0.16/airavata_commons.html (added) +++ airavata/site/trunk/content/documentation/api-docs/0.16/airavata_commons.html Wed Dec 16 16:25:38 2015 @@ -0,0 +1,44 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<meta http-equiv="Content-Type" content="text/html;charset=utf-8" /> +<link href="style.css" rel="stylesheet" type="text/css"/> +<title>Thrift module: airavata_commons</title></head><body> +<div class="container-fluid"> +<h1>Thrift module: airavata_commons</h1> +<table class="table-bordered table-striped table-condensed"><thead><th>Module</th><th>Services</th><th>Data types</th><th>Constants</th></thead> +<tr> +<td>airavata_commons</td><td></td> +<td><a href="#Struct_ErrorModel">ErrorModel</a><br/> +<a href="#Struct_ValidationResults">ValidationResults</a><br/> +<a href="#Struct_ValidatorResult">ValidatorResult</a><br/> +</td> +<td><code><a href="#Const_DEFAULT_ID">DEFAULT_ID</a></code><br/> +</code></td> +</tr></table> +<hr/><h2 id="Constants">Constants</h2> +<table class="table-bordered table-striped table-condensed"><thead><th>Constant</th><th>Type</th><th>Value</th></thead> +<tr id="Const_DEFAULT_ID"><td><code>DEFAULT_ID</code></td><td><code>string</code></td><td><code>"DO_NOT_SET_AT_CLIENTS"</code></td></tr></table><hr/><h2 id="Structs">Data structures</h2> +<div class="definition"><h3 id="Struct_ErrorModel">Struct: ErrorModel</h3> +<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead> +<tr><td>1</td><td>errorId</td><td><code>string</code></td><td></td><td>required</td><td><code>"DO_NOT_SET_AT_CLIENTS"</code></td></tr> +<tr><td>2</td><td>creationTime</td><td><code>i64</code></td><td></td><td>optional</td><td></td></tr> +<tr><td>3</td><td>actualErrorMessage</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> +<tr><td>4</td><td>userFriendlyMessage</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> +<tr><td>5</td><td>transientOrPersistent</td><td><code>bool</code></td><td></td><td>optional</td><td><code>false</code></td></tr> +<tr><td>6</td><td>rootCauseErrorIdList</td><td><code>list<<code>string</code>></code></td><td></td><td>optional</td><td></td></tr> +</table><br/></div><div class="definition"><h3 id="Struct_ValidatorResult">Struct: ValidatorResult</h3> +<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead> +<tr><td>1</td><td>result</td><td><code>bool</code></td><td></td><td>required</td><td></td></tr> +<tr><td>2</td><td>errorDetails</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> +</table><br/>This data structure can be used to store the validation results +captured during validation step and during the launchExperiment +operation it can be easilly checked to see the errors occured +during the experiment launch operation + +<br/></div><div class="definition"><h3 id="Struct_ValidationResults">Struct: ValidationResults</h3> +<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead> +<tr><td>1</td><td>validationState</td><td><code>bool</code></td><td></td><td>required</td><td></td></tr> +<tr><td>2</td><td>validationResultList</td><td><code>list<<code><a href="#Struct_ValidatorResult">ValidatorResult</a></code>></code></td><td></td><td>required</td><td></td></tr> +</table><br/></div></div></body></html>
Added: airavata/site/trunk/content/documentation/api-docs/0.16/airavata_data_models.html URL: http://svn.apache.org/viewvc/airavata/site/trunk/content/documentation/api-docs/0.16/airavata_data_models.html?rev=1720388&view=auto ============================================================================== --- airavata/site/trunk/content/documentation/api-docs/0.16/airavata_data_models.html (added) +++ airavata/site/trunk/content/documentation/api-docs/0.16/airavata_data_models.html Wed Dec 16 16:25:38 2015 @@ -0,0 +1,16 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<meta http-equiv="Content-Type" content="text/html;charset=utf-8" /> +<link href="style.css" rel="stylesheet" type="text/css"/> +<title>Thrift module: airavata_data_models</title></head><body> +<div class="container-fluid"> +<h1>Thrift module: airavata_data_models</h1> +<table class="table-bordered table-striped table-condensed"><thead><th>Module</th><th>Services</th><th>Data types</th><th>Constants</th></thead> +<tr> +<td>airavata_data_models</td><td></td> +<td></td> +<td></code></td> +</tr></table> +</div></body></html> Added: airavata/site/trunk/content/documentation/api-docs/0.16/airavata_errors.html URL: http://svn.apache.org/viewvc/airavata/site/trunk/content/documentation/api-docs/0.16/airavata_errors.html?rev=1720388&view=auto ============================================================================== --- airavata/site/trunk/content/documentation/api-docs/0.16/airavata_errors.html (added) +++ airavata/site/trunk/content/documentation/api-docs/0.16/airavata_errors.html Wed Dec 16 16:25:38 2015 @@ -0,0 +1,143 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<meta http-equiv="Content-Type" content="text/html;charset=utf-8" /> +<link href="style.css" rel="stylesheet" type="text/css"/> +<title>Thrift module: airavata_errors</title></head><body> +<div class="container-fluid"> +<h1>Thrift module: airavata_errors</h1> +<table class="table-bordered table-striped table-condensed"><thead><th>Module</th><th>Services</th><th>Data types</th><th>Constants</th></thead> +<tr> +<td>airavata_errors</td><td></td> +<td><a href="#Struct_AiravataClientException">AiravataClientException</a><br/> +<a href="#Enum_AiravataErrorType">AiravataErrorType</a><br/> +<a href="#Struct_AiravataSystemException">AiravataSystemException</a><br/> +<a href="#Struct_AuthenticationException">AuthenticationException</a><br/> +<a href="#Struct_AuthorizationException">AuthorizationException</a><br/> +<a href="#Struct_ExperimentNotFoundException">ExperimentNotFoundException</a><br/> +<a href="#Struct_InvalidRequestException">InvalidRequestException</a><br/> +<a href="#Struct_LaunchValidationException">LaunchValidationException</a><br/> +<a href="#Struct_ProjectNotFoundException">ProjectNotFoundException</a><br/> +<a href="#Struct_TimedOutException">TimedOutException</a><br/> +<a href="#Struct_ValidationResults">ValidationResults</a><br/> +<a href="#Struct_ValidatorResult">ValidatorResult</a><br/> +</td> +<td></code></td> +</tr></table> +<hr/><h2 id="Enumerations">Enumerations</h2> +<div class="definition"><h3 id="Enum_AiravataErrorType">Enumeration: AiravataErrorType</h3> +A list of Airavata API Error Message Types + + UNKNOWN: No information available about the error + + PERMISSION_DENIED: Not permitted to perform action + + INTERNAL_ERROR: Unexpected problem with the service + + AUTHENTICATION_FAILURE: The client failed to authenticate. + + INVALID_AUTHORIZATION: Security Token and/or Username and/or password is incorrect + + AUTHORIZATION_EXPIRED: Authentication token expired + + UNKNOWN_GATEWAY_ID: The gateway is not registered with Airavata. + + UNSUPPORTED_OPERATION: Operation denied because it is currently unsupported. +<br/><br/><table class="table-bordered table-striped table-condensed"> +<tr><td><code>UNKNOWN</code></td><td><code>0</code></td><td> +</td></tr> +<tr><td><code>PERMISSION_DENIED</code></td><td><code>1</code></td><td> +</td></tr> +<tr><td><code>INTERNAL_ERROR</code></td><td><code>2</code></td><td> +</td></tr> +<tr><td><code>AUTHENTICATION_FAILURE</code></td><td><code>3</code></td><td> +</td></tr> +<tr><td><code>INVALID_AUTHORIZATION</code></td><td><code>4</code></td><td> +</td></tr> +<tr><td><code>AUTHORIZATION_EXPIRED</code></td><td><code>5</code></td><td> +</td></tr> +<tr><td><code>UNKNOWN_GATEWAY_ID</code></td><td><code>6</code></td><td> +</td></tr> +<tr><td><code>UNSUPPORTED_OPERATION</code></td><td><code>7</code></td><td> +</td></tr> +</table></div> +<hr/><h2 id="Structs">Data structures</h2> +<div class="definition"><h3 id="Struct_ExperimentNotFoundException">Exception: ExperimentNotFoundException</h3> +<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead> +<tr><td>1</td><td>message</td><td><code>string</code></td><td></td><td>required</td><td></td></tr> +</table><br/>This exception is thrown when a client asks to perform an operation on an experiment that does not exist. + +identifier: A description of the experiment that was not found on the server. + +key: The value passed from the client in the identifier, which was not found. +<br/></div><div class="definition"><h3 id="Struct_ProjectNotFoundException">Exception: ProjectNotFoundException</h3> +<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead> +<tr><td>1</td><td>message</td><td><code>string</code></td><td></td><td>required</td><td></td></tr> +</table><br/>1: optional string identifier, +2: optional string key + +<br/></div><div class="definition"><h3 id="Struct_InvalidRequestException">Exception: InvalidRequestException</h3> +<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead> +<tr><td>1</td><td>message</td><td><code>string</code></td><td></td><td>required</td><td></td></tr> +</table><br/>This exception is thrown for invalid requests that occur from any reasons like required input parameters are missing, + or a parameter is malformed. + + message: contains the associated error message. +<br/></div><div class="definition"><h3 id="Struct_TimedOutException">Exception: TimedOutException</h3> +<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead> +</table><br/>This exception is thrown when RPC timeout gets exceeded. +<br/></div><div class="definition"><h3 id="Struct_AuthenticationException">Exception: AuthenticationException</h3> +<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead> +<tr><td>1</td><td>message</td><td><code>string</code></td><td></td><td>required</td><td></td></tr> +</table><br/>This exception is thrown for invalid sshKeyAuthentication requests. + + message: contains the cause of the authorization failure. +<br/></div><div class="definition"><h3 id="Struct_AuthorizationException">Exception: AuthorizationException</h3> +<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead> +<tr><td>1</td><td>message</td><td><code>string</code></td><td></td><td>required</td><td></td></tr> +</table><br/>This exception is thrown for invalid authorization requests such user does not have acces to an aplication or resource. + + message: contains the authorization failure message +<br/></div><div class="definition"><h3 id="Struct_AiravataClientException">Exception: AiravataClientException</h3> +<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead> +<tr><td>1</td><td>airavataErrorType</td><td><code><a href="#Enum_AiravataErrorType">AiravataErrorType</a></code></td><td></td><td>required</td><td></td></tr> +<tr><td>2</td><td>parameter</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> +</table><br/>This exception is thrown by Airavata Services when a call fails as a result of +a problem that a client may be able to resolve. For example, if the user +attempts to execute an application on a resource gateway does not have access to. + +This exception would not be used for internal system errors that do not +reflect user actions, but rather reflect a problem within the service that +the client cannot resolve. + +airavataErrorType: The message type indicating the error that occurred. + must be one of the values of AiravataErrorType. + +parameter: If the error applied to a particular input parameter, this will + indicate which parameter. +<br/></div><div class="definition"><h3 id="Struct_ValidatorResult">Struct: ValidatorResult</h3> +<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead> +<tr><td>1</td><td>result</td><td><code>bool</code></td><td></td><td>required</td><td></td></tr> +<tr><td>2</td><td>errorDetails</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> +</table><br/></div><div class="definition"><h3 id="Struct_ValidationResults">Struct: ValidationResults</h3> +<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead> +<tr><td>1</td><td>validationState</td><td><code>bool</code></td><td></td><td>required</td><td></td></tr> +<tr><td>2</td><td>validationResultList</td><td><code>list<<code><a href="#Struct_ValidatorResult">ValidatorResult</a></code>></code></td><td></td><td>required</td><td></td></tr> +</table><br/></div><div class="definition"><h3 id="Struct_LaunchValidationException">Exception: LaunchValidationException</h3> +<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead> +<tr><td>1</td><td>validationResult</td><td><code><a href="#Struct_ValidationResults">ValidationResults</a></code></td><td></td><td>required</td><td></td></tr> +<tr><td>2</td><td>errorMessage</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> +</table><br/></div><div class="definition"><h3 id="Struct_AiravataSystemException">Exception: AiravataSystemException</h3> +<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead> +<tr><td>1</td><td>airavataErrorType</td><td><code><a href="#Enum_AiravataErrorType">AiravataErrorType</a></code></td><td></td><td>required</td><td></td></tr> +<tr><td>2</td><td>message</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> +</table><br/>This exception is thrown by Airavata Services when a call fails as a result of +a problem in the service that could not be changed through client's action. + +airavataErrorType: The message type indicating the error that occurred. + must be one of the values of AiravataErrorType. + +message: This may contain additional information about the error + +<br/></div></div></body></html> Added: airavata/site/trunk/content/documentation/api-docs/0.16/application_deployment_model.html URL: http://svn.apache.org/viewvc/airavata/site/trunk/content/documentation/api-docs/0.16/application_deployment_model.html?rev=1720388&view=auto ============================================================================== --- airavata/site/trunk/content/documentation/api-docs/0.16/application_deployment_model.html (added) +++ airavata/site/trunk/content/documentation/api-docs/0.16/application_deployment_model.html Wed Dec 16 16:25:38 2015 @@ -0,0 +1,138 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<meta http-equiv="Content-Type" content="text/html;charset=utf-8" /> +<link href="style.css" rel="stylesheet" type="text/css"/> +<title>Thrift module: application_deployment_model</title></head><body> +<div class="container-fluid"> +<h1>Thrift module: application_deployment_model</h1> +This file describes the definitions of the Data Structures related to deployment of Application on + computational resources. + +<br/><table class="table-bordered table-striped table-condensed"><thead><th>Module</th><th>Services</th><th>Data types</th><th>Constants</th></thead> +<tr> +<td>application_deployment_model</td><td></td> +<td><a href="#Struct_ApplicationDeploymentDescription">ApplicationDeploymentDescription</a><br/> +<a href="#Struct_ApplicationModule">ApplicationModule</a><br/> +<a href="#Enum_ApplicationParallelismType">ApplicationParallelismType</a><br/> +<a href="#Struct_CommandObject">CommandObject</a><br/> +<a href="#Struct_SetEnvPaths">SetEnvPaths</a><br/> +</td> +<td></code></td> +</tr></table> +<hr/><h2 id="Enumerations">Enumerations</h2> +<div class="definition"><h3 id="Enum_ApplicationParallelismType">Enumeration: ApplicationParallelismType</h3> +Enumeration of application parallelism supported by Airavata + +SERIAL: + Single processor applications without any parallelization. + +MPI: + Messaging Passing Interface. + +OPENMP: + Shared Memory Implementtaion. + +OPENMP_MPI: + Hybrid Applications. + +<br/><br/><table class="table-bordered table-striped table-condensed"> +<tr><td><code>SERIAL</code></td><td><code>0</code></td><td> +</td></tr> +<tr><td><code>MPI</code></td><td><code>1</code></td><td> +</td></tr> +<tr><td><code>OPENMP</code></td><td><code>2</code></td><td> +</td></tr> +<tr><td><code>OPENMP_MPI</code></td><td><code>3</code></td><td> +</td></tr> +<tr><td><code>CCM</code></td><td><code>4</code></td><td> +</td></tr> +<tr><td><code>CRAY_MPI</code></td><td><code>5</code></td><td> +</td></tr> +</table></div> +<hr/><h2 id="Structs">Data structures</h2> +<div class="definition"><h3 id="Struct_SetEnvPaths">Struct: SetEnvPaths</h3> +<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead> +<tr><td>1</td><td>name</td><td><code>string</code></td><td></td><td>required</td><td></td></tr> +<tr><td>2</td><td>value</td><td><code>string</code></td><td></td><td>required</td><td></td></tr> +<tr><td>3</td><td>envPathOrder</td><td><code>i32</code></td><td></td><td>optional</td><td></td></tr> +</table><br/>Key Value pairs to be used to set environments + +name: + Name of the environment variable such as PATH, LD_LIBRARY_PATH, NETCDF_HOME. + +value: + Value of the environment variable to set + +envPathOrder: + The order of the setting of the env variables when there are multiple env variables +<br/></div><div class="definition"><h3 id="Struct_CommandObject">Struct: CommandObject</h3> +<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead> +<tr><td>1</td><td>command</td><td><code>string</code></td><td></td><td>required</td><td></td></tr> +<tr><td>2</td><td>commandOrder</td><td><code>i32</code></td><td></td><td>optional</td><td></td></tr> +</table><br/>Job commands to be used in Pre Job, Post Job and Module Load Commands + +command: + The actual command in string format + +commandOrder: + Order of the command in the multiple command situation +<br/></div><div class="definition"><h3 id="Struct_ApplicationModule">Struct: ApplicationModule</h3> +<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead> +<tr><td>1</td><td>appModuleId</td><td><code>string</code></td><td></td><td>required</td><td><code>"DO_NOT_SET_AT_CLIENTS"</code></td></tr> +<tr><td>2</td><td>appModuleName</td><td><code>string</code></td><td></td><td>required</td><td></td></tr> +<tr><td>3</td><td>appModuleVersion</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> +<tr><td>4</td><td>appModuleDescription</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> +</table><br/>Application Module Information. A module has to be registered before registering a deployment. + +appModuleId: Airavata Internal Unique Job ID. This is set by the registry. + +appModuleName: + Name of the application module. + +appModuleVersion: + Version of the application. + +appModuleDescription: + Descriprion of the Module + +<br/></div><div class="definition"><h3 id="Struct_ApplicationDeploymentDescription">Struct: ApplicationDeploymentDescription</h3> +<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead> +<tr><td>1</td><td>appDeploymentId</td><td><code>string</code></td><td></td><td>required</td><td><code>"DO_NOT_SET_AT_CLIENTS"</code></td></tr> +<tr><td>2</td><td>appModuleId</td><td><code>string</code></td><td></td><td>required</td><td></td></tr> +<tr><td>3</td><td>computeHostId</td><td><code>string</code></td><td></td><td>required</td><td></td></tr> +<tr><td>4</td><td>executablePath</td><td><code>string</code></td><td></td><td>required</td><td></td></tr> +<tr><td>5</td><td>parallelism</td><td><code><a href="#Enum_ApplicationParallelismType">ApplicationParallelismType</a></code></td><td></td><td>required</td><td><code><code><a href="#Const_ApplicationParallelismType.SERIAL">ApplicationParallelismType.SERIAL</a></code></code></td></tr> +<tr><td>6</td><td>appDeploymentDescription</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> +<tr><td>7</td><td>moduleLoadCmds</td><td><code>list<<code><a href="#Struct_CommandObject">CommandObject</a></code>></code></td><td></td><td>optional</td><td></td></tr> +<tr><td>8</td><td>libPrependPaths</td><td><code>list<<code><a href="#Struct_SetEnvPaths">SetEnvPaths</a></code>></code></td><td></td><td>optional</td><td></td></tr> +<tr><td>9</td><td>libAppendPaths</td><td><code>list<<code><a href="#Struct_SetEnvPaths">SetEnvPaths</a></code>></code></td><td></td><td>optional</td><td></td></tr> +<tr><td>10</td><td>setEnvironment</td><td><code>list<<code><a href="#Struct_SetEnvPaths">SetEnvPaths</a></code>></code></td><td></td><td>optional</td><td></td></tr> +<tr><td>11</td><td>preJobCommands</td><td><code>list<<code><a href="#Struct_CommandObject">CommandObject</a></code>></code></td><td></td><td>optional</td><td></td></tr> +<tr><td>12</td><td>postJobCommands</td><td><code>list<<code><a href="#Struct_CommandObject">CommandObject</a></code>></code></td><td></td><td>optional</td><td></td></tr> +</table><br/>Application Deployment Description + +appDeploymentId: Airavata Internal Unique Job ID. This is set by the registry. + +appModuleName: + Application Module Name. This has to be precise describing the binary. + +computeHostId: + This ID maps application deployment to a particular resource previously described within Airavata. + Example: Stampede is first registered and refered when registering WRF. + +moduleLoadCmd: + Command string to load modules. This will be placed in the job submisison + Ex: module load amber + +libPrependPaths: + prepend to a path variable the value + +libAppendPaths: + append to a path variable the value + +setEnvironment: + assigns to the environment variable "NAME" the value + +<br/></div></div></body></html> Added: airavata/site/trunk/content/documentation/api-docs/0.16/application_interface_model.html URL: http://svn.apache.org/viewvc/airavata/site/trunk/content/documentation/api-docs/0.16/application_interface_model.html?rev=1720388&view=auto ============================================================================== --- airavata/site/trunk/content/documentation/api-docs/0.16/application_interface_model.html (added) +++ airavata/site/trunk/content/documentation/api-docs/0.16/application_interface_model.html Wed Dec 16 16:25:38 2015 @@ -0,0 +1,40 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<meta http-equiv="Content-Type" content="text/html;charset=utf-8" /> +<link href="style.css" rel="stylesheet" type="text/css"/> +<title>Thrift module: application_interface_model</title></head><body> +<div class="container-fluid"> +<h1>Thrift module: application_interface_model</h1> +This file describes the definitions of the Data Structures of Application interfaces. These interfaces are mapped + to application mapping on various resources. + +<br/><table class="table-bordered table-striped table-condensed"><thead><th>Module</th><th>Services</th><th>Data types</th><th>Constants</th></thead> +<tr> +<td>application_interface_model</td><td></td> +<td><a href="#Struct_ApplicationInterfaceDescription">ApplicationInterfaceDescription</a><br/> +</td> +<td></code></td> +</tr></table> +<hr/><h2 id="Structs">Data structures</h2> +<div class="definition"><h3 id="Struct_ApplicationInterfaceDescription">Struct: ApplicationInterfaceDescription</h3> +<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead> +<tr><td>1</td><td>applicationInterfaceId</td><td><code>string</code></td><td></td><td>required</td><td><code>"DO_NOT_SET_AT_CLIENTS"</code></td></tr> +<tr><td>2</td><td>applicationName</td><td><code>string</code></td><td></td><td>required</td><td></td></tr> +<tr><td>3</td><td>applicationDescription</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> +<tr><td>4</td><td>applicationModules</td><td><code>list<<code>string</code>></code></td><td></td><td>optional</td><td></td></tr> +<tr><td>5</td><td>applicationInputs</td><td><code>list<<code><a href="application_io_models.html#Struct_InputDataObjectType">application_io_models.InputDataObjectType</a></code>></code></td><td></td><td>optional</td><td></td></tr> +<tr><td>6</td><td>applicationOutputs</td><td><code>list<<code><a href="application_io_models.html#Struct_OutputDataObjectType">application_io_models.OutputDataObjectType</a></code>></code></td><td></td><td>optional</td><td></td></tr> +</table><br/>Application Interface Description + +applicationModules: + Associate all application modules with versions which interface is applicable to. + +applicationInputs: + Inputs to be passed to the application + +applicationOutputs: + Outputs generated from the application + +<br/></div></div></body></html> Added: airavata/site/trunk/content/documentation/api-docs/0.16/application_io_models.html URL: http://svn.apache.org/viewvc/airavata/site/trunk/content/documentation/api-docs/0.16/application_io_models.html?rev=1720388&view=auto ============================================================================== --- airavata/site/trunk/content/documentation/api-docs/0.16/application_io_models.html (added) +++ airavata/site/trunk/content/documentation/api-docs/0.16/application_io_models.html Wed Dec 16 16:25:38 2015 @@ -0,0 +1,111 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<meta http-equiv="Content-Type" content="text/html;charset=utf-8" /> +<link href="style.css" rel="stylesheet" type="text/css"/> +<title>Thrift module: application_io_models</title></head><body> +<div class="container-fluid"> +<h1>Thrift module: application_io_models</h1> +<table class="table-bordered table-striped table-condensed"><thead><th>Module</th><th>Services</th><th>Data types</th><th>Constants</th></thead> +<tr> +<td>application_io_models</td><td></td> +<td><a href="#Enum_DataType">DataType</a><br/> +<a href="#Struct_InputDataObjectType">InputDataObjectType</a><br/> +<a href="#Struct_OutputDataObjectType">OutputDataObjectType</a><br/> +</td> +<td></code></td> +</tr></table> +<hr/><h2 id="Enumerations">Enumerations</h2> +<div class="definition"><h3 id="Enum_DataType">Enumeration: DataType</h3> +Data Types supported in Airavata. The primitive data types + +<br/><br/><table class="table-bordered table-striped table-condensed"> +<tr><td><code>STRING</code></td><td><code>0</code></td><td> +</td></tr> +<tr><td><code>INTEGER</code></td><td><code>1</code></td><td> +</td></tr> +<tr><td><code>FLOAT</code></td><td><code>2</code></td><td> +</td></tr> +<tr><td><code>URI</code></td><td><code>3</code></td><td> +</td></tr> +<tr><td><code>STDOUT</code></td><td><code>4</code></td><td> +</td></tr> +<tr><td><code>STDERR</code></td><td><code>5</code></td><td> +</td></tr> +</table></div> +<hr/><h2 id="Structs">Data structures</h2> +<div class="definition"><h3 id="Struct_InputDataObjectType">Struct: InputDataObjectType</h3> +<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead> +<tr><td>1</td><td>name</td><td><code>string</code></td><td></td><td>required</td><td></td></tr> +<tr><td>2</td><td>value</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> +<tr><td>3</td><td>type</td><td><code><a href="#Enum_DataType">DataType</a></code></td><td></td><td>optional</td><td></td></tr> +<tr><td>4</td><td>applicationArgument</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> +<tr><td>5</td><td>standardInput</td><td><code>bool</code></td><td></td><td>optional</td><td></td></tr> +<tr><td>6</td><td>userFriendlyDescription</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> +<tr><td>7</td><td>metaData</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> +<tr><td>8</td><td>inputOrder</td><td><code>i32</code></td><td></td><td>optional</td><td></td></tr> +<tr><td>9</td><td>isRequired</td><td><code>bool</code></td><td></td><td>optional</td><td></td></tr> +<tr><td>10</td><td>requiredToAddedToCommandLine</td><td><code>bool</code></td><td></td><td>optional</td><td></td></tr> +<tr><td>11</td><td>dataStaged</td><td><code>bool</code></td><td></td><td>optional</td><td></td></tr> +</table><br/>Application Inputs. The paramters describe how inputs are passed to the application. + +name: + Name of the parameter. + +value: + Value of the parameter. A default value could be set during registration. + +type: + Data type of the parameter + +applicationArguement: + The argument flag sent to the application. Such as -p pressure. + +standardInput: + When this value is set, the parameter is sent as standard input rather than a parameter. + Typically this is passed using redirection operator ">". + +userFriendlyDescription: + Description to be displayed at the user interface. + +metaData: + Any metadat. This is typically ignore by Airavata and is used by gateways for application configuration. + +<br/></div><div class="definition"><h3 id="Struct_OutputDataObjectType">Struct: OutputDataObjectType</h3> +<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead> +<tr><td>1</td><td>name</td><td><code>string</code></td><td></td><td>required</td><td></td></tr> +<tr><td>2</td><td>value</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> +<tr><td>3</td><td>type</td><td><code><a href="#Enum_DataType">DataType</a></code></td><td></td><td>optional</td><td></td></tr> +<tr><td>4</td><td>applicationArgument</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> +<tr><td>5</td><td>isRequired</td><td><code>bool</code></td><td></td><td>optional</td><td></td></tr> +<tr><td>6</td><td>requiredToAddedToCommandLine</td><td><code>bool</code></td><td></td><td>optional</td><td></td></tr> +<tr><td>7</td><td>dataMovement</td><td><code>bool</code></td><td></td><td>optional</td><td></td></tr> +<tr><td>8</td><td>location</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> +<tr><td>9</td><td>searchQuery</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> +<tr><td>10</td><td>outputStreaming</td><td><code>bool</code></td><td></td><td>optional</td><td></td></tr> +</table><br/>Application Outputs. The paramters describe how outputs generated by the application. + +name: + Name of the parameter. + +value: + Value of the parameter. + +type: + Data type of the parameter + +applicationArguement: + The argument flag sent to the application. Such as -p pressure. + +standardInput: + When this value is set, the parameter is sent as standard input rather than a parameter. + Typically this is passed using redirection operator ">". + +userFriendlyDescription: + Description to be displayed at the user interface. + +metaData: + Any metadat. This is typically ignore by Airavata and is used by gateways for application configuration. + +<br/></div></div></body></html> Added: airavata/site/trunk/content/documentation/api-docs/0.16/compute_resource_model.html URL: http://svn.apache.org/viewvc/airavata/site/trunk/content/documentation/api-docs/0.16/compute_resource_model.html?rev=1720388&view=auto ============================================================================== --- airavata/site/trunk/content/documentation/api-docs/0.16/compute_resource_model.html (added) +++ airavata/site/trunk/content/documentation/api-docs/0.16/compute_resource_model.html Wed Dec 16 16:25:38 2015 @@ -0,0 +1,347 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<meta http-equiv="Content-Type" content="text/html;charset=utf-8" /> +<link href="style.css" rel="stylesheet" type="text/css"/> +<title>Thrift module: compute_resource_model</title></head><body> +<div class="container-fluid"> +<h1>Thrift module: compute_resource_model</h1> +<table class="table-bordered table-striped table-condensed"><thead><th>Module</th><th>Services</th><th>Data types</th><th>Constants</th></thead> +<tr> +<td>compute_resource_model</td><td></td> +<td><a href="#Struct_BatchQueue">BatchQueue</a><br/> +<a href="#Struct_CloudJobSubmission">CloudJobSubmission</a><br/> +<a href="#Struct_ComputeResourceDescription">ComputeResourceDescription</a><br/> +<a href="#Enum_DMType">DMType</a><br/> +<a href="#Enum_FileSystems">FileSystems</a><br/> +<a href="#Struct_GlobusJobSubmission">GlobusJobSubmission</a><br/> +<a href="#Enum_JobManagerCommand">JobManagerCommand</a><br/> +<a href="#Struct_JobSubmissionInterface">JobSubmissionInterface</a><br/> +<a href="#Enum_JobSubmissionProtocol">JobSubmissionProtocol</a><br/> +<a href="#Struct_LOCALSubmission">LOCALSubmission</a><br/> +<a href="#Enum_MonitorMode">MonitorMode</a><br/> +<a href="#Enum_ProviderName">ProviderName</a><br/> +<a href="#Struct_ResourceJobManager">ResourceJobManager</a><br/> +<a href="#Enum_ResourceJobManagerType">ResourceJobManagerType</a><br/> +<a href="#Struct_SSHJobSubmission">SSHJobSubmission</a><br/> +<a href="#Struct_UnicoreJobSubmission">UnicoreJobSubmission</a><br/> +</td> +<td></code></td> +</tr></table> +<hr/><h2 id="Enumerations">Enumerations</h2> +<div class="definition"><h3 id="Enum_ResourceJobManagerType">Enumeration: ResourceJobManagerType</h3> +* Enumeration of local resource job manager types supported by Airavata +* +* FORK: +* Forking of commands without any job manager +* +* PBS: +* Job manager supporting the Portal Batch System (PBS) protocol. Some examples include TORQUE, PBSPro, Grid Engine. +* +* SLURM: +* The Simple Linux Utility for Resource Management is a open source workload manager. + * + * UGE: + * Univa Grid Engine, a variation of PBS implementation. + * + * LSF: + * IBM Platform Load Sharing Facility is dominantly installed on IBM clusters. +* +<br/><br/><table class="table-bordered table-striped table-condensed"> +<tr><td><code>FORK</code></td><td><code>0</code></td><td> +</td></tr> +<tr><td><code>PBS</code></td><td><code>1</code></td><td> +</td></tr> +<tr><td><code>SLURM</code></td><td><code>2</code></td><td> +</td></tr> +<tr><td><code>LSF</code></td><td><code>3</code></td><td> +</td></tr> +<tr><td><code>UGE</code></td><td><code>4</code></td><td> +</td></tr> +</table></div> +<div class="definition"><h3 id="Enum_JobManagerCommand">Enumeration: JobManagerCommand</h3> +Enumeration of resource job manager commands + +SUBMISSION: + Ex: qsub, sbatch + +JOBMONITORING: + Ex: qstat, squeue + +DELETION: + Ex: qdel, scancel + +CHECK_JOB: + Detailed Status about the Job. Ex: checkjob + +SHOW_QUEUE: + List of Queued Job by the schedular. Ex: showq + +SHOW_RESERVATION: + List all reservations. Ex:showres, show_res + +SHOW_START: + Display the start time of the specified job. Ex: showstart + +<br/><br/><table class="table-bordered table-striped table-condensed"> +<tr><td><code>SUBMISSION</code></td><td><code>0</code></td><td> +</td></tr> +<tr><td><code>JOB_MONITORING</code></td><td><code>1</code></td><td> +</td></tr> +<tr><td><code>DELETION</code></td><td><code>2</code></td><td> +</td></tr> +<tr><td><code>CHECK_JOB</code></td><td><code>3</code></td><td> +</td></tr> +<tr><td><code>SHOW_QUEUE</code></td><td><code>4</code></td><td> +</td></tr> +<tr><td><code>SHOW_RESERVATION</code></td><td><code>5</code></td><td> +</td></tr> +<tr><td><code>SHOW_START</code></td><td><code>6</code></td><td> +</td></tr> +</table></div> +<div class="definition"><h3 id="Enum_FileSystems">Enumeration: FileSystems</h3> +Enumeration of File Systems on the resource + +FORK: + Forking of commands without any job manager + +PBS: + Job manager supporting the Portal Batch System (PBS) protocol. Some examples include TORQUE, PBSPro, Grid Engine. + +UGE: + Univa Grid Engine, a variation of PBS implementation. + +SLURM: + The Simple Linux Utility for Resource Management is a open source workload manager. + +<br/><br/><table class="table-bordered table-striped table-condensed"> +<tr><td><code>HOME</code></td><td><code>0</code></td><td> +</td></tr> +<tr><td><code>WORK</code></td><td><code>1</code></td><td> +</td></tr> +<tr><td><code>LOCALTMP</code></td><td><code>2</code></td><td> +</td></tr> +<tr><td><code>SCRATCH</code></td><td><code>3</code></td><td> +</td></tr> +<tr><td><code>ARCHIVE</code></td><td><code>4</code></td><td> +</td></tr> +</table></div> +<div class="definition"><h3 id="Enum_JobSubmissionProtocol">Enumeration: JobSubmissionProtocol</h3> +Enumeration of Airavata supported Job Submission Mechanisms for High Performance Computing Clusters. + +SSH: + Execute remote job submission commands using via secure shell protocol. + +GRAM: + Execute remote jobs via Globus GRAM service. + +UNICORE: + Execute remote jobs via Unicore services + +<br/><br/><table class="table-bordered table-striped table-condensed"> +<tr><td><code>LOCAL</code></td><td><code>0</code></td><td> +</td></tr> +<tr><td><code>SSH</code></td><td><code>1</code></td><td> +</td></tr> +<tr><td><code>GLOBUS</code></td><td><code>2</code></td><td> +</td></tr> +<tr><td><code>UNICORE</code></td><td><code>3</code></td><td> +</td></tr> +<tr><td><code>CLOUD</code></td><td><code>4</code></td><td> +</td></tr> +<tr><td><code>SSH_FORK</code></td><td><code>5</code></td><td> +</td></tr> +<tr><td><code>LOCAL_FORK</code></td><td><code>6</code></td><td> +</td></tr> +</table></div> +<div class="definition"><h3 id="Enum_MonitorMode">Enumeration: MonitorMode</h3> +Monitoring modes + +POLL_JOB_MANAGER: +GFac need to pull job status changes. + +XSEDE_AMQP_SUBSCRIBE: +Server will publish job status changes to amqp servert. + + +<br/><br/><table class="table-bordered table-striped table-condensed"> +<tr><td><code>POLL_JOB_MANAGER</code></td><td><code>0</code></td><td> +</td></tr> +<tr><td><code>JOB_EMAIL_NOTIFICATION_MONITOR</code></td><td><code>1</code></td><td> +</td></tr> +<tr><td><code>XSEDE_AMQP_SUBSCRIBE</code></td><td><code>2</code></td><td> +</td></tr> +<tr><td><code>FORK</code></td><td><code>3</code></td><td> +</td></tr> +</table></div> +<div class="definition"><h3 id="Enum_DMType">Enumeration: DMType</h3> +<br/><table class="table-bordered table-striped table-condensed"> +<tr><td><code>COMPUTE_RESOURCE</code></td><td><code>0</code></td><td> +</td></tr> +<tr><td><code>STORAGE_RESOURCE</code></td><td><code>1</code></td><td> +</td></tr> +</table></div> +<div class="definition"><h3 id="Enum_ProviderName">Enumeration: ProviderName</h3> +Provider name + +<br/><br/><table class="table-bordered table-striped table-condensed"> +<tr><td><code>EC2</code></td><td><code>0</code></td><td> +</td></tr> +<tr><td><code>AWSEC2</code></td><td><code>1</code></td><td> +</td></tr> +<tr><td><code>RACKSPACE</code></td><td><code>2</code></td><td> +</td></tr> +</table></div> +<hr/><h2 id="Structs">Data structures</h2> +<div class="definition"><h3 id="Struct_ResourceJobManager">Struct: ResourceJobManager</h3> +<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead> +<tr><td>1</td><td>resourceJobManagerId</td><td><code>string</code></td><td></td><td>required</td><td><code>"DO_NOT_SET_AT_CLIENTS"</code></td></tr> +<tr><td>2</td><td>resourceJobManagerType</td><td><code><a href="#Enum_ResourceJobManagerType">ResourceJobManagerType</a></code></td><td></td><td>required</td><td></td></tr> +<tr><td>3</td><td>pushMonitoringEndpoint</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> +<tr><td>4</td><td>jobManagerBinPath</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> +<tr><td>5</td><td>jobManagerCommands</td><td><code>map<<code><a href="#Enum_JobManagerCommand">JobManagerCommand</a></code>, <code>string</code>></code></td><td></td><td>optional</td><td></td></tr> +</table><br/>Resource Job Manager Information + +resourceJobManagerType: + A typical HPC cluster has a single Job Manager to manage the resources. + +pushMonitoringEndpoint: + If the job manager pushes out state changes to a database or bus, specify the service endpoint. + Ex: Moab Web Service, Moab MongoDB URL, AMQP (GLUE2) Broker + +jobManagerBinPath: + Path to the Job Manager Installation Binary directory. + +jobManagerCommands: + An enumeration of commonly used manager commands. + +<br/></div><div class="definition"><h3 id="Struct_BatchQueue">Struct: BatchQueue</h3> +<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead> +<tr><td>1</td><td>queueName</td><td><code>string</code></td><td></td><td>required</td><td></td></tr> +<tr><td>2</td><td>queueDescription</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> +<tr><td>3</td><td>maxRunTime</td><td><code>i32</code></td><td></td><td>optional</td><td></td></tr> +<tr><td>4</td><td>maxNodes</td><td><code>i32</code></td><td></td><td>optional</td><td></td></tr> +<tr><td>5</td><td>maxProcessors</td><td><code>i32</code></td><td></td><td>optional</td><td></td></tr> +<tr><td>6</td><td>maxJobsInQueue</td><td><code>i32</code></td><td></td><td>optional</td><td></td></tr> +<tr><td>7</td><td>maxMemory</td><td><code>i32</code></td><td></td><td>optional</td><td></td></tr> +</table><br/>Batch Queue Information on SuperComputers + +maxRunTime: + Maximum allowed run time in hours. +<br/></div><div class="definition"><h3 id="Struct_LOCALSubmission">Struct: LOCALSubmission</h3> +<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead> +<tr><td>1</td><td>jobSubmissionInterfaceId</td><td><code>string</code></td><td></td><td>required</td><td><code>"DO_NOT_SET_AT_CLIENTS"</code></td></tr> +<tr><td>2</td><td>securityProtocol</td><td><code><a href="data_movement_models.html#Enum_SecurityProtocol">data_movement_models.SecurityProtocol</a></code></td><td></td><td>required</td><td></td></tr> +<tr><td>3</td><td>resourceJobManager</td><td><code><a href="#Struct_ResourceJobManager">ResourceJobManager</a></code></td><td></td><td>required</td><td></td></tr> +</table><br/>Locally Fork Jobs as OS processes + +alternativeSSHHostName: + If the login to ssh is different than the hostname itself, specify it here + +sshPort: + If a non-default port needs to used, specify it. +<br/></div><div class="definition"><h3 id="Struct_SSHJobSubmission">Struct: SSHJobSubmission</h3> +<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead> +<tr><td>1</td><td>jobSubmissionInterfaceId</td><td><code>string</code></td><td></td><td>required</td><td><code>"DO_NOT_SET_AT_CLIENTS"</code></td></tr> +<tr><td>2</td><td>securityProtocol</td><td><code><a href="data_movement_models.html#Enum_SecurityProtocol">data_movement_models.SecurityProtocol</a></code></td><td></td><td>required</td><td></td></tr> +<tr><td>3</td><td>resourceJobManager</td><td><code><a href="#Struct_ResourceJobManager">ResourceJobManager</a></code></td><td></td><td>required</td><td></td></tr> +<tr><td>4</td><td>alternativeSSHHostName</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> +<tr><td>5</td><td>sshPort</td><td><code>i32</code></td><td></td><td>optional</td><td><code>22</code></td></tr> +<tr><td>6</td><td>monitorMode</td><td><code><a href="#Enum_MonitorMode">MonitorMode</a></code></td><td></td><td>optional</td><td></td></tr> +<tr><td>7</td><td>batchQueueEmailSenders</td><td><code>list<<code>string</code>></code></td><td></td><td>optional</td><td></td></tr> +</table><br/>Authenticate using Secured Shell + +alternativeSSHHostName: + If the login to ssh is different than the hostname itself, specify it here + +sshPort: + If a non-default port needs to used, specify it. + +batchQueueEmailSenders: + If a resource always sends the monitoring from a specific address, specify the + full email address. If a resource sends emails from multiple addresses ( + example: based on the submitted login node) then use the wildchar * to indicate + the same. Example: *@*.example.com or *@example.com + +<br/></div><div class="definition"><h3 id="Struct_GlobusJobSubmission">Struct: GlobusJobSubmission</h3> +<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead> +<tr><td>1</td><td>jobSubmissionInterfaceId</td><td><code>string</code></td><td></td><td>required</td><td><code>"DO_NOT_SET_AT_CLIENTS"</code></td></tr> +<tr><td>2</td><td>securityProtocol</td><td><code><a href="data_movement_models.html#Enum_SecurityProtocol">data_movement_models.SecurityProtocol</a></code></td><td></td><td>required</td><td></td></tr> +<tr><td>3</td><td>globusGateKeeperEndPoint</td><td><code>list<<code>string</code>></code></td><td></td><td>optional</td><td></td></tr> +</table><br/></div><div class="definition"><h3 id="Struct_UnicoreJobSubmission">Struct: UnicoreJobSubmission</h3> +<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead> +<tr><td>1</td><td>jobSubmissionInterfaceId</td><td><code>string</code></td><td></td><td>required</td><td><code>"DO_NOT_SET_AT_CLIENTS"</code></td></tr> +<tr><td>2</td><td>securityProtocol</td><td><code><a href="data_movement_models.html#Enum_SecurityProtocol">data_movement_models.SecurityProtocol</a></code></td><td></td><td>required</td><td></td></tr> +<tr><td>3</td><td>unicoreEndPointURL</td><td><code>string</code></td><td></td><td>required</td><td></td></tr> +</table><br/>Unicore Job Submission + +unicoreEndPointURL: + unicoreGateway End Point. The provider will query this service to fetch required service end points. +authenticationMode + The authenticationMode defines the way certificate is fetched. +<br/></div><div class="definition"><h3 id="Struct_CloudJobSubmission">Struct: CloudJobSubmission</h3> +<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead> +<tr><td>1</td><td>jobSubmissionInterfaceId</td><td><code>string</code></td><td></td><td>required</td><td><code>"DO_NOT_SET_AT_CLIENTS"</code></td></tr> +<tr><td>2</td><td>securityProtocol</td><td><code><a href="data_movement_models.html#Enum_SecurityProtocol">data_movement_models.SecurityProtocol</a></code></td><td></td><td>required</td><td></td></tr> +<tr><td>3</td><td>nodeId</td><td><code>string</code></td><td></td><td>required</td><td></td></tr> +<tr><td>4</td><td>executableType</td><td><code>string</code></td><td></td><td>required</td><td></td></tr> +<tr><td>5</td><td>providerName</td><td><code><a href="#Enum_ProviderName">ProviderName</a></code></td><td></td><td>required</td><td></td></tr> +<tr><td>6</td><td>userAccountName</td><td><code>string</code></td><td></td><td>required</td><td></td></tr> +</table><br/>Cloud Job Submission + + +<br/></div><div class="definition"><h3 id="Struct_JobSubmissionInterface">Struct: JobSubmissionInterface</h3> +<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead> +<tr><td>1</td><td>jobSubmissionInterfaceId</td><td><code>string</code></td><td></td><td>required</td><td></td></tr> +<tr><td>2</td><td>jobSubmissionProtocol</td><td><code><a href="#Enum_JobSubmissionProtocol">JobSubmissionProtocol</a></code></td><td></td><td>required</td><td></td></tr> +<tr><td>3</td><td>priorityOrder</td><td><code>i32</code></td><td></td><td>required</td><td><code>0</code></td></tr> +</table><br/>Job Submission Interfaces + +jobSubmissionInterfaceId: The Job Submission Interface has to be previously registered and referenced here. + +priorityOrder: + For resources with multiple interfaces, the priority order should be selected. + Lower the numerical number, higher the priority + +<br/></div><div class="definition"><h3 id="Struct_ComputeResourceDescription">Struct: ComputeResourceDescription</h3> +<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead> +<tr><td>1</td><td>computeResourceId</td><td><code>string</code></td><td></td><td>required</td><td><code>"DO_NOT_SET_AT_CLIENTS"</code></td></tr> +<tr><td>2</td><td>hostName</td><td><code>string</code></td><td></td><td>required</td><td></td></tr> +<tr><td>3</td><td>hostAliases</td><td><code>list<<code>string</code>></code></td><td></td><td>optional</td><td></td></tr> +<tr><td>4</td><td>ipAddresses</td><td><code>list<<code>string</code>></code></td><td></td><td>optional</td><td></td></tr> +<tr><td>5</td><td>resourceDescription</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> +<tr><td>6</td><td>enabled</td><td><code>bool</code></td><td></td><td>optional</td><td></td></tr> +<tr><td>7</td><td>batchQueues</td><td><code>list<<code><a href="#Struct_BatchQueue">BatchQueue</a></code>></code></td><td></td><td>optional</td><td></td></tr> +<tr><td>8</td><td>fileSystems</td><td><code>map<<code><a href="#Enum_FileSystems">FileSystems</a></code>, <code>string</code>></code></td><td></td><td>optional</td><td></td></tr> +<tr><td>9</td><td>jobSubmissionInterfaces</td><td><code>list<<code><a href="#Struct_JobSubmissionInterface">JobSubmissionInterface</a></code>></code></td><td></td><td>optional</td><td></td></tr> +<tr><td>10</td><td>dataMovementInterfaces</td><td><code>list<<code><a href="data_movement_models.html#Struct_DataMovementInterface">data_movement_models.DataMovementInterface</a></code>></code></td><td></td><td>optional</td><td></td></tr> +<tr><td>11</td><td>maxMemoryPerNode</td><td><code>i32</code></td><td></td><td>optional</td><td></td></tr> +</table><br/>Computational Resource Description + +computeResourceId: Airavata Internal Unique Identifier to distinguish Compute Resource. + +hostName: + Fully Qualified Host Name. + +hostAliases: + Aliases if any. + +ipAddress: + IP Addresses of the Resource. + +resourceDescription: + A user friendly description of the resource. + +JobSubmissionProtocols: + A computational resources may have one or more ways of submitting Jobs. This structure + will hold all available mechanisms to interact with the resource. + The key is the priority + +DataMovementProtocol: + Option to specify a prefered data movement mechanism of the available options. + +fileSystems: + Map of file systems type and the path. + +<br/></div></div></body></html> Added: airavata/site/trunk/content/documentation/api-docs/0.16/data_movement_models.html URL: http://svn.apache.org/viewvc/airavata/site/trunk/content/documentation/api-docs/0.16/data_movement_models.html?rev=1720388&view=auto ============================================================================== --- airavata/site/trunk/content/documentation/api-docs/0.16/data_movement_models.html (added) +++ airavata/site/trunk/content/documentation/api-docs/0.16/data_movement_models.html Wed Dec 16 16:25:38 2015 @@ -0,0 +1,144 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<meta http-equiv="Content-Type" content="text/html;charset=utf-8" /> +<link href="style.css" rel="stylesheet" type="text/css"/> +<title>Thrift module: data_movement_models</title></head><body> +<div class="container-fluid"> +<h1>Thrift module: data_movement_models</h1> +<table class="table-bordered table-striped table-condensed"><thead><th>Module</th><th>Services</th><th>Data types</th><th>Constants</th></thead> +<tr> +<td>data_movement_models</td><td></td> +<td><a href="#Enum_DMType">DMType</a><br/> +<a href="#Struct_DataMovementInterface">DataMovementInterface</a><br/> +<a href="#Enum_DataMovementProtocol">DataMovementProtocol</a><br/> +<a href="#Struct_GridFTPDataMovement">GridFTPDataMovement</a><br/> +<a href="#Struct_LOCALDataMovement">LOCALDataMovement</a><br/> +<a href="#Struct_SCPDataMovement">SCPDataMovement</a><br/> +<a href="#Enum_SecurityProtocol">SecurityProtocol</a><br/> +<a href="#Struct_UnicoreDataMovement">UnicoreDataMovement</a><br/> +</td> +<td></code></td> +</tr></table> +<hr/><h2 id="Enumerations">Enumerations</h2> +<div class="definition"><h3 id="Enum_DMType">Enumeration: DMType</h3> +<br/><table class="table-bordered table-striped table-condensed"> +<tr><td><code>COMPUTE_RESOURCE</code></td><td><code>0</code></td><td> +</td></tr> +<tr><td><code>STORAGE_RESOURCE</code></td><td><code>1</code></td><td> +</td></tr> +</table></div> +<div class="definition"><h3 id="Enum_SecurityProtocol">Enumeration: SecurityProtocol</h3> +Enumeration of security sshKeyAuthentication and authorization mechanisms supported by Airavata. This enumeration just + describes the supported mechanism. The corresponding security credentials are registered with Airavata Credential + store. + +USERNAME_PASSWORD: + A User Name. + +SSH_KEYS: + SSH Keys + +FIXME: Change GSI to a more precise generic security protocol - X509 + +<br/><br/><table class="table-bordered table-striped table-condensed"> +<tr><td><code>USERNAME_PASSWORD</code></td><td><code>0</code></td><td> +</td></tr> +<tr><td><code>SSH_KEYS</code></td><td><code>1</code></td><td> +</td></tr> +<tr><td><code>GSI</code></td><td><code>2</code></td><td> +</td></tr> +<tr><td><code>KERBEROS</code></td><td><code>3</code></td><td> +</td></tr> +<tr><td><code>OAUTH</code></td><td><code>4</code></td><td> +</td></tr> +<tr><td><code>LOCAL</code></td><td><code>5</code></td><td> +</td></tr> +</table></div> +<div class="definition"><h3 id="Enum_DataMovementProtocol">Enumeration: DataMovementProtocol</h3> +Enumeration of data movement supported by Airavata + +SCP: + Job manager supporting the Portal Batch System (PBS) protocol. Some examples include TORQUE, PBSPro, Grid Engine. + +SFTP: + The Simple Linux Utility for Resource Management is a open source workload manager. + +GridFTP: + Globus File Transfer Protocol + +UNICORE_STORAGE_SERVICE: + Storage Service Provided by Unicore + +<br/><br/><table class="table-bordered table-striped table-condensed"> +<tr><td><code>LOCAL</code></td><td><code>0</code></td><td> +</td></tr> +<tr><td><code>SCP</code></td><td><code>1</code></td><td> +</td></tr> +<tr><td><code>SFTP</code></td><td><code>2</code></td><td> +</td></tr> +<tr><td><code>GridFTP</code></td><td><code>3</code></td><td> +</td></tr> +<tr><td><code>UNICORE_STORAGE_SERVICE</code></td><td><code>4</code></td><td> +</td></tr> +</table></div> +<hr/><h2 id="Structs">Data structures</h2> +<div class="definition"><h3 id="Struct_SCPDataMovement">Struct: SCPDataMovement</h3> +<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead> +<tr><td>1</td><td>dataMovementInterfaceId</td><td><code>string</code></td><td></td><td>required</td><td><code>"DO_NOT_SET_AT_CLIENTS"</code></td></tr> +<tr><td>2</td><td>securityProtocol</td><td><code><a href="#Enum_SecurityProtocol">SecurityProtocol</a></code></td><td></td><td>required</td><td></td></tr> +<tr><td>3</td><td>alternativeSCPHostName</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> +<tr><td>4</td><td>sshPort</td><td><code>i32</code></td><td></td><td>optional</td><td><code>22</code></td></tr> +</table><br/>Data Movement through Secured Copy + +alternativeSCPHostName: + If the login to scp is different than the hostname itself, specify it here + +sshPort: + If a non-default port needs to used, specify it. +<br/></div><div class="definition"><h3 id="Struct_GridFTPDataMovement">Struct: GridFTPDataMovement</h3> +<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead> +<tr><td>1</td><td>dataMovementInterfaceId</td><td><code>string</code></td><td></td><td>required</td><td><code>"DO_NOT_SET_AT_CLIENTS"</code></td></tr> +<tr><td>2</td><td>securityProtocol</td><td><code><a href="#Enum_SecurityProtocol">SecurityProtocol</a></code></td><td></td><td>required</td><td></td></tr> +<tr><td>3</td><td>gridFTPEndPoints</td><td><code>list<<code>string</code>></code></td><td></td><td>required</td><td></td></tr> +</table><br/>Data Movement through GridFTP + +alternativeSCPHostName: + If the login to scp is different than the hostname itself, specify it here + +sshPort: + If a non-default port needs to used, specify it. +<br/></div><div class="definition"><h3 id="Struct_UnicoreDataMovement">Struct: UnicoreDataMovement</h3> +<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead> +<tr><td>1</td><td>dataMovementInterfaceId</td><td><code>string</code></td><td></td><td>required</td><td><code>"DO_NOT_SET_AT_CLIENTS"</code></td></tr> +<tr><td>2</td><td>securityProtocol</td><td><code><a href="#Enum_SecurityProtocol">SecurityProtocol</a></code></td><td></td><td>required</td><td></td></tr> +<tr><td>3</td><td>unicoreEndPointURL</td><td><code>string</code></td><td></td><td>required</td><td></td></tr> +</table><br/>Data Movement through UnicoreStorage + +unicoreEndPointURL: + unicoreGateway End Point. The provider will query this service to fetch required service end points. +<br/></div><div class="definition"><h3 id="Struct_LOCALDataMovement">Struct: LOCALDataMovement</h3> +<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead> +<tr><td>1</td><td>dataMovementInterfaceId</td><td><code>string</code></td><td></td><td>required</td><td><code>"DO_NOT_SET_AT_CLIENTS"</code></td></tr> +</table><br/>LOCAL + +alternativeSCPHostName: + If the login to scp is different than the hostname itself, specify it here + +sshPort: + If a non-defualt port needs to used, specify it. +<br/></div><div class="definition"><h3 id="Struct_DataMovementInterface">Struct: DataMovementInterface</h3> +<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead> +<tr><td>1</td><td>dataMovementInterfaceId</td><td><code>string</code></td><td></td><td>required</td><td></td></tr> +<tr><td>2</td><td>dataMovementProtocol</td><td><code><a href="#Enum_DataMovementProtocol">DataMovementProtocol</a></code></td><td></td><td>required</td><td></td></tr> +<tr><td>3</td><td>priorityOrder</td><td><code>i32</code></td><td></td><td>required</td><td><code>0</code></td></tr> +</table><br/>Data Movement Interfaces + +dataMovementInterfaceId: The Data Movement Interface has to be previously registered and referenced here. + +priorityOrder: + For resources with multiple interfaces, the priority order should be selected. + Lower the numerical number, higher the priority + +<br/></div></div></body></html> Added: airavata/site/trunk/content/documentation/api-docs/0.16/experiment_model.html URL: http://svn.apache.org/viewvc/airavata/site/trunk/content/documentation/api-docs/0.16/experiment_model.html?rev=1720388&view=auto ============================================================================== --- airavata/site/trunk/content/documentation/api-docs/0.16/experiment_model.html (added) +++ airavata/site/trunk/content/documentation/api-docs/0.16/experiment_model.html Wed Dec 16 16:25:38 2015 @@ -0,0 +1,122 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<meta http-equiv="Content-Type" content="text/html;charset=utf-8" /> +<link href="style.css" rel="stylesheet" type="text/css"/> +<title>Thrift module: experiment_model</title></head><body> +<div class="container-fluid"> +<h1>Thrift module: experiment_model</h1> +<table class="table-bordered table-striped table-condensed"><thead><th>Module</th><th>Services</th><th>Data types</th><th>Constants</th></thead> +<tr> +<td>experiment_model</td><td></td> +<td><a href="#Struct_ExperimentModel">ExperimentModel</a><br/> +<a href="#Enum_ExperimentSearchFields">ExperimentSearchFields</a><br/> +<a href="#Struct_ExperimentStatistics">ExperimentStatistics</a><br/> +<a href="#Struct_ExperimentSummaryModel">ExperimentSummaryModel</a><br/> +<a href="#Enum_ExperimentType">ExperimentType</a><br/> +<a href="#Struct_UserConfigurationDataModel">UserConfigurationDataModel</a><br/> +</td> +<td></code></td> +</tr></table> +<hr/><h2 id="Enumerations">Enumerations</h2> +<div class="definition"><h3 id="Enum_ExperimentType">Enumeration: ExperimentType</h3> +<br/><table class="table-bordered table-striped table-condensed"> +<tr><td><code>SINGLE_APPLICATION</code></td><td><code>0</code></td><td> +</td></tr> +<tr><td><code>WORKFLOW</code></td><td><code>1</code></td><td> +</td></tr> +</table></div> +<div class="definition"><h3 id="Enum_ExperimentSearchFields">Enumeration: ExperimentSearchFields</h3> +<br/><table class="table-bordered table-striped table-condensed"> +<tr><td><code>EXPERIMENT_NAME</code></td><td><code>0</code></td><td> +</td></tr> +<tr><td><code>EXPERIMENT_DESC</code></td><td><code>1</code></td><td> +</td></tr> +<tr><td><code>APPLICATION_ID</code></td><td><code>2</code></td><td> +</td></tr> +<tr><td><code>FROM_DATE</code></td><td><code>3</code></td><td> +</td></tr> +<tr><td><code>TO_DATE</code></td><td><code>4</code></td><td> +</td></tr> +<tr><td><code>STATUS</code></td><td><code>5</code></td><td> +</td></tr> +<tr><td><code>PROJECT_ID</code></td><td><code>6</code></td><td> +</td></tr> +</table></div> +<hr/><h2 id="Structs">Data structures</h2> +<div class="definition"><h3 id="Struct_UserConfigurationDataModel">Struct: UserConfigurationDataModel</h3> +<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead> +<tr><td>1</td><td>airavataAutoSchedule</td><td><code>bool</code></td><td></td><td>required</td><td><code>false</code></td></tr> +<tr><td>2</td><td>overrideManualScheduledParams</td><td><code>bool</code></td><td></td><td>required</td><td><code>false</code></td></tr> +<tr><td>3</td><td>shareExperimentPublicly</td><td><code>bool</code></td><td></td><td>optional</td><td><code>false</code></td></tr> +<tr><td>4</td><td>computationalResourceScheduling</td><td><code><a href="scheduling_model.html#Struct_ComputationalResourceSchedulingModel">scheduling_model.ComputationalResourceSchedulingModel</a></code></td><td></td><td>optional</td><td></td></tr> +<tr><td>5</td><td>throttleResources</td><td><code>bool</code></td><td></td><td>optional</td><td><code>false</code></td></tr> +<tr><td>6</td><td>userDN</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> +<tr><td>7</td><td>generateCert</td><td><code>bool</code></td><td></td><td>optional</td><td><code>false</code></td></tr> +<tr><td>8</td><td>storageId</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> +</table><br/>A structure holding the experiment configuration. + + +<br/></div><div class="definition"><h3 id="Struct_ExperimentModel">Struct: ExperimentModel</h3> +<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead> +<tr><td>1</td><td>experimentId</td><td><code>string</code></td><td></td><td>required</td><td><code>"DO_NOT_SET_AT_CLIENTS"</code></td></tr> +<tr><td>2</td><td>projectId</td><td><code>string</code></td><td></td><td>required</td><td></td></tr> +<tr><td>3</td><td>gatewayId</td><td><code>string</code></td><td></td><td>required</td><td></td></tr> +<tr><td>4</td><td>experimentType</td><td><code><a href="#Enum_ExperimentType">ExperimentType</a></code></td><td></td><td>required</td><td><code><code><a href="#Const_ExperimentType.SINGLE_APPLICATION">ExperimentType.SINGLE_APPLICATION</a></code></code></td></tr> +<tr><td>5</td><td>userName</td><td><code>string</code></td><td></td><td>required</td><td></td></tr> +<tr><td>6</td><td>experimentName</td><td><code>string</code></td><td></td><td>required</td><td></td></tr> +<tr><td>7</td><td>creationTime</td><td><code>i64</code></td><td></td><td>optional</td><td></td></tr> +<tr><td>8</td><td>description</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> +<tr><td>9</td><td>executionId</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> +<tr><td>10</td><td>gatewayExecutionId</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> +<tr><td>11</td><td>enableEmailNotification</td><td><code>bool</code></td><td></td><td>optional</td><td></td></tr> +<tr><td>12</td><td>emailAddresses</td><td><code>list<<code>string</code>></code></td><td></td><td>optional</td><td></td></tr> +<tr><td>13</td><td>userConfigurationData</td><td><code><a href="#Struct_UserConfigurationDataModel">UserConfigurationDataModel</a></code></td><td></td><td>optional</td><td></td></tr> +<tr><td>14</td><td>experimentInputs</td><td><code>list<<code><a href="application_io_models.html#Struct_InputDataObjectType">application_io_models.InputDataObjectType</a></code>></code></td><td></td><td>optional</td><td></td></tr> +<tr><td>15</td><td>experimentOutputs</td><td><code>list<<code><a href="application_io_models.html#Struct_OutputDataObjectType">application_io_models.OutputDataObjectType</a></code>></code></td><td></td><td>optional</td><td></td></tr> +<tr><td>16</td><td>experimentStatus</td><td><code><a href="status_models.html#Struct_ExperimentStatus">status_models.ExperimentStatus</a></code></td><td></td><td>optional</td><td></td></tr> +<tr><td>17</td><td>errors</td><td><code>list<<code><a href="airavata_commons.html#Struct_ErrorModel">airavata_commons.ErrorModel</a></code>></code></td><td></td><td>optional</td><td></td></tr> +<tr><td>18</td><td>processes</td><td><code>list<<code><a href="process_model.html#Struct_ProcessModel">process_model.ProcessModel</a></code>></code></td><td></td><td>optional</td><td></td></tr> +</table><br/>A structure holding the experiment metadata and its child models. + +userName: + The user name of the targeted gateway end user on whose behalf the experiment is being created. + the associated gateway identity can only be inferred from the security hand-shake so as to avoid + authorized Airavata Clients mimicking an unauthorized request. If a gateway is not registered with + Airavata, an authorization exception is thrown. + +experimentName: + The name of the experiment as defined by the user. The name need not be unique as uniqueness is enforced + by the generated experiment id. + +experimentDescription: + The verbose description of the experiment. This is an optional parameter. +<br/></div><div class="definition"><h3 id="Struct_ExperimentSummaryModel">Struct: ExperimentSummaryModel</h3> +<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead> +<tr><td>1</td><td>experimentId</td><td><code>string</code></td><td></td><td>required</td><td></td></tr> +<tr><td>2</td><td>projectId</td><td><code>string</code></td><td></td><td>required</td><td></td></tr> +<tr><td>3</td><td>gatewayId</td><td><code>string</code></td><td></td><td>required</td><td></td></tr> +<tr><td>4</td><td>creationTime</td><td><code>i64</code></td><td></td><td>optional</td><td></td></tr> +<tr><td>5</td><td>userName</td><td><code>string</code></td><td></td><td>required</td><td></td></tr> +<tr><td>6</td><td>name</td><td><code>string</code></td><td></td><td>required</td><td></td></tr> +<tr><td>7</td><td>description</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> +<tr><td>8</td><td>executionId</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> +<tr><td>9</td><td>resourceHostId</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> +<tr><td>10</td><td>experimentStatus</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> +<tr><td>12</td><td>statusUpdateTime</td><td><code>i64</code></td><td></td><td>optional</td><td></td></tr> +</table><br/></div><div class="definition"><h3 id="Struct_ExperimentStatistics">Struct: ExperimentStatistics</h3> +<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead> +<tr><td>1</td><td>allExperimentCount</td><td><code>i32</code></td><td></td><td>required</td><td></td></tr> +<tr><td>2</td><td>completedExperimentCount</td><td><code>i32</code></td><td></td><td>required</td><td></td></tr> +<tr><td>3</td><td>cancelledExperimentCount</td><td><code>i32</code></td><td></td><td>optional</td><td></td></tr> +<tr><td>4</td><td>failedExperimentCount</td><td><code>i32</code></td><td></td><td>required</td><td></td></tr> +<tr><td>5</td><td>createdExperimentCount</td><td><code>i32</code></td><td></td><td>required</td><td></td></tr> +<tr><td>6</td><td>runningExperimentCount</td><td><code>i32</code></td><td></td><td>required</td><td></td></tr> +<tr><td>7</td><td>allExperiments</td><td><code>list<<code><a href="#Struct_ExperimentSummaryModel">ExperimentSummaryModel</a></code>></code></td><td></td><td>required</td><td></td></tr> +<tr><td>8</td><td>completedExperiments</td><td><code>list<<code><a href="#Struct_ExperimentSummaryModel">ExperimentSummaryModel</a></code>></code></td><td></td><td>optional</td><td></td></tr> +<tr><td>9</td><td>failedExperiments</td><td><code>list<<code><a href="#Struct_ExperimentSummaryModel">ExperimentSummaryModel</a></code>></code></td><td></td><td>optional</td><td></td></tr> +<tr><td>10</td><td>cancelledExperiments</td><td><code>list<<code><a href="#Struct_ExperimentSummaryModel">ExperimentSummaryModel</a></code>></code></td><td></td><td>optional</td><td></td></tr> +<tr><td>11</td><td>createdExperiments</td><td><code>list<<code><a href="#Struct_ExperimentSummaryModel">ExperimentSummaryModel</a></code>></code></td><td></td><td>optional</td><td></td></tr> +<tr><td>12</td><td>runningExperiments</td><td><code>list<<code><a href="#Struct_ExperimentSummaryModel">ExperimentSummaryModel</a></code>></code></td><td></td><td>optional</td><td></td></tr> +</table><br/></div></div></body></html> Added: airavata/site/trunk/content/documentation/api-docs/0.16/gateway_resource_profile_model.html URL: http://svn.apache.org/viewvc/airavata/site/trunk/content/documentation/api-docs/0.16/gateway_resource_profile_model.html?rev=1720388&view=auto ============================================================================== --- airavata/site/trunk/content/documentation/api-docs/0.16/gateway_resource_profile_model.html (added) +++ airavata/site/trunk/content/documentation/api-docs/0.16/gateway_resource_profile_model.html Wed Dec 16 16:25:38 2015 @@ -0,0 +1,86 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<meta http-equiv="Content-Type" content="text/html;charset=utf-8" /> +<link href="style.css" rel="stylesheet" type="text/css"/> +<title>Thrift module: gateway_resource_profile_model</title></head><body> +<div class="container-fluid"> +<h1>Thrift module: gateway_resource_profile_model</h1> +<table class="table-bordered table-striped table-condensed"><thead><th>Module</th><th>Services</th><th>Data types</th><th>Constants</th></thead> +<tr> +<td>gateway_resource_profile_model</td><td></td> +<td><a href="#Struct_ComputeResourcePreference">ComputeResourcePreference</a><br/> +<a href="#Struct_GatewayResourceProfile">GatewayResourceProfile</a><br/> +<a href="#Struct_StoragePreference">StoragePreference</a><br/> +</td> +<td></code></td> +</tr></table> +<hr/><h2 id="Structs">Data structures</h2> +<div class="definition"><h3 id="Struct_ComputeResourcePreference">Struct: ComputeResourcePreference</h3> +<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead> +<tr><td>1</td><td>computeResourceId</td><td><code>string</code></td><td></td><td>required</td><td></td></tr> +<tr><td>2</td><td>overridebyAiravata</td><td><code>bool</code></td><td></td><td>required</td><td><code>true</code></td></tr> +<tr><td>3</td><td>loginUserName</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> +<tr><td>4</td><td>preferredJobSubmissionProtocol</td><td><code><a href="compute_resource_model.html#Enum_JobSubmissionProtocol">compute_resource_model.JobSubmissionProtocol</a></code></td><td></td><td>optional</td><td></td></tr> +<tr><td>5</td><td>preferredDataMovementProtocol</td><td><code><a href="data_movement_models.html#Enum_DataMovementProtocol">data_movement_models.DataMovementProtocol</a></code></td><td></td><td>optional</td><td></td></tr> +<tr><td>6</td><td>preferredBatchQueue</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> +<tr><td>7</td><td>scratchLocation</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> +<tr><td>8</td><td>allocationProjectNumber</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> +<tr><td>9</td><td>resourceSpecificCredentialStoreToken</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> +</table><br/>Gateway specific preferences for a Computer Resource + +computeResourceId: + Corelate the preference to a compute resource. + +overridebyAiravata: + If turned true, Airavata will override the preferences of better alternatives exist. + +loginUserName: + If turned true, Airavata will override the preferences of better alternatives exist. + +preferredJobSubmissionProtocol: + For resources with multiple job submission protocols, the gateway can pick a preferred option. + +preferredDataMovementProtocol: + For resources with multiple data movement protocols, the gateway can pick a preferred option. + +preferredBatchQueue: + Gateways can choose a defualt batch queue based on average job dimention, reservations or other metrics. + +scratchLocation: + Path to the local scratch space on a HPC cluster. Typically used to create working directory for job execution. + +allocationProjectNumber: + Typically used on HPC machines to charge computing usage to a account number. For instance, on XSEDE once an + allocation is approved, an allocation number is assigned. Before passing this number with job submittions, the + account to be used has to be added to the allocation. + +resourceSpecificCredentialStoreToken: + Resource specific credential store token. If this token is specified, then it is superceeded by the gateway's + default credential store. + +<br/></div><div class="definition"><h3 id="Struct_StoragePreference">Struct: StoragePreference</h3> +<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead> +<tr><td>1</td><td>storageResourceId</td><td><code>string</code></td><td></td><td>required</td><td></td></tr> +<tr><td>2</td><td>loginUserName</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> +<tr><td>3</td><td>fileSystemRootLocation</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> +<tr><td>4</td><td>resourceSpecificCredentialStoreToken</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> +</table><br/></div><div class="definition"><h3 id="Struct_GatewayResourceProfile">Struct: GatewayResourceProfile</h3> +<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead> +<tr><td>1</td><td>gatewayID</td><td><code>string</code></td><td></td><td>required</td><td></td></tr> +<tr><td>2</td><td>credentialStoreToken</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> +<tr><td>3</td><td>computeResourcePreferences</td><td><code>list<<code><a href="#Struct_ComputeResourcePreference">ComputeResourcePreference</a></code>></code></td><td></td><td>optional</td><td></td></tr> +<tr><td>4</td><td>storagePreferences</td><td><code>list<<code><a href="#Struct_StoragePreference">StoragePreference</a></code>></code></td><td></td><td>optional</td><td></td></tr> +</table><br/>Gateway Resource Profile + +gatewayID: + Unique identifier for the gateway assigned by Airavata. Corelate this to Airavata Admin API Gateway Registration. + +credentialStoreToken: + Gateway's defualt credential store token. + +computeResourcePreferences: + List of resource preferences for each of the registered compute resources. + +<br/></div></div></body></html>