package peloton.private.hostmgr.v1alpha.svc

Get desktop application:
View/edit binary Protocol Buffers messages

HostManagerService interface to be used by JobManager, PlacementEngine and ResourceManager for scheduling and managing pods and hosts in the cluster.

• rpc AcquireHosts (AcquireHostsRequest, AcquireHostsResponse)

  hostmgr_svc.proto:143

  AcquireHosts acquires a set of hosts from the host manager. Each host will only be used by one client at a given time.

  message AcquireHostsRequest

  hostmgr_svc.proto:15

  AcquireHostsRequest contains host filter used to acquire hosts for placement based on filter constraints.

  • optional hostmgr.HostFilter filter = 1

  message AcquireHostsResponse

  hostmgr_svc.proto:21

  AcquireHostsResponse contains the list of host leases acquired as a result of the filtering operation.

  • repeated hostmgr.HostLease hosts = 1

    The list of hosts that have been acquired for placement.

  • map<string, uint32> filter_result_counts = 2

    Used for debugging purpose. key: HostFilterResult's string form, value: count.

• rpc TerminateLeases (TerminateLeasesRequest, TerminateLeasesResponse)

  hostmgr_svc.proto:147

  TerminateLeases terminates the leases for a set of hosts, effectively releasing the lock that host manager had on those hosts.

  message TerminateLeasesRequest

  hostmgr_svc.proto:32

  TerminateLeasesRequest contains the host leases that need to be terminated so that host manager can release the locks on those hosts.

  • repeated TerminateLeasesRequest.LeasePair leases = 1

    The lease pairs of the acquired hosts who's leases need to be terminated. Each lease pair contains the lease id and the hostname for the lease.

  message TerminateLeasesResponse

  hostmgr_svc.proto:48

  TerminateLeasesResponse is a placeholder response structure.

  (message has no fields)

• rpc LaunchPods (LaunchPodsRequest, LaunchPodsResponse)

  hostmgr_svc.proto:150

  LaunchPods launches pods on the cluster.

  message LaunchPodsRequest

  hostmgr_svc.proto:52

  LaunchPodsRequest contains the lease_id of acquired host and list of pods to be launched on that host.

  • optional hostmgr.LeaseID lease_id = 1

    The lease_id of the acquired host on which pods should be launched.

  • string hostname = 2

    The hostname of the acquired host on which pods should be launched.

  • repeated hostmgr.LaunchablePod pods = 3

    List of pods to be launched which contains podID and podSpec for each pod.

  message LaunchPodsResponse

  hostmgr_svc.proto:64

  LaunchPodsResponse is a placeholder response structure.

  (message has no fields)

• rpc KillPods (KillPodsRequest, KillPodsResponse)

  hostmgr_svc.proto:153

  KillPods kills pods on the cluster.

  message KillPodsRequest

  hostmgr_svc.proto:67

  KillPodsRequest contains the list of podIDs to be killed.

  • repeated api.v1alpha.peloton.PodID pod_ids = 1

    List of podIDs to be killed.

  message KillPodsResponse

  hostmgr_svc.proto:73

  KillPodsResponse is a placeholder response structure.

  (message has no fields)

• rpc KillAndHoldPods (KillAndHoldPodsRequest, KillAndHoldPodsResponse)

  hostmgr_svc.proto:157

  KillAndHoldPods kills a list of pods on the cluster and hold previous hosts for in place upgrade.

  message KillAndHoldPodsRequest

  hostmgr_svc.proto:77

  KillAndHoldPodRequest contains a list of podIDs and hosts to hold for in place upgrade.

  • repeated KillAndHoldPodsRequest.Entry entries = 1

  message KillAndHoldPodsResponse

  hostmgr_svc.proto:86

  KillAndHoldPodsResponse is a placeholder response structure.

  (message has no fields)

• rpc ClusterCapacity (ClusterCapacityRequest, ClusterCapacityResponse)

  hostmgr_svc.proto:161

  ClusterCapacity fetches the actual capacity and allocated resources from the framework.

  message ClusterCapacityRequest

  hostmgr_svc.proto:89

  ClusterCapacityRequest is a request for getting cluster capacity.

  (message has no fields)

  message ClusterCapacityResponse

  hostmgr_svc.proto:93

  ClusterCapacityResponse is the response structure describing the cluster capacity.

  • repeated hostmgr.Resource allocation = 1

    Resources allocated.

  • repeated hostmgr.Resource capacity = 2

    Represents total cluster capacity.

  • repeated hostmgr.Resource slack_allocation = 3

    Represents alloacted slack resources.

  • repeated hostmgr.Resource slack_capacity = 4

    Represents total slack capacity of the cluster.

• rpc GetEvents (GetEventsRequest, GetEventsResponse)

  hostmgr_svc.proto:165

  GetEvents returns all the outstanding podevents in the event stream. For debug purpose only.

  message GetEventsRequest

  hostmgr_svc.proto:108

  Request to get all outstanding podevents in the event stream.

  (message has no fields)

  message GetEventsResponse

  hostmgr_svc.proto:111

  Response of all outstanding podevents in the event stream.

  • repeated eventstream.v1alpha.event.Event events = 1

• rpc GetHostCache (GetHostCacheRequest, GetHostCacheResponse)

  hostmgr_svc.proto:169

  GetHostCache dumps the contents of the host cache. Should only be used for debugging the internal state of the host cache.

  message GetHostCacheRequest

  hostmgr_svc.proto:116

  GetHostCacheRequest is the request to dump the hostcache.

  (message has no fields)

  message GetHostCacheResponse

  hostmgr_svc.proto:119

  GetHostCacheResponse is the dump of the hostcache inside host manager.

  • repeated GetHostCacheResponse.Summary summaries = 1

Used in: GetHostCacheResponse

• string hostname = 1

  The hostname that this summary belongs to.

• string status = 2

  The status of this host.

• repeated hostmgr.Resource allocation = 3

  Resources allocated.

• repeated hostmgr.Resource capacity = 4

  Represents total cluster capacity.

Used in: KillAndHoldPodsRequest

• optional api.v1alpha.peloton.PodID pod_id = 1

• string hostToHold = 2

A LeasePair is a structure holding a hostname and its lease id.

Used in: TerminateLeasesRequest

• optional hostmgr.LeaseID lease_id = 1

  The lease id of the lease pair.

• string hostname = 2

  The hostname of the lease pair.