Added/updated documentation for --modules and --modules_dir flags. Review: https://reviews.apache.org/r/47906/
Project: http://git-wip-us.apache.org/repos/asf/mesos/repo Commit: http://git-wip-us.apache.org/repos/asf/mesos/commit/41e94c5a Tree: http://git-wip-us.apache.org/repos/asf/mesos/tree/41e94c5a Diff: http://git-wip-us.apache.org/repos/asf/mesos/diff/41e94c5a Branch: refs/heads/master Commit: 41e94c5af2dd018233893e469aa90d87923b6c8a Parents: 4dfdc87 Author: Kapil Arya <[email protected]> Authored: Mon May 30 19:25:24 2016 +0200 Committer: Till Toenshoff <[email protected]> Committed: Mon May 30 19:59:57 2016 +0200 ---------------------------------------------------------------------- docs/modules.md | 23 ++++++++++++++++------- 1 file changed, 16 insertions(+), 7 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/mesos/blob/41e94c5a/docs/modules.md ---------------------------------------------------------------------- diff --git a/docs/modules.md b/docs/modules.md index cf80e1c..aa5e50c 100644 --- a/docs/modules.md +++ b/docs/modules.md @@ -29,19 +29,28 @@ scripting languages without forcing those dependencies into the project. Finally, modules provide an easy way for third parties to easily extend Mesos without having to know all the internal details. +## Where can Mesos modules be used? +Modules can be specified for master, agent and tests. Modules can also be used +with schedulers that link against libmesos. Currently, modules can not be +used with executors. ## <a name="Invoking"></a>Invoking Mesos modules +There are two ways to specify a list of modules to be loaded and be available to +the internal subsystems. -The command-line flag `--modules` is available for Mesos master, agent, and -tests to specify a list of modules to be loaded and be available to the internal -subsystems. - -Use `--modules=filepath` to specify the list of modules via a -file containing a JSON-formatted string. 'filepath' can be -of the form 'file:///path/to/file' or '/path/to/file'. +* `--modules=filepath` to specify the list of modules via a manifest file + containing a JSON-formatted string. 'filepath' can be of the form + 'file:///path/to/file' or '/path/to/file'. Use `--modules="{...}"` to specify the list of modules inline. +* `--modules_dir=dirpath`to specify a directory name that contains several + module manifest files. Each file must contain a valid JSON-formatted + string containing module description. The module manifest files are processed + in alphabetical order. + +NOTE: Only one of `--modules` or `--modules_dir` flag can be used at time. + ### Example JSON strings:
