package mesos

Get desktop application:
View/edit binary Protocol Buffers messages

* ACLs used for authorization.

(message has no fields)

Entity is used to describe a subject(s) or an object(s) of an ACL. NOTE: To allow everyone access to an Entity set its type to 'ANY'. To deny access to an Entity set its type to 'NONE'.

Used in: HTTPGet, HTTPPut, ReceiveOffers, RunTasks

• optional Entity.Type type = 1

• repeated string values = 2

  Ignored for ANY/NONE.

Used in: Entity

• SOME = 0

• ANY = 1

• NONE = 2

Used in: ACLs

• optional Entity usernames = 1

  Subjects (At least one of these should be set).

  HTTP authentication based usernames.

• optional Entity ips = 2

• optional Entity hostnames = 3

• required Entity urls = 4

  Objects.

Used in: ACLs

• optional Entity usernames = 1

  Subjects (At least one of these should be set).

  HTTP authentication based usernames.

• optional Entity ips = 2

• optional Entity hostnames = 3

• required Entity urls = 4

  Objects.

Used in: ACLs

• required Entity principals = 1

  Subjects.

  Framework principals.

• required Entity roles = 2

  Objects.

  Resource roles that can be offered.

ACLs.

Used in: ACLs

• required Entity principals = 1

  Subjects.

  Framework principals.

• required Entity users = 2

  Objects.

  Users to run the tasks/executors as.

Collection of ACL. Each authorization request is evaluated against the ACLs in the order they are defined. For simplicity, the ACLs for a given action are not aggregated even when they have the same subjects or objects. The first ACL that matches the request determines whether that request should be permitted or not. An ACL matches iff both the subjects (e.g., clients, principals) and the objects (e.g., urls, users, roles) of the ACL match the request. If none of the ACLs match the request, the 'permissive' field determines whether the request should be permitted or not. TODO(vinod): Do aggregation of ACLs when possible.

• optional bool permissive = 1

• repeated ACL.RunTasks run_tasks = 2

• repeated ACL.ReceiveOffers receive_offers = 3

• repeated ACL.HTTPGet http_get = 4

• repeated ACL.HTTPPut http_put = 5

* Describes an attribute that can be set on a machine. For now, attributes and resources share the same "value" type, but this may change in the future and attributes may only be string based.

Used in: Offer, SlaveInfo

• required string name = 1

• required Value.Type type = 2

• optional Value.Scalar scalar = 3

• optional Value.Ranges ranges = 4

• optional Value.Set set = 6

• optional Value.Text text = 5

* Describes a command, executed via: '/bin/sh -c value'. Any URIs specified are fetched before executing the command. If the executable field for an uri is set, executable file permission is set on the downloaded file. Otherwise, if the downloaded file has a recognized archive extension (currently [compressed] tar and zip) it is extracted into the executor's working directory. This extraction can be disabled by setting `extract` to false. In addition, any environment variables are set before executing the command (so they can be used to "parameterize" your command).

Used in: ExecutorInfo, TaskInfo

• optional CommandInfo.ContainerInfo container = 4

  NOTE: MesosContainerizer does currently not support this attribute and tasks supplying a 'container' will fail.

• repeated CommandInfo.URI uris = 1

• optional Environment environment = 2

• required string value = 3

  Actual command (i.e., 'echo hello world').

• optional string user = 5

  Enables executor and tasks to run as a specific user. If the user field is present both in FrameworkInfo and here, the CommandInfo user value takes precedence.

• optional HealthCheck health_check = 6

  A health check for the command (currently in *alpha* and initial support will only be for TaskInfo's that have a CommandInfo).

Describes a container. Not all containerizers currently implement ContainerInfo, so it is possible that a launched task will fail due to supplying this attribute. NOTE: The containerizer API is currently in an early beta or even alpha state. Some details, like the exact semantics of an "image" or "options" are not yet hardened. TODO(tillt): Describe the exact scheme and semantics of "image" and "options".

Used in: CommandInfo

• required string image = 1

  URI describing the container image name.

• repeated string options = 2

  Describes additional options passed to the containerizer.

Used in: CommandInfo

• required string value = 1

• optional bool executable = 2

• optional bool extract = 3

* A slave generated ID to distinguish a container. The ID must be unique between any active or completed containers on the slave. In particular, containers for different runs of the same (framework, executor) pair must be unique.

Used in: containerizer.Containers, containerizer.Destroy, containerizer.Launch, containerizer.Update, containerizer.Usage, containerizer.Wait

• required string value = 1

* Credential used for authentication. NOTE: The 'principal' is used for authenticating the framework or slave with the master. This is different from 'FrameworkInfo.user' which is used to determine the user under which the framework's executors/tasks are run.

• required string principal = 1

• optional bytes secret = 2

* Describes a collection of environment variables. This is used with CommandInfo in order to set environment variables before running a command.

Used in: CommandInfo

• repeated Environment.Variable variables = 1

Used in: Environment

• required string name = 1

• required string value = 2

* A framework generated ID to distinguish an executor. Only one executor with the same ID can be active on the same slave at a time.

Used in: ExecutorInfo, Offer, ResourceUsage

• required string value = 1

* Describes information about an executor. The 'data' field can be used to pass arbitrary bytes to an executor.

Used in: TaskInfo, containerizer.Launch

• required ExecutorID executor_id = 1

• optional FrameworkID framework_id = 8

  TODO(benh): Make this required.

• required CommandInfo command = 7

• repeated Resource resources = 5

• optional string name = 9

• optional string source = 10

  Source is an identifier style string used by frameworks to track the source of an executor. This is useful when it's possible for different executor ids to be related semantically. NOTE: Source is exposed alongside the resource usage of the executor via JSON on the slave. This allows users to import usage information into a time series database for monitoring.

• optional bytes data = 4

* Describes possible filters that can be applied to unused resources (see SchedulerDriver::launchTasks) to influence the allocator.

• optional double refuse_seconds = 1

  Time to consider unused resources refused. Note that all unused resources will be considered refused and use the default value (below) regardless of whether Filters was passed to SchedulerDriver::launchTasks. You MUST pass Filters with this field set to change this behavior (i.e., get another offer which includes unused resources sooner or later than the default).

* A unique ID assigned to a framework. A framework can reuse this ID in order to do failover (see MesosSchedulerDriver).

Used in: ExecutorInfo, FrameworkInfo, Offer, ResourceUsage

• required string value = 1

* Describes a framework. The user field is used to determine the Unix user that an executor/task should be launched as. If the user field is set to an empty string Mesos will automagically set it to the current user. Note that the ID is only available after a framework has registered, however, it is included here in order to facilitate scheduler failover (i.e., if it is set then the MesosSchedulerDriver expects the scheduler is performing failover). The amount of time that the master will wait for the scheduler to failover before removing the framework is specified by failover_timeout. If checkpoint is set, framework pid, executor pids and status updates are checkpointed to disk by the slaves. Checkpointing allows a restarted slave to reconnect with old executors and recover status updates, at the cost of disk I/O. The role field is used to group frameworks for allocation decisions, depending on the allocation policy being used. If the hostname field is set to an empty string Mesos will automagically set it to the current hostname. The principal field should match the credential the framework uses in authentication. This field is used for framework API rate exporting and limiting and should be set even if authentication is not enabled if these features are desired.

• required string user = 1

• required string name = 2

• optional FrameworkID id = 3

• optional double failover_timeout = 4

• optional bool checkpoint = 5

• optional string role = 6

• optional string hostname = 7

• optional string principal = 8

* Describes a health check for a task or executor (or any arbitrary process/command). A "strategy" is picked by specifying one of the optional fields, currently only 'http' is supported. Specifying more than one strategy is an error.

Used in: CommandInfo

• optional HealthCheck.HTTP http = 1

• optional double delay_seconds = 2

  Amount of time to wait until starting the health checks.

• optional double interval_seconds = 3

  Interval between health checks.

• optional double timeout_seconds = 4

  Amount of time to wait for the health check to complete.

• optional uint32 failures = 5

  Number of consecutive failures until considered unhealthy.

Describes an HTTP health check.

Used in: HealthCheck

• required uint32 port = 1

  Port to send the HTTP request.

• optional string path = 2

  HTTP request path.

• repeated uint32 statuses = 4

  Expected response statuses. Not specifying any statuses implies that any returned status is acceptable.

* Describes a master. This will probably have more fields in the future which might be used, for example, to link a framework webui to a master webui.

• required string id = 1

• required uint32 ip = 2

• required uint32 port = 3

• optional string pid = 4

• optional string hostname = 5

* Describes some resources available on a slave. An offer only contains resources from a single slave.

• required OfferID id = 1

• required FrameworkID framework_id = 2

• required SlaveID slave_id = 3

• required string hostname = 4

• repeated Resource resources = 5

• repeated Attribute attributes = 7

• repeated ExecutorID executor_ids = 6

* A unique ID assigned to an offer.

Used in: Offer

• required string value = 1

* A generic (key, value) pair used in various places for parameters.

Used in: Parameters

• required string key = 1

• required string value = 2

* Collection of Parameter.

• repeated Parameter parameter = 1

* Describes a request for resources that can be used by a framework to proactively influence the allocator. If 'slave_id' is provided then this request is assumed to only apply to resources on that slave.

• optional SlaveID slave_id = 1

• repeated Resource resources = 2

* Describes a resource on a machine. A resource can take on one of three types: scalar (double), a list of finite and discrete ranges (e.g., [1-10, 20-30]), or a set of items. A resource is described using the standard protocol buffer "union" trick. TODO(benh): Add better support for "expected" resources (e.g., cpus, memory, disk, network).

Used in: ExecutorInfo, Offer, Request, SlaveInfo, TaskInfo, containerizer.Update

• required string name = 1

• required Value.Type type = 2

• optional Value.Scalar scalar = 3

• optional Value.Ranges ranges = 4

• optional Value.Set set = 5

• optional string role = 6

A snapshot of resource usage statistics.

Used in: ResourceUsage

• required double timestamp = 1

  Snapshot time, in seconds since the Epoch.

• optional double cpus_user_time_secs = 2

  CPU Usage Information: Total CPU time spent in user mode, and kernel mode.

• optional double cpus_system_time_secs = 3

• optional double cpus_limit = 4

  Number of CPUs allocated.

• optional uint32 cpus_nr_periods = 7

  cpu.stat on process throttling (for contention issues).

• optional uint32 cpus_nr_throttled = 8

• optional double cpus_throttled_time_secs = 9

• optional uint64 mem_rss_bytes = 5

  Memory Usage Information:

  Resident Set Size.

• optional uint64 mem_limit_bytes = 6

  Amount of memory resources allocated.

• optional uint64 mem_file_bytes = 10

  Broken out memory usage information (files, anonymous, and mmaped files)

• optional uint64 mem_anon_bytes = 11

• optional uint64 mem_mapped_file_bytes = 12

* Describes a snapshot of the resource usage for an executor. TODO(bmahler): Note that we want to be sending this information to the master, and subsequently to the relevant scheduler. So this proto is designed to be easy for the scheduler to use, this is why we provide the slave id, executor info / task info.

• required SlaveID slave_id = 1

• required FrameworkID framework_id = 2

• optional ExecutorID executor_id = 3

  If present, this executor was

• optional string executor_name = 4

  explicitly specified.

• optional TaskID task_id = 5

  If present, the task did not have an executor.

• optional ResourceStatistics statistics = 6

  If missing, the isolation module cannot provide resource usage.

* A unique ID assigned to a slave. Currently, a slave gets a new ID whenever it (re)registers with Mesos. Framework writers shouldn't assume any binding between a slave ID and and a hostname.

Used in: Offer, Request, ResourceUsage, SlaveInfo, TaskInfo, TaskStatus, containerizer.Launch

• required string value = 1

* Describes a slave. Note that the 'id' field is only available after a slave is registered with the master, and is made available here to facilitate re-registration. If checkpoint is set, the slave is checkpointing its own information and potentially frameworks' information (if a framework has checkpointing enabled).

• required string hostname = 1

• optional int32 port = 8

• repeated Resource resources = 3

• repeated Attribute attributes = 5

• optional SlaveID id = 6

• optional bool checkpoint = 7

• optional string webui_hostname = 2

  Deprecated!

• optional int32 webui_port = 4

* Status is used to indicate the state of the scheduler and executor driver after function calls.

• DRIVER_NOT_STARTED = 1

• DRIVER_RUNNING = 2

• DRIVER_ABORTED = 3

• DRIVER_STOPPED = 4

* A framework generated ID to distinguish a task. The ID must remain unique while the task is active. However, a framework can reuse an ID _only_ if a previous task with the same ID has reached a terminal state (e.g., TASK_FINISHED, TASK_LOST, TASK_KILLED, etc.).

Used in: ResourceUsage, TaskInfo, TaskStatus

• required string value = 1

* Describes a task. Passed from the scheduler all the way to an executor (see SchedulerDriver::launchTasks and Executor::launchTask). Either ExecutorInfo or CommandInfo should be set. A different executor can be used to launch this task, and subsequent tasks meant for the same executor can reuse the same ExecutorInfo struct.

Used in: containerizer.Launch

• required string name = 1

• required TaskID task_id = 2

• required SlaveID slave_id = 3

• repeated Resource resources = 4

• optional ExecutorInfo executor = 5

• optional CommandInfo command = 7

• optional bytes data = 6

* Describes possible task states. IMPORTANT: Mesos assumes tasks that enter terminal states (see below) imply the task is no longer running and thus clean up any thing associated with the task (ultimately offering any resources being consumed by that task to another task).

Used in: TaskStatus

• TASK_STAGING = 6

  Initial state. Framework status updates should not use.

• TASK_STARTING = 0

• TASK_RUNNING = 1

• TASK_FINISHED = 2

  TERMINAL.

• TASK_FAILED = 3

  TERMINAL.

• TASK_KILLED = 4

  TERMINAL.

• TASK_LOST = 5

  TERMINAL.

* Describes the current status of a task.

• required TaskID task_id = 1

• required TaskState state = 2

• optional string message = 4

  Possible message explaining state.

• optional bytes data = 3

• optional SlaveID slave_id = 5

• optional double timestamp = 6

* Describes an Attribute or Resource "value". A value is described using the standard protocol buffer "union" trick.

• required Value.Type type = 1

• optional Value.Scalar scalar = 2

• optional Value.Ranges ranges = 3

• optional Value.Set set = 4

• optional Value.Text text = 5

Used in: Ranges

• required uint64 begin = 1

• required uint64 end = 2

Used in: Attribute, Resource, Value

• repeated Range range = 1

Used in: Attribute, Resource, Value

• required double value = 1

Used in: Attribute, Resource, Value

• repeated string item = 1

Used in: Attribute, Value

• required string value = 1

Used in: Attribute, Resource, Value

• SCALAR = 0

• RANGES = 1

• SET = 2

• TEXT = 3