package peloton.api.v1alpha.respool
Get desktop application:
View/edit binary Protocol Buffers messages
ResourcePoolService defines the resource pool related methods such as create, get, delete and upgrade resource pools.
Create a resource pool entity for a given config
message
respool_svc.proto:14Request message for ResourcePoolService.CreateResourcePool method.
optional respool_id = 1
The unique resource pool UUID specified by the client. This can be used by the client to re-create a failed resource pool without the side-effect of creating duplicated resource pool. If unset, the server will create a new UUID for the resource pool.
optional spec = 2
The detailed configuration of the resource pool be to created.
message
respool_svc.proto:29Response message for ResourcePoolService.CreateResourcePool method. Return errors: ALREADY_EXISTS: if the resource pool already exists. INVALID_ARGUMENT: if the resource pool config is invalid.
optional respool_id = 1
The ID of the newly created resource pool.
rpc GetResourcePool (, )
respool_svc.proto:121Get the resource pool entity
message
respool_svc.proto:35Request message for ResourcePoolService.GetResourcePool method.
optional respool_id = 1
The ID of the resource pool to get the detailed information.
bool include_child_pools = 2
Whether or not to include the resource pool info of the direct children
message
respool_svc.proto:47Response message for ResourcePoolService.GetResourcePool method. Return errors: NOT_FOUND: if the resource pool is not found.
optional respool = 1
The detailed information of the resource pool.
repeated child_respools = 2
The list of child resource pools.
Delete a resource pool entity
message
respool_svc.proto:56Request message for ResourcePoolService.DeleteResourcePool method.
optional respool_id = 1
The ID of the resource pool to be deleted.
message
respool_svc.proto:67Response message for ResourcePoolService.DeleteResourcePool method. Return errors: NOT_FOUND: if the resource pool is not found. INVALID_ARGUMENT: if the resource pool is not leaf node. FAILED_PRECONDITION: if the resource pool is busy. INTERNAL: if the resource pool fail to delete for internal errors.
(message has no fields)
Modify a resource pool entity
message
respool_svc.proto:70Request message for ResourcePoolService.UpdateResourcePool method.
optional respool_id = 1
The ID of the resource pool to update the configuration.
optional spec = 2
The configuration of the resource pool to be updated.
bool Force = 3
Optional boolean which forces an update, even if the validation fails.
message
respool_svc.proto:84Response message for ResourcePoolService.UpdateResourcePool method. Return errors: NOT_FOUND: if the resource pool is not found.
(message has no fields)
Lookup the resource pool ID for a given resource pool path
message
respool_svc.proto:87Request message for ResourcePoolService.LookupResourcePoolID method.
optional path = 1
The resource pool path to look up the resource pool ID.
message
respool_svc.proto:97Response message for ResourcePoolService.LookupResourcePoolID method. Response message for ResourcePoolService.UpdateResourcePool method. Return errors: NOT_FOUND: if the resource pool is not found. INVALID_ARGUMENT: if the resource pool path is invalid.
optional respool_id = 1
The resource pool ID for the given resource pool path.
Query the resource pools.
message
respool_svc.proto:103Request message for ResourcePoolService.QueryResourcePools method.
TODO Filters
(message has no fields)
message
respool_svc.proto:109Response message for ResourcePoolService.QueryResourcePools method. Return errors:
repeated respools = 1
message
respool.proto:134The max limit of resources `CONTROLLER`(see TaskType) tasks can use in this resource pool. This is defined as a percentage of the resource pool's reservation. If undefined there is no maximum limit for controller tasks i.e. controller tasks will not be treated differently. For eg if the resource pool's reservation is defined as: cpu:100 mem:1000 disk:1000 gpu:10 And the ControllerLimit = 10 ,Then the maximum resources the controller tasks can use is 10% of the reservation, i.e. cpu:10 mem:100 disk:100 gpu:1
Used in:
double max_percent = 1
ReservationType indicates reservation type for the resourcepool
Used in:
RESERVATION_TYPE_INVALID = 0
RESERVATION_TYPE_ELASTIC = 1
ELASTIC reservation enables resource pool to be elastic in reservation , which means other resource pool can take resources from this resource pool as well as this resource pool also can take resources from any other resource pool. This is the by default behavior for the resource pool
RESERVATION_TYPE_STATIC = 2
STATIC reservation enables resource pool to be static in reservation , which means irrespective of the demand this resource pool will have atleast reservation as entitlement value. No other resource pool can take resources from this resource pool. If demand for this resource pool is high it can take resources from other resource pools. By default value for reservation type ELASTIC.
message
respool.proto:172Used in: ,
optional respool_id = 1
Resource Pool Id
optional spec = 2
ResourcePool spec
optional parent = 3
Resource Pool's parent TODO: parent duplicated from ResourcePoolConfig
repeated children = 4
Resource Pool's children
repeated usages = 5
Resource usage for each resource kind
optional path = 6
Resource Pool Path
message
respool.proto:26A fully qualified path to a resource pool in a resource pool hierrarchy. The path to a resource pool can be defined as an absolute path, starting from the root node and separated by a slash. The resource hierarchy is anchored at a node called the root, designated by a slash "/". For the below resource hierarchy ; the "compute" resource pool would be desgignated by path: /infrastructure/compute root ├─ infrastructure │ └─ compute └─ marketplace
Used in: , ,
string value = 1
message
respool.proto:82Resource Pool configuration
Used in: , ,
optional revision = 1
Revision of the Resource Pool config
string name = 2
Name of the resource pool
string owning_team = 3
Owning team of the pool
repeated string ldap_groups = 4
LDAP groups of the pool
string description = 5
Description of the resource pool
repeated resources = 6
Resource config of the Resource Pool
optional parent = 7
Resource Pool's parent
SchedulingPolicy policy = 8
Task Scheduling policy
optional controller_limit = 9
The controller limit for this resource pool
optional slack_limit = 10
Cap on max non-slack resources[mem,disk] in percentage that can be used by revocable task.
message
respool.proto:31Resource configuration for a resource
Used in:
string kind = 1
Type of the resource
double reservation = 2
Reservation/min of the resource
double limit = 3
Limit of the resource
double share = 4
Share on the resource pool
ReservationType type = 5
ReservationType indicates the the type of reservation There are two kind of reservation 1. ELASTIC 2. STATIC
message
respool.proto:159Used in:
string kind = 1
Type of the resource
double allocation = 2
Allocation of the resource
double slack = 3
slack is the resource which is allocated but not used and mesos will give those resources as revocable offers
Scheduling policy for Resource Pool.
Used in:
SCHEDULING_POLICY_INVALID = 0
SCHEDULING_POLICY_PRIORITY_FIFO = 1
This scheduling policy will return item for highest priority in FIFO order
message
respool.proto:155The max limit of resources `REVOCABLE`(see TaskType) tasks can use in this resource pool. This is defined as a percentage of the resource pool's reservation. If undefined there is no maximum limit for revocable tasks i.e. revocable tasks will not be treated differently. For eg if the resource pool's reservation is defined as: cpu:100 mem:1000 disk:1000 And the SlackLimit = 10 ,Then the maximum resources the revocable tasks can use is 10% of the reservation, i.e. mem:100 disk:100 For cpu, it will use revocable resources.
Used in:
double maxPercent = 1