package peloton.api.v0.respool
Get desktop application:
View/edit binary Protocol Buffers messages
service ResourceManager
respool.proto:213* DEPRECATED by peloton.api.v0.respool.svc.ResourcePoolService Resource Manager service interface
rpc CreateResourcePool (, )
respool.proto:216Create a resource pool entity for a given config
message
respool.proto:283DEPRECATED by peloton.api.v0.respool.svc.CreateResourcePoolRequest
optional config = 2
message
respool.proto:288DEPRECATED by peloton.api.v0.respool.svc.CreateResourcePoolResponse
optional error = 1
optional result = 2
rpc GetResourcePool (, )
respool.proto:219Get the resource pool entity
message
respool.proto:300DEPRECATED by peloton.api.v0.respool.svc.GetResourcePoolRequest
optional id = 1
The ID of the resource pool to get
bool includeChildPools = 2
Whether or not to include the resource pool info of the direct children
message
respool.proto:310DEPRECATED by peloton.api.v0.respool.svc.GetResourcePoolRequest
optional error = 1
optional poolinfo = 2
repeated childPools = 3
rpc DeleteResourcePool (, )
respool.proto:222Delete a resource pool entity
message
respool.proto:321DEPRECATED by peloton.api.v0.respool.svc.DeleteResourcePoolRequest
optional path = 1
message
respool.proto:326DEPRECATED by peloton.api.v0.respool.svc.DeleteResourcePoolResponse
optional error = 1
rpc UpdateResourcePool (, )
respool.proto:225modify a resource pool entity
message
respool.proto:338DEPRECATED by peloton.api.v0.respool.svc.UpdateResourcePoolRequest
optional id = 1
optional config = 2
bool Force = 3
message
respool.proto:345DEPRECATED by peloton.api.v0.respool.svc.UpdateResourcePoolResponse
optional error = 1
Lookup the resource pool ID for a given resource pool path
message
respool.proto:355DEPRECATED by peloton.api.v0.respool.svc.LookupResourcePoolIDRequest
optional path = 1
message
respool.proto:360DEPRECATED by peloton.api.v0.respool.svc.LookupResourcePoolIDResponse
optional error = 1
optional id = 2
rpc Query (, )
respool.proto:231Query the resource pool.
message
respool.proto:371DEPRECATED by peloton.api.v0.respool.svc.QueryResourcePoolRequest
TODO Filters
(message has no fields)
message
respool.proto:376DEPRECATED by peloton.api.v0.respool.svc.QueryResourcePoolResponse
optional error = 1
repeated resourcePools = 2
* 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:49* Request message for ResourcePoolService.CreateResourcePool method.
optional 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 config = 2
The detailed configuration of the resource pool be to created.
message
respool_svc.proto:69* Response message for ResourcePoolService.CreateResourcePool method. Return errors: ALREADY_EXISTS: if the resource pool already exists. INVALID_ARGUMENT: if the resource pool config is invalid.o
optional id = 1
The ID of the newly created resource pool.
rpc GetResourcePool (, )
respool_svc.proto:27Get the resource pool entity
message
respool_svc.proto:78* Request message for ResourcePoolService.GetResourcePool method.
optional id = 1
The ID of the resource pool to get the detailed information.
bool includeChildPools = 2
Whether or not to include the resource pool info of the direct children
message
respool_svc.proto:94* Response 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 childResPools = 2
The list of child resource pools.
Delete a resource pool entity
message
respool_svc.proto:106* Request message for ResourcePoolService.DeleteResourcePool method.
optional id = 1
The ID of the resource pool to be deleted.
message
respool_svc.proto:121* Response 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:128* Request message for ResourcePoolService.UpdateResourcePool method.
optional id = 1
The ID of the resource pool to update the configuration.
optional config = 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:146* Response 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:153* Request message for ResourcePoolService.LookupResourcePoolID method.
optional path = 1
The resource pool path to look up the resource pool ID.
message
respool_svc.proto:166* Response message for ResourcePoolService.LookupResourcePoolID method. Return errors: NOT_FOUND: if the resource pool is not found. INVALID_ARGUMENT: if the resource pool path is invalid.
optional id = 2
The resource pool ID for the given resource pool path.
Query the resource pools.
message
respool_svc.proto:175* Request message for ResourcePoolService.QueryResourcePools method.
TODO Filters
(message has no fields)
message
respool_svc.proto:185* Response message for ResourcePoolService.QueryResourcePools method. Return errors:
repeated resPools = 2
message
respool.proto:150The 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 maxPercent = 1
message
respool.proto:289Used in:
optional alreadyExists = 1
optional invalidResourcePoolConfig = 2
message
respool.proto:327Used in:
optional notFound = 1
optional isBusy = 2
optional isNotLeaf = 3
optional notDeleted = 4
message
respool.proto:311Used in:
optional notFound = 1
message
respool.proto:241DEPRECATED by google.rpc.ALREADY_EXISTS error
Used in: ,
optional id = 1
string message = 2
message
respool.proto:259DEPRECATED by google.rpc.INVALID_ARGUMENT error
Used in:
optional path = 1
string message = 2
message
respool.proto:361Used in:
optional notFound = 1
optional invalidPath = 2
message
respool.proto:377TODO add error types
Used in:
(message has no fields)
* ReservationType indicates reservation type for the resourcepool
Used in:
UNKNOWN_TYPE = 0
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
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:38* Resource 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:235DEPRECATED by google.rpc.ALREADY_EXISTS error
Used in:
optional id = 1
string message = 2
message
respool.proto:96* Resource Pool configuration
Used in: , , , ,
optional changeLog = 1
Change log entry of the Resource Pool config TODO use peloton.Changelog
string name = 2
Name of the resource pool
string owningTeam = 3
Owning team of the pool
repeated string ldapGroups = 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 controllerLimit = 9
The controller limit for this resource pool
optional slackLimit = 10
Cap on max non-slack resources[mem,disk] in percentage that can be used by revocable task.
message
respool.proto:188Used in: , , ,
optional id = 1
Resource Pool Id
optional config = 2
ResourcePool config
optional parent = 3
Resource Pool's parent TODO: parent duplicated from ResourcePoolConfig
repeated children = 4
Resource Pool's children
repeated usage = 5
Resource usage for each resource kind
optional path = 6
Resource Pool Path
message
respool.proto:265DEPRECATED by google.rpc.FAILED_PRECONDITION error
Used in:
optional id = 1
string message = 2
message
respool.proto:271DEPRECATED by google.rpc.INVALID_ARGUMENT error
Used in:
optional id = 1
string message = 2
message
respool.proto:277DEPRECATED by google.rpc.INTERNAL error
Used in:
optional id = 1
string message = 2
message
respool.proto:247DEPRECATED by google.rpc.NOT_FOUND error
Used in: ,
optional id = 1
string message = 2
message
respool.proto:31* A 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:253DEPRECATED by google.rpc.NOT_FOUND error
Used in: ,
optional path = 1
string message = 2
message
respool.proto:175Used 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:
UNKNOWN = 0
PriorityFIFO = 1
This scheduling policy will return item for highest priority in FIFO order
message
respool.proto:171The 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
message
respool.proto:346Used in:
optional notFound = 1
optional invalidResourcePoolConfig = 2