Thrift module: gateway_resource_profile_model

ModuleServicesData typesConstants
gateway_resource_profile_model ComputeResourcePreference
GatewayResourceProfile
StoragePreference

Data structures

Struct: ComputeResourcePreference

KeyFieldTypeDescriptionRequirednessDefault value
1computeResourceIdstringrequired
2overridebyAiravataboolrequiredtrue
3loginUserNamestringoptional
4preferredJobSubmissionProtocolcompute_resource_model.JobSubmissionProtocoloptional
5preferredDataMovementProtocoldata_movement_models.DataMovementProtocoloptional
6preferredBatchQueuestringoptional
7scratchLocationstringoptional
8allocationProjectNumberstringoptional
9resourceSpecificCredentialStoreTokenstringoptional
10usageReportingGatewayIdstringoptional

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.

Struct: StoragePreference

KeyFieldTypeDescriptionRequirednessDefault value
1storageResourceIdstringrequired
2loginUserNamestringoptional
3fileSystemRootLocationstringoptional
4resourceSpecificCredentialStoreTokenstringoptional

Struct: GatewayResourceProfile

KeyFieldTypeDescriptionRequirednessDefault value
1gatewayIDstringrequired
2credentialStoreTokenstringoptional
3computeResourcePreferenceslist<ComputeResourcePreference>optional
4storagePreferenceslist<StoragePreference>optional

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.