Thrift module: gatewayResourceProfileModel

ModuleServicesData typesConstants
gatewayResourceProfileModel ComputeResourcePreference
GatewayResourceProfile

Data structures

Struct: ComputeResourcePreference

KeyFieldTypeDescriptionRequirednessDefault value
1computeResourceIdstringrequired
2overridebyAiravataboolrequired1
3loginUserNamestringoptional
4preferredJobSubmissionProtocolcomputeResourceModel.JobSubmissionProtocoloptional
5preferredDataMovementProtocolcomputeResourceModel.DataMovementProtocoloptional
6preferredBatchQueuestringoptional
7scratchLocationstringoptional
8allocationProjectNumberstringoptional

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.


Struct: GatewayResourceProfile

KeyFieldTypeDescriptionRequirednessDefault value
1gatewayIDstringrequired
2computeResourcePreferenceslist<ComputeResourcePreference>optional

Gateway Resource Profile

gatewayID: Unique identifier for the gateway assigned by Airavata. Corelate this to Airavata Admin API Gateway Registration.

computeResourcePreferences: List of resource preferences for each of the registered compute resources.