You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mesos.apache.org by nn...@apache.org on 2015/02/23 20:07:32 UTC

mesos git commit: Updated docs/modules.md to incorporate newer module kinds.

Repository: mesos
Updated Branches:
  refs/heads/master 809f7d6ee -> a0aa123f7


Updated docs/modules.md to incorporate newer module kinds.

Review: https://reviews.apache.org/r/31310


Project: http://git-wip-us.apache.org/repos/asf/mesos/repo
Commit: http://git-wip-us.apache.org/repos/asf/mesos/commit/a0aa123f
Tree: http://git-wip-us.apache.org/repos/asf/mesos/tree/a0aa123f
Diff: http://git-wip-us.apache.org/repos/asf/mesos/diff/a0aa123f

Branch: refs/heads/master
Commit: a0aa123f74ea1eed561c079e923b55a2082dd78c
Parents: 809f7d6
Author: Kapil Arya <ka...@mesosphere.io>
Authored: Mon Feb 23 10:56:12 2015 -0800
Committer: Niklas Q. Nielsen <ni...@mesosphere.io>
Committed: Mon Feb 23 11:07:20 2015 -0800

----------------------------------------------------------------------
 docs/modules.md | 39 ++++++++++++++++++++++++++++++++++-----
 1 file changed, 34 insertions(+), 5 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/mesos/blob/a0aa123f/docs/modules.md
----------------------------------------------------------------------
diff --git a/docs/modules.md b/docs/modules.md
index c674767..a8b4715 100644
--- a/docs/modules.md
+++ b/docs/modules.md
@@ -8,9 +8,7 @@ Experimental support for Mesos modules was introduced in Mesos 0.21.0.
 
 ### Disclaimer
 
-- Use and development of Mesos modules is at own risk! Only graced modules
-(modules that are part of Mesos distribution) are maintained by the Mesos
-project.
+- Use and development of Mesos modules is at own risk!
 
 - Please direct all questions to the relevant module writer and/or write to
 modules@mesos.apache.org. Questions related to modules sent to user and dev list
@@ -119,8 +117,39 @@ If both "file" and "name" are specified, "name" is ignored.
 
 ## What kinds of modules are supported?
 
-Mesos currently only provides Isolator and Authentication modules.  Additional
-graced modules will be added in the near future.
+Here are the various module kinds currently available:
+
+### Anonymous
+
+Anonymous modules do __not__ receive any callbacks but simply
+coexists with their parent process.
+
+Unlike other named modules, an anonymous module does not directly
+replace or provide essential Mesos functionality (such as an
+Isolator module does). Unlike a decorator module it does not
+directly add or inject data into Mesos core either.
+
+Anonymous modules do not require any specific selectors (flags) as
+they are immediately instantiated when getting loaded via the
+`--modules` flag by the Mesos master or slave.
+
+### Authentication
+
+Authenticatee and Authenticator modules allow for third parties to quickly
+develop and plug-in new authentication methods. An example for such modules
+could be to support PAM (LDAP, MySQL, NIS, UNIX) backed authentication.
+
+### Hook
+
+Similar to Apache Webserver Modules, hooks allows module writers to tie into
+internal components which may not be suitable to be abstracted entirely behind
+modules but rather let's them define actions on so-called hooks.
+
+### Isolator
+
+Isolator modules enable experimenting with specialized isolation and monitoring
+capabilities. Examples of these could be 3rdparty resource isolation mechanisms
+for GPGPU hardware, networking, etc.
 
 ## Writing Mesos modules