Repository: mesos Updated Branches: refs/heads/master 08d07248e -> 853821caf
Improved HTTP API docs. Clarify that HTTP APIs are now considered stable and give some background on how the old and new APIs compare. Review: https://reviews.apache.org/r/50640/ Project: http://git-wip-us.apache.org/repos/asf/mesos/repo Commit: http://git-wip-us.apache.org/repos/asf/mesos/commit/05da9ba0 Tree: http://git-wip-us.apache.org/repos/asf/mesos/tree/05da9ba0 Diff: http://git-wip-us.apache.org/repos/asf/mesos/diff/05da9ba0 Branch: refs/heads/master Commit: 05da9ba06b48f19ad093e2ab66cb1fc7a93c0cb7 Parents: 08d0724 Author: Neil Conway <neil.con...@gmail.com> Authored: Wed Aug 3 19:57:03 2016 -0700 Committer: Anand Mazumdar <an...@apache.org> Committed: Wed Aug 3 19:57:03 2016 -0700 ---------------------------------------------------------------------- docs/executor-http-api.md | 21 ++++++++++++++++++++- docs/scheduler-http-api.md | 22 +++++++++++++++++++++- 2 files changed, 41 insertions(+), 2 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/mesos/blob/05da9ba0/docs/executor-http-api.md ---------------------------------------------------------------------- diff --git a/docs/executor-http-api.md b/docs/executor-http-api.md index fb70f75..50b4cb4 100644 --- a/docs/executor-http-api.md +++ b/docs/executor-http-api.md @@ -5,7 +5,26 @@ layout: documentation # Executor HTTP API -Mesos 0.28.0 added **experimental** support for V1 Executor HTTP API. +A Mesos executor can be built in two different ways: + +1. By using the `ExecutorDriver` C++ interface. The `ExecutorDriver` handles the +details of communicating with the Mesos agent. Executor developers implement +custom executor logic by registering callbacks with the `ExecutorDriver` for +significant events, such as when a new task launch request is received. Because +the `ExecutorDriver` interface is written in C++, this typically requires that +executor developers either use C++ or use a C++ binding to their language of +choice (e.g., JNI when using JVM-based languages). + +2. By using the new HTTP API. This allows Mesos executors to be developed +without using C++ or a native client library; instead, a custom executor +interacts with the Mesos agent via HTTP requests, as described below. Although +it is theoretically possible to use the HTTP executor API "directly" (e.g., by +using a generic HTTP library), most executor developers should use a library for +their language of choice that manages the details of the HTTP API; see the +document on [HTTP API client libraries](api-client-libraries.md) for a list. + +The v1 Executor HTTP API was introduced in Mesos 0.28.0. As of Mesos 1.0, it is +considered stable and is the recommended way to develop new Mesos executors. ## Overview http://git-wip-us.apache.org/repos/asf/mesos/blob/05da9ba0/docs/scheduler-http-api.md ---------------------------------------------------------------------- diff --git a/docs/scheduler-http-api.md b/docs/scheduler-http-api.md index 504872e..a27965a 100644 --- a/docs/scheduler-http-api.md +++ b/docs/scheduler-http-api.md @@ -5,7 +5,27 @@ layout: documentation # Scheduler HTTP API -Mesos 0.24.0 added **experimental** support for v1 Scheduler HTTP API. +A Mesos scheduler can be built in two different ways: + +1. By using the `SchedulerDriver` C++ interface. The `SchedulerDriver` handles +the details of communicating with the Mesos master. Scheduler developers +implement custom scheduling logic by registering callbacks with the +`SchedulerDriver` for significant events, such as receiving a new resource offer +or a status update on a task. Because the `SchedulerDriver` interface is written +in C++, this typically requires that scheduler developers either use C++ or use +a C++ binding to their language of choice (e.g., JNI when using JVM-based +languages). + +2. By using the new HTTP API. This allows Mesos schedulers to be developed +without using C++ or a native client library; instead, a custom scheduler +interacts with the Mesos master via HTTP requests, as described below. Although +it is theoretically possible to use the HTTP scheduler API "directly" (e.g., by +using a generic HTTP library), most scheduler developers should use a library for +their language of choice that manages the details of the HTTP API; see the +document on [HTTP API client libraries](api-client-libraries.md) for a list. + +The v1 Scheduler HTTP API was introduced in Mesos 0.24.0. As of Mesos 1.0, it is +considered stable and is the recommended way to develop new Mesos schedulers. ## Overview