Thrift module: allocation_manager_models
Required allocation request details
id : (primary key) Ask the user to assign project ID, but this project should unique, we will need an API endpoint to check whether this ID is not used by other projects and the username
applicationsToBeUsed : Select the application that the user intends to use, according to application chosen here, resources that can be allocable will be fetch from resource discovery module. User will not be restricted to these application upon allocation grant, provided the resources allocated support the application.
diskUsageRangePerJob : An optional field to help reviewer and PI for allocation approval
documents : Resume, CV, PI’s portfolio etc
fieldOfScience :An optional field to help reviewer and PI for allocation approval
keywords : Keyword will be helpful in search
maxMemoryPerCpu :An optional field to help reviewer and PI for allocation approval
numberOfCpuPerJob : An optional field to help reviewer and PI for allocation approval
projectDescription :(Eg: Hypothesis, Model Systems, Methods, and Analysis)
projectReviewedAndFundedBy : (Eg., NSF, NIH, DOD, DOE, None etc...). An optional field to help reviewer and PI for allocation approval
requestedDate: The date the allocation was requested
serviceUnits : 1 SU is approximately 1 workstation CPU hour, if the user fails to give a value, default value will be chosen.
specificResourceSelection : This list will be fetched from resource discovery module, in case of community allocation, the request is subject to reviewers, PI discretion and availability
title : Assign a title to allocation request
typeOfAllocation : If the User has an exclusive allocation with third party organization and wants to use airavata middleware to manage jobs.
typicalSuPerJob : An optional field to help reviewer and PI for allocation approval
Data structures
Struct: UserAllocationDetail
| Key | Field | Type | Description | Requiredness | Default value |
| 1 | projectId | string | | optional | |
| 2 | applicationsToBeUsed | string | | optional | |
| 3 | diskUsageRangePerJob | i64 | | optional | |
| 4 | documents | binary | | optional | |
| 5 | fieldOfScience | string | | optional | |
| 6 | keywords | string | | optional | |
| 7 | maxMemoryPerCpu | i64 | | optional | |
| 8 | numberOfCpuPerJob | i64 | | optional | |
| 9 | projectDescription | string | | optional | |
| 10 | projectReviewedAndFundedBy | string | | optional | |
| 11 | requestedDate | i64 | | optional | |
| 12 | serviceUnits | i64 | | optional | |
| 13 | specificResourceSelection | string | | optional | |
| 14 | title | string | | optional | |
| 15 | typeOfAllocation | string | | optional | |
| 16 | typicalSuPerJob | i64 | | optional | |
| 17 | awardAllocation | i64 | | optional | |
| 18 | startDate | i64 | | optional | |
| 19 | endDate | i64 | | optional | |
| 20 | status | string | | optional | |
| 21 | username | string | | optional | |
Required allocation request details
id : (primary key) Ask the user to assign project ID, but this project should unique, we will need an API endpoint to check whether this ID is not used by other projects and the username
applicationsToBeUsed : Select the application that the user intends to use, according to application chosen here, resources that can be allocable will be fetch from resource discovery module. User will not be restricted to these application upon allocation grant, provided the resources allocated support the application.
diskUsageRangePerJob : An optional field to help reviewer and PI for allocation approval
documents : Resume, CV, PI’s portfolio etc
fieldOfScience :An optional field to help reviewer and PI for allocation approval
keywords : Keyword will be helpful in search
maxMemoryPerCpu :An optional field to help reviewer and PI for allocation approval
numberOfCpuPerJob : An optional field to help reviewer and PI for allocation approval
projectDescription :(Eg: Hypothesis, Model Systems, Methods, and Analysis)
projectReviewedAndFundedBy : (Eg., NSF, NIH, DOD, DOE, None etc...). An optional field to help reviewer and PI for allocation approval
requestedDate: The date the allocation was requested
serviceUnits : 1 SU is approximately 1 workstation CPU hour, if the user fails to give a value, default value will be chosen.
specificResourceSelection : This list will be fetched from resource discovery module, in case of community allocation, the request is subject to reviewers, PI discretion and availability
title : Assign a title to allocation request
typeOfAllocation : If the User has an exclusive allocation with third party organization and wants to use airavata middleware to manage jobs.
typicalSuPerJob : An optional field to help reviewer and PI for allocation approval
Struct: ReviewerAllocationDetail
| Key | Field | Type | Description | Requiredness | Default value |
| 1 | projectId | string | | optional | |
| 2 | applicationsToBeUsed | string | | optional | |
| 3 | diskUsageRangePerJob | i64 | | optional | |
| 4 | documents | binary | | optional | |
| 5 | fieldOfScience | string | | optional | |
| 6 | keywords | string | | optional | |
| 7 | maxMemoryPerCpu | i64 | | optional | |
| 8 | numberOfCpuPerJob | i64 | | optional | |
| 9 | projectDescription | string | | optional | |
| 10 | projectReviewedAndFundedBy | string | | optional | |
| 11 | requestedDate | i64 | | optional | |
| 12 | serviceUnits | i64 | | optional | |
| 13 | specificResourceSelection | string | | optional | |
| 14 | title | string | | optional | |
| 15 | typeOfAllocation | string | | optional | |
| 16 | typicalSuPerJob | i64 | | optional | |
| 17 | awardAllocation | i64 | | optional | |
| 18 | startDate | i64 | | optional | |
| 19 | endDate | i64 | | optional | |
| 20 | status | string | | optional | |
| 21 | username | string | | optional | |
| 22 | id | i64 | | optional | |
Struct: ProjectReviewer
| Key | Field | Type | Description | Requiredness | Default value |
| 1 | projectId | string | | optional | |
| 2 | reviewer | string | | optional | |
| 3 | id | i64 | | optional | |
Allocation Request status details
projectId: Unique id of the project
awardAllocation: Allocation awarded
endDate: End date of the request
reviewers: reviewers of the request
startDate: Start date of the allocation
status: Status of the allocation request
Struct: UserDetail
| Key | Field | Type | Description | Requiredness | Default value |
| 1 | username | string | | optional | |
| 2 | email | string | | optional | |
| 3 | fullName | string | | optional | |
| 4 | password | string | | optional | |
| 5 | userType | string | | optional | |
A user should have an account with airavata to request an allocation
username : Login Username
email :Login email
fullName: Full name of the user
Password: Password of the user
userType: Type of the user
Exception: AllocationManagerException
| Key | Field | Type | Description | Requiredness | Default value |
| 1 | message | string | | required | |
Exception model used in the allocation manager service