package peloton.private.hostmgr.hostsvc
Get desktop application:
View/edit binary Protocol Buffers messages
* Internal host service interface to be used by JobManager and PlacementEngine for task, reservation, volume and offer operations TODO: figure out a better name for InternalHostService
rpc AcquireHostOffers (, )
hostsvc.proto:354* Acquire a set of host offers from the host manager. Each host offer will only be used by one client at a given time.
message
hostsvc.proto:684optional filter = 1
message
hostsvc.proto:702optional error = 1
repeated hostOffers = 2
The list of host offers that have been returned
map<string, uint32> filterResultCounts = 3
key: HostFilterResult's string form, value: count. used for debugging purpose.
rpc GetHosts (, )
hostsvc.proto:362* Get a list of hosts from the host manager which matches the request This is just the get operation and there is no lock placed on any host.
message
hostsvc.proto:696GetHostsRequest is the request which is been used to call the GetHosts call
optional filter = 1
HostFilter required for matching the desired hosts in cluster
message
hostsvc.proto:718GetHostsResponse is the reponse for GetHosts call it returns the list of hosts if matched or error
optional error = 1
repeated hosts = 2
The list of host that have been matched the HostFilter
rpc ReserveHosts (, )
hostsvc.proto:372ReserveHosts reserves the host for a specified task in the request. Host Manager will keep the host offers to itself till the time it does not have enough offers to itself and once that's fulfilled it will return the reservation with the offer to placement engine. till the time reservation is fulfilled or reservation timeout , offers from that host will not be given to any other placement engine.
message
hostsvc.proto:873ReserveHostsRequest is the request for making reservation for the task
optional reservation = 1
reservation object for the host reservation
message
hostsvc.proto:913ReserveHostsResponse is the response for the reservation request
optional error = 1
Error message if reservation request failed
optional host = 2
Host info which host is reserved
GetCompletedReservations gets the completed host reservations from reserver. Based on the reserver it returns the list of completed Reservations (hostsvc.CompletedReservation) or return the NoFound Error.
message
hostsvc.proto:933GetCompletedReservationRequest is the request for GetCompletedReservation
(message has no fields)
message
hostsvc.proto:938GetCompletedReservationResponse is the response for GetCompletedReservation
optional error = 1
repeated completedReservations = 2
list of completed reservations
rpc ReleaseHostOffers (, )
hostsvc.proto:384* Release unused host offers to the host manager.
message
hostsvc.proto:733repeated hostOffers = 1
message
hostsvc.proto:737optional error = 1
rpc LaunchTasks (, )
hostsvc.proto:387Launch tasks on Mesos cluster
message
hostsvc.proto:744string hostname = 1
repeated tasks = 2
optional agentId = 3
optional id = 4
message
hostsvc.proto:751optional error = 1
rpc KillTasks (, )
hostsvc.proto:390Kill tasks that are running on Mesos cluster
message
hostsvc.proto:792repeated taskIds = 1
message
hostsvc.proto:796optional error = 1
rpc KillAndReserveTasks (, )
hostsvc.proto:395Kill tasks that are running on Mesos cluster, and reserve the host for new task placement. This is used for in-place update/restart.
message
hostsvc.proto:774repeated entries = 1
message
hostsvc.proto:783optional error = 1
rpc ShutdownExecutors (, )
hostsvc.proto:398Shutdown executors that running on a Mesos agent
message
hostsvc.proto:761repeated executors = 1
message
hostsvc.proto:765optional error = 1
rpc ReserveResources (, )
hostsvc.proto:401Reserve resources on a host
message
hostsvc.proto:805repeated resources = 1
message
hostsvc.proto:809TODO: Add errors that could fail a reserve resources request
(message has no fields)
rpc UnreserveResources (, )
hostsvc.proto:404Unreserve resources on a host
message
hostsvc.proto:813repeated resources = 1
message
hostsvc.proto:817TODO: Add errors that could fail a unreserve resources request
(message has no fields)
rpc CreateVolumes (, )
hostsvc.proto:407Create volumes on a Mesos host
message
hostsvc.proto:821repeated volumes = 1
message
hostsvc.proto:825TODO: Add errors that could fail a create volumes request
(message has no fields)
rpc DestroyVolumes (, )
hostsvc.proto:410Destroy volumes on a Mesos host
message
hostsvc.proto:829repeated volumes = 1
message
hostsvc.proto:833TODO: Add errors that could fail a destroy volumes request
(message has no fields)
rpc ClusterCapacity (, )
hostsvc.proto:414TODO move out to separate service if scope widens ClusterCapacity fetches the allocated resources to the framework`
message
hostsvc.proto:848(message has no fields)
message
hostsvc.proto:850optional error = 1
repeated resources = 2
Resources allocated
repeated physicalResources = 3
Resources for total physical capacity.
repeated allocatedSlackResources = 4
Represents total usage slack alloacted.
repeated physicalSlackResources = 5
Represents total slack resources at Cluster.
rpc OfferOperations (, )
hostsvc.proto:417Performs batch offer operations.
message
hostsvc.proto:663repeated operations = 1
Repeated Operations will be performed in sequential manner.
string hostname = 2
The host name of the host where the operations will be performed
optional id = 3
The host offer id of the host where the operations will be performed
message
hostsvc.proto:674optional error = 1
Return leading mesos masters host:port.
message
hostsvc.proto:478* Request for mesos master hostname and port. NOTE: required for protobuf RPC call.
(message has no fields)
message
hostsvc.proto:483* Response for leader mesos master hostname and port.
string hostname = 1
string port = 2
Return all the outstanding offers present in offer pool.
message
hostsvc.proto:491* Request to get all outstanding offers from offer pool.
(message has no fields)
message
hostsvc.proto:496* Responds all outstanding offers of offer pool.
repeated offers = 1
optional error = 2
rpc DisableKillTasks (, )
hostsvc.proto:426Toggles the switch to disable the kill tasks
message
hostsvc.proto:688(message has no fields)
message
hostsvc.proto:691(message has no fields)
rpc GetHostsByQuery (, )
hostsvc.proto:429Return all the hosts with available resources matching the query, used in cli only.
message
hostsvc.proto:510* Request to get all the hosts with available resources matching the query, used in cli.
optional resource = 1
Resource limit, currently only cpu and gpu count are used. The field is ignore if the value is 0.
bool cmpLess = 2
Set to true if wants to return hosts with resources less than provided in the "resource" field, otherwise returns hosts with resources greater than and equal to the resources provided.
repeated string hostnames = 3
Match the agent hostnames if provided.
bool includeRevocable = 4
Set to true if the resource config provided includes revocable resources when applicable, default to false
message
hostsvc.proto:533* Responds all the hosts with available resources matching the query, used in cli.
repeated hosts = 1
rpc WatchEventStreamEvent (, stream )
hostsvc.proto:432Return all the outstanding status update events present in the event stream.
message
hostsvc.proto:562* Responds to all pending status update events.
string watch_id = 1
Unique identifier for the watch session
string topic = 2
optional mesos_task_update = 3
rpc WatchHostSummaryEvent (, stream )
hostsvc.proto:436Return all the host summary event updates from the host manage
message
hostsvc.proto:573* Responds to all host summary update events.
string watch_id = 1
Unique identifier for the watch session
string topic = 2
optional hostSummaryEvent = 3
rpc CancelWatchEvent (, )
hostsvc.proto:440Cancel a watch. The watch stream will get an error indicating watch was cancelled and the stream will be closed.
message
hostsvc.proto:582CancelRequest is request for method WatchService.Cancel
string watch_id = 1
ID of the watch session to cancel.
message
hostsvc.proto:591CancelRequest is response for method WatchService.Cancel Return errors: NOT_FOUND: Watch ID not found
(message has no fields)
rpc GetDrainingHosts (, )
hostsvc.proto:444Get the hosts in DRAINING state. This method is called by Resource Manager to get hosts which are to be drained.
message
hostsvc.proto:959GetDrainingHostsRequest is the request message for InternalHostService.GetDrainingHosts
uint32 limit = 1
Max number of draining hosts to dequeue
uint32 timeout = 2
Timeout in milliseconds if no hosts are draining
message
hostsvc.proto:969GetDrainingHostsResponse is the response message for InternalHostService.GetDrainingHosts
repeated string hostnames = 1
Hostnames of the hosts dequeued
rpc MarkHostDrained (, )
hostsvc.proto:448Mark a host as drained. This method is called by Resource Manager to notify Host Manager the specified DRAINING host is cleared of all tasks.
message
hostsvc.proto:977MarkHostDrainedRequest is the request message for InternalHostService.MarkHostDrained
string hostname = 1
Hostname of the host to be marked as drained
message
hostsvc.proto:985MarkHostDrainedResponse is the response message for InternalHostService.MarkHostDrained
string hostname = 1
Hostname of the host successfully marked as drained
rpc GetMesosAgentInfo (, )
hostsvc.proto:451Return Mesos agent info
message
hostsvc.proto:993* Request for Mesos agent's information as reported by Mesos.
string hostname = 1
Hostname of the agent whose information is being requested. If not provided, information about all agents will be returned.
message
hostsvc.proto:1008* Response containing Mesos agents' information.
optional error = 1
repeated agents = 2
Release the hosts which are held for the tasks provided
message
hostsvc.proto:1018repeated ids = 1
message
hostsvc.proto:1022optional error = 1
rpc GetHostPoolCapacity (, )
hostsvc.proto:459GetHostPoolCapacity fetches the resources for each host-pool.
message
hostsvc.proto:1047* The request for GetHostPoolCapacity.
(message has no fields)
message
hostsvc.proto:1054* The response for GetHostPoolCapacity. Errors: NOT_IMPLEMENTED if host-pools are not enabled.
repeated pools = 1
Resources for each host-pool.
rpc GetTasksByHostState (, )
hostsvc.proto:463GetTasksByHostState gets the tasks on hosts in the specified state.
message
hostsvc.proto:1060Request message for GetTasksByHostState.
api.v0.host.HostState host_state = 1
Host state
uint32 limit = 2
Max number of tasks to dequeue.
uint32 timeout = 3
Timeout in milliseconds if no tasks are ready.
message
hostsvc.proto:1072Response message for GetTasksByHostState.
repeated task_ids = 1
The mesos task IDs of the tasks.
message
hostsvc.proto:324* Error when AcquireHostOffers failed.
Used in:
string message = 1
message
hostsvc.proto:703Used in:
optional invalidHostFilter = 1
optional failure = 2
message
hostsvc.proto:851Used in:
optional clusterUnavailable = 1
message
hostsvc.proto:338* Error when cluster is Unavailable
Used in:
string message = 1
message
hostsvc.proto:71* CompleteReservation is the messege between placement engine and host manager host manager. hostmanager will reserve one host from and once reservation is fulfilled it will send the completed reservation to placement engine
Used in:
optional host = 1
List of hosts which needs to be reserved
optional task = 2
resmgr task for which we need to reserve
optional hostOffer = 3
an offer which needs to be filled once reservation is fulfilled
message
hostsvc.proto:105* ExecutorOnAgent describes the executor to be shutdown by host manager including Mesos agent id and executor id.
Used in: , ,
optional executorId = 1
optional agentId = 2
message
hostsvc.proto:135* FilterHint includes hint provided to host manager to decide which hosts to return. The hint is provided as an optimization and host manager can ignore them if hint cannot be satisfied.
Used in:
repeated hostHint = 1
FilterHint.Ranking rankHint = 2
Hint for ranking hosts
message
hostsvc.proto:137Hint for which host to return
Used in:
string hostname = 1
return the host if it satisfies constraints
optional taskID = 2
indicates for which task the host is for
Ways in which to rank hosts to return
Used in:
FILTER_HINT_RANKING_INVALID = 0
Use system default ranking
FILTER_HINT_RANKING_RANDOM = 1
Rank hosts randomly
FILTER_HINT_RANKING_LEAST_AVAILABLE_FIRST = 2
Rank hosts with least available resources first
FILTER_HINT_RANKING_LOAD_AWARE = 3
Rank hosts with load aware
message
hostsvc.proto:940Error message for GetCompletedReservationResponse
Used in:
optional notFound = 1
No completed reservations found
message
hostsvc.proto:535Host information by aggregating a list of Mesos offers
Used in:
string hostname = 1
name of the host
repeated resources = 2
list of mesos resources for the host
string status = 3
host status - ready, placing, reserved
repeated held_tasks = 4
list of tasks the host is held for, if the host is held for in-place update
repeated tasks = 5
list of tasks running on the host
message
hostsvc.proto:331* Error when GetHosts failed.
Used in:
string message = 1
message
hostsvc.proto:720Error for the response
Used in:
optional invalidHostFilter = 1
InvalidHostFilter if the filter is invalid
optional failure = 2
GetHostsFailure if any other error occurs during fetching the host map
message
hostsvc.proto:1010Error message for GetMesosAgentInfo
Used in:
optional hostNotFound = 1
No information found for host
message
hostsvc.proto:497Used in:
optional noOffers = 1
message
hostsvc.proto:905HostAlreadyReserved error , when host is already reserved
Used in:
string message = 1
message for the failed reason
message
hostsvc.proto:169* HostFilter can be used to control whether offers from a given host should be returned to placement engine to use.
Used in: , ,
optional resourceConstraint = 2
Resource constraint which must be satisfied.
optional schedulingConstraint = 3
Attribute based affinity/anti-affinity scheduling constraints, which is typically copied from original task scheduling constraint. Only constraint with kind == HOST will be considered.
optional quantity = 4
Extra quantity control message which can be used to influence how many host offers are returned.
optional hint = 5
Provides hint to about which hosts should return, host manager may ignore the hint
* HostFilterResult describes result of filtering hosts.
UNKNOWN = 0
Reserved in case new result is unrecognized.
MATCH = 1
Host is matched by filter and returned in HostOffer.
INSUFFICIENT_OFFER_RESOURCES = 2
Host has enough total resources but offered resources is insufficient (signal for fragmentation).
MISMATCH_CONSTRAINTS = 3
Host is filtered out because of mismatched task -> host constraint.
MISMATCH_GPU = 4
Host has GPU so reserved for GPU only task.
MISMATCH_STATUS = 5
Host is in mismatch status (i.e, another placement engine) has a hold of the host.
MISMATCH_MAX_HOST_LIMIT = 6
Host is filtered out because maxHosts limit is reached.
NO_OFFER = 7
Host has no available offer to be matched. Usually this means the host is fully used already.
INSUFFICIENT_RESOURCES = 8
Host has insufficiant resources to match the GetHosts Request.
SCARCE_RESOURCES = 9
Host has scarce resources which are to be used by exclusive task (needing those resources).
message
hostsvc.proto:38* HostInfo describes physical capacity of the hosts with all their attributes defined
Used in: , , ,
string hostname = 1
name of the host
optional agentId = 2
agentId is mesos defined agentID
repeated resources = 3
List of mesos resources for the host
repeated attributes = 4
List of attributes defined for that host
message
hostsvc.proto:1000HostNotFound is an error message for GetMesosAgentInfo
Used in:
string message = 1
Failure message.
message
hostsvc.proto:26* HostOffer describes the resources available on a host by aggregating a list of Mesos offers to avoid offer defragmentation issue.
Used in: , ,
string hostname = 1
optional agentId = 2
repeated resources = 3
repeated attributes = 4
optional id = 5
message
hostsvc.proto:1033* Resources of a host-pool.
Used in:
string poolName = 1
Name of the pool.
repeated physicalCapacity = 2
Resources for physical capacity.
repeated slackCapacity = 3
Resources for slack capacity.
message
hostsvc.proto:897HostUnavailable error , when host is unavailable for reservation
Used in:
string message = 1
message for the failed reason
message
hostsvc.proto:256* Error for invalid argument.
Used in: ,
string message = 1
repeated invalidTasks = 2
Any LaunchableTask whose content is invalid.
message
hostsvc.proto:283* Error for invalid shutdown executors.
Used in:
string message = 1
repeated executors = 2
message
hostsvc.proto:314* Error for invalid filter.
Used in: ,
string message = 1
optional invalid = 2
Invalid filter from input.
message
hostsvc.proto:276* Error for invalid offers.
Used in: ,
string message = 1
message
hostsvc.proto:266* Error for invalid task ids.
Used in: ,
string message = 1
repeated taskIds = 2
Any LaunchableTask whose content is invalid.
message
hostsvc.proto:775Used in:
optional taskId = 1
optional id = 2
string hostToReserve = 3
message
hostsvc.proto:784Used in:
optional invalidTaskIDs = 1
optional killFailure = 2
message
hostsvc.proto:306* Error when actually tasks kill failed.
Used in: ,
string message = 1
repeated taskIds = 2
message
hostsvc.proto:797Used in:
optional invalidTaskIDs = 1
optional killFailure = 2
message
hostsvc.proto:299* Error when actually tasks launch failed.
Used in:
string message = 1
message
hostsvc.proto:752Used in:
optional invalidArgument = 1
optional launchFailure = 2
optional invalidOffers = 3
message
hostsvc.proto:85* LaunchableTask describes the task to be launched by host manager including Mesos task id and task config.
Used in: , ,
optional taskId = 1
optional config = 2
map<string, uint32> ports = 3
Dynamic ports reserved on the host while this instance is running. The key is port name, value is port number.
optional volume = 4
Persistent volume used to launch task.
optional id = 5
Peloton task id of the task to be launched
message
hostsvc.proto:596* NoOffersError represents on outstanding offers are present.
Used in:
string message = 1
message
hostsvc.proto:950NotFound is error message for not valid completed reservation found
Used in:
string message = 1
message for the failed reason
message
hostsvc.proto:614Used in:
OfferOperation.Type type = 1
Type of the operation.
optional reservationLabels = 2
Reservation labels used for operations.
optional reserve = 3
optional create = 4
optional launch = 5
optional destroy = 6
optional unreserve = 7
message
hostsvc.proto:630Used in:
optional volume = 1
Persistent volume to be created.
message
hostsvc.proto:640Used in:
string volumeID = 1
Persistent volume ID to be destroyed.
message
hostsvc.proto:635Used in:
repeated tasks = 1
List of tasks to be launched.
message
hostsvc.proto:625Used in:
repeated resources = 1
Mesos resources to be reserved.
Defines an operation that can be performed against offers.
Used in:
UNKNOWN = 0
LAUNCH = 1
RESERVE = 2
UNRESERVE = 3
CREATE = 4
DESTROY = 5
message
hostsvc.proto:645Used in:
string label = 1
The reservation label string to be unreserved.
message
hostsvc.proto:675Used in:
optional failure = 1
optional invalidArgument = 2
optional invalidOffers = 3
message
hostsvc.proto:470* Error for offer operations call to mesos failed.
Used in:
string message = 1
message
hostsvc.proto:114* QuantityControl includes input from placement engine to control how many host offers need to be returned.
Used in:
uint32 maxHosts = 1
Optinoal maximum number of hosts to return. Default zero value is no-op.
message
hostsvc.proto:738Used in:
(message has no fields)
message
hostsvc.proto:1023Used in:
string message = 1
message
hostsvc.proto:57* Reservation is the messege between placement engine and host manager where placement engine asks hostmanager to reserve one host from certain hosts In the return host manager reserves the host and once resources are fulfilled , it fills the messege with valid offers
Used in:
repeated hosts = 1
List of hosts which needs to be reserved
optional task = 2
resmgr task for which we need to reserve
message
hostsvc.proto:889ReservationAlreadyExist error , when reservation already exist
Used in:
string message = 1
message for the failed reason
message
hostsvc.proto:881ReservationFailed is the failed reservation
Used in:
string message = 1
message for the failed reason
message
hostsvc.proto:914Used in:
optional failed = 1
Failed reservation for the request
optional alreadyExist = 2
Error when reservation already exist
optional hostUnavailable = 3
Host is unavailable for the request
optional hostAlreadyReserved = 4
Host is already reserved
message
hostsvc.proto:840* Resource allocation for a resource
Used in: ,
string kind = 1
Type of the resource
double capacity = 2
capacity of the resource
message
hostsvc.proto:236* ResourceConstraint describes a condition for which aggregated resources from a host must meet in order for it to be returned in `AcquireHostOffers`.
Used in:
optional minimum = 1
Minimum amount of resources NOTE: gpu resources are specially protected in the following way: - if `gpuLimit` is specified, only hosts with enough gpu resources are returned; - if `gpuLimit` is not specified, only hosts without gpu resource will be returned.
uint32 numPorts = 2
Number of dynamic ports
bool revocable = 3
revocable adds a constraint to use revocable/non-revocable resources.
message
hostsvc.proto:766Used in:
optional invalidExecutors = 1
optional shutdownFailure = 2
message
hostsvc.proto:291* Error for failed shutdown executors.
Used in:
string message = 1
repeated executors = 2
message
hostsvc.proto:603* Volume config used for offer create/launch operation.
Used in: ,
optional id = 1
ID of the persistent volume.
string containerPath = 2
the relative volume path inside the container.
optional resource = 3
Resource needed for the volume.
message
hostsvc.proto:555* Request object to watch request by client
Used as request type in: InternalHostService.WatchEventStreamEvent, InternalHostService.WatchHostSummaryEvent
string topic = 1