Thrift module: user_resource_profile_model

ModuleServicesData typesConstants
user_resource_profile_model UserComputeResourcePreference
UserResourceProfile
UserStoragePreference

Data structures

Struct: UserComputeResourcePreference

KeyFieldTypeDescriptionRequirednessDefault value
1computeResourceIdstringrequired
2loginUserNamestringoptional
3preferredBatchQueuestringoptional
4scratchLocationstringoptional
5allocationProjectNumberstringoptional
6resourceSpecificCredentialStoreTokenstringoptional
7qualityOfServicestringoptional
8reservationstringoptional
9reservationStartTimei64optional
10reservationEndTimei64optional
11validatedbooloptionalfalse

User specific preferences for a Computer Resource

computeResourceId:
  Corelate the preference to a compute resource.


loginUserName:
  If turned true, Airavata will override the preferences of better alternatives exist.


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.

validated:
 If true the the configuration has been validated in the sense that the username and credential can be used to
 login to the remote host and the scratchLocation is a valid location that the user has permission to write to.
 Should be treated as read-only and only mutated by Airavata middleware.


Struct: UserStoragePreference

KeyFieldTypeDescriptionRequirednessDefault value
1storageResourceIdstringrequired
2loginUserNamestringoptional
3fileSystemRootLocationstringoptional
4resourceSpecificCredentialStoreTokenstringoptional

Struct: UserResourceProfile

KeyFieldTypeDescriptionRequirednessDefault value
1userIdstringrequired
2gatewayIDstringrequired
3credentialStoreTokenstringoptional
4userComputeResourcePreferenceslist<UserComputeResourcePreference>optional
5userStoragePreferenceslist<UserStoragePreference>optional
6identityServerTenantstringoptional
7identityServerPwdCredTokenstringoptional

User Resource Profile

userId:
Unique identifier used to link user to corresponding user data model

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: