Repository: mesos Updated Branches: refs/heads/master 6be38cca3 -> 0dd0a5696
Updated documentation of FrameworkInfo. Review: https://reviews.apache.org/r/34304 Project: http://git-wip-us.apache.org/repos/asf/mesos/repo Commit: http://git-wip-us.apache.org/repos/asf/mesos/commit/83950ed6 Tree: http://git-wip-us.apache.org/repos/asf/mesos/tree/83950ed6 Diff: http://git-wip-us.apache.org/repos/asf/mesos/diff/83950ed6 Branch: refs/heads/master Commit: 83950ed6f492c0271b7209310e54013a5d97b71c Parents: 6be38cc Author: Vinod Kone <[email protected]> Authored: Fri May 15 17:19:26 2015 -0700 Committer: Vinod Kone <[email protected]> Committed: Thu May 21 14:10:33 2015 -0700 ---------------------------------------------------------------------- include/mesos/mesos.proto | 60 +++++++++++++++++++++++++----------------- 1 file changed, 36 insertions(+), 24 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/mesos/blob/83950ed6/include/mesos/mesos.proto ---------------------------------------------------------------------- diff --git a/include/mesos/mesos.proto b/include/mesos/mesos.proto index 9cc5782..dd3b5dd 100644 --- a/include/mesos/mesos.proto +++ b/include/mesos/mesos.proto @@ -94,40 +94,52 @@ message ContainerID { /** - * 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/limiting and dynamic reservations. It should be set even - * if authentication is not enabled if these features are desired. - * The webui_url field allows a framework to advertise its web UI, so - * that the Mesos web UI can link to it. It is expected to be a full - * URL, for example http://my-scheduler.example.com:8080/. + * Describes a framework. */ message FrameworkInfo { + // Used to determine the Unix user that an executor or task should + // be launched as. If the user field is set to an empty string Mesos + // will automagically set it to the current user. required string user = 1; + + // Name of the framework that shows up in the Mesos Web UI. required string name = 2; + + // Note that '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). optional FrameworkID id = 3; + + // The amount of time that the master will wait for the scheduler to + // failover before removing the framework. optional double failover_timeout = 4 [default = 0.0]; + + // If 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. optional bool checkpoint = 5 [default = false]; + + // Used to group frameworks for allocation decisions, depending on + // the allocation policy being used. optional string role = 6 [default = "*"]; + + // Used to indicate the current host from which the scheduler is + // registered in the Mesos Web UI. If set to an empty string Mesos + // will automagically set it to the current hostname. optional string hostname = 7; + + // This field should match the credential's principal the framework + // uses for authentication. This field is used for framework API + // rate limiting and dynamic reservations. It should be set even + // if authentication is not enabled if these features are desired. optional string principal = 8; + + // This field allows a framework to advertise its web UI, so that + // the Mesos web UI can link to it. It is expected to be a full URL, + // for example http://my-scheduler.example.com:8080/. optional string webui_url = 9; }
