| <!DOCTYPE html> |
| <html lang="en"> |
| <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><tr><th>Module</th><th>Services</th><th>Data types</th><th>Constants</th></tr></thead><tbody> |
| <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></td> |
| </tr></tbody></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><tr><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></tr></thead><tbody> |
| <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> |
| <tr><td>10</td><td>usageReportingGatewayId</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> |
| <tr><td>11</td><td>qualityOfService</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> |
| <tr><td>12</td><td>reservation</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> |
| <tr><td>13</td><td>reservationStartTime</td><td><code>i64</code></td><td></td><td>optional</td><td></td></tr> |
| <tr><td>14</td><td>reservationEndTime</td><td><code>i64</code></td><td></td><td>optional</td><td></td></tr> |
| <tr><td>15</td><td>sshAccountProvisioner</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> |
| <tr><td>16</td><td>sshAccountProvisionerConfig</td><td><code>map<<code>string</code>, <code>string</code>></code></td><td></td><td>optional</td><td></td></tr> |
| <tr><td>17</td><td>sshAccountProvisionerAdditionalInfo</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> |
| </tbody></table><br/><pre>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. |
| |
| </pre><br/></div><div class="definition"><h3 id="Struct_StoragePreference">Struct: StoragePreference</h3> |
| <table class="table-bordered table-striped table-condensed"><thead><tr><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></tr></thead><tbody> |
| <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> |
| </tbody></table><br/></div><div class="definition"><h3 id="Struct_GatewayResourceProfile">Struct: GatewayResourceProfile</h3> |
| <table class="table-bordered table-striped table-condensed"><thead><tr><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></tr></thead><tbody> |
| <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> |
| <tr><td>5</td><td>identityServerTenant</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> |
| <tr><td>6</td><td>identityServerPwdCredToken</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr> |
| </tbody></table><br/><pre>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. |
| |
| identityServerTenant: |
| |
| identityServerPwdCredToken: |
| |
| </pre><br/></div></div></body></html> |
