Struct: ComputeResourcePreference
| Key | Field | Type | Description | Requiredness | Default value |
| 1 | computeResourceId | string | | required | |
| 2 | overridebyAiravata | bool | | required | 1 |
| 3 | preferredJobSubmissionProtocol | string | | optional | |
| 4 | preferredDataMovementProtocol | string | | optional | |
| 5 | preferredBatchQueue | string | | optional | |
| 6 | scratchLocation | string | | optional | |
| 7 | allocationProjectNumber | string | | optional | |
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.
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.
Struct: GatewayResourceProfile
| Key | Field | Type | Description | Requiredness | Default value |
| 1 | gatewayID | string | | required | "DO_NOT_SET_AT_CLIENTS" |
| 2 | gatewayName | string | | required | |
| 3 | gatewayDescription | string | | optional | |
| 4 | computeResourcePreferences | list<ComputeResourcePreference> | | optional | |
Gateway Resource Profile
gatewayID:
Unique identifier for the gateway assigned by Airavata. Corelate this to Airavata Admin API Gateway Registration.
gatewayName:
Name of the Gateway.
gatewayDescription:
A user friendly description of the gateway.
computeResourcePreferences:
List of resource preferences for each of the registered compute resources.