Updated Branches: refs/heads/master a274b0944 -> 03c13930d
Updated the Configuration document. Project: http://git-wip-us.apache.org/repos/asf/mesos/repo Commit: http://git-wip-us.apache.org/repos/asf/mesos/commit/03c13930 Tree: http://git-wip-us.apache.org/repos/asf/mesos/tree/03c13930 Diff: http://git-wip-us.apache.org/repos/asf/mesos/diff/03c13930 Branch: refs/heads/master Commit: 03c13930d76372d3abb334ae9eb7ca9dbcd41bb7 Parents: a274b09 Author: Benjamin Mahler <[email protected]> Authored: Sat Jul 20 11:28:54 2013 -0700 Committer: Benjamin Mahler <[email protected]> Committed: Sat Jul 20 11:29:34 2013 -0700 ---------------------------------------------------------------------- docs/Configuration.md | 44 +++++++++++++++++++++++++++++++++++++++++ docs/Configuration.textile | 38 ----------------------------------- 2 files changed, 44 insertions(+), 38 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/mesos/blob/03c13930/docs/Configuration.md ---------------------------------------------------------------------- diff --git a/docs/Configuration.md b/docs/Configuration.md new file mode 100644 index 0000000..918f141 --- /dev/null +++ b/docs/Configuration.md @@ -0,0 +1,44 @@ +# Configuration # +If you have special compilation requirements, please refer to `./configure --help` when configuring Mesos. + +The Mesos master and slave can take a variety of configuration options through command-line arguments, or environment variables. A list of the available options can be seen by running `mesos-master --help` or `mesos-slave --help`. Each option can be set in three ways: + + - By passing it to the binary using `--option_name=value`. + - By setting the environment variable `MESOS_OPTION_NAME` (the option name in all caps with a `MESOS_` prefix added to it). + +Configuration values are searched for first on the command line, then in the environment. + +## Important Options ## + +These are only a subset of the options. The following list may not match the version of mesos you are running, as the flags evolve from time to time in the code. + +**For now, the definitive source for which flags your version of Mesos supports can be found by running the binary with the flag `--help`, for example `bin/mesos-master --help`**. This will change as we add canonical documentation for each release. + +### Master and Slave Options ### + + - `log_dir` : Directory for log files. If unspecified, nothing is written to disk. + - `quiet` : Disable logging to stderr. [Default: false] + - `ip` : IP address to listen on. [Optional] + - `port` : Port to listen on. [Default for master: 5050, Default for slave:5051] + +### Master Options ### + + - `zk` : ZooKeeper URL (used for leader election amongst multiple masters). May be one of: + - zk://host1:port1,host2:port2,.../path + - zk://username:password@host1:port1,host2:port2,.../path + - file://path/to/file (where file contains one of the above) + +### Slave Options ### + + - `resources` : Total consumable resources for the slave. + - Ex: "cpus:8.0;memory:4096;disk:20480;ports:[30000-50000]" + - `attributes` : Attributes for the machine. [Optional] + - These are free-form in the same style as resources, ex: "rack:abc;kernel:2.6.44". + - This information is provided to frameworks. + - `work_dir` : Directory for the framework work directories. [Default: /tmp/mesos] + - `isolation` : Isolation mechanism, one of: "process", "cgroups". [Default: process] + - `cgroups_enable_cfs` : If using cgroups isolation, this enables hard limits on CPU resources. + - `master` : May be one of: + - zk://host1:port1,host2:port2,.../path + - zk://username:password@host1:port1,host2:port2,.../path\n + - file://path/to/file (where file contains one of the above) http://git-wip-us.apache.org/repos/asf/mesos/blob/03c13930/docs/Configuration.textile ---------------------------------------------------------------------- diff --git a/docs/Configuration.textile b/docs/Configuration.textile deleted file mode 100644 index 93c54ba..0000000 --- a/docs/Configuration.textile +++ /dev/null @@ -1,38 +0,0 @@ -The Mesos master and slave can take a variety of configuration options through command-line arguments, environment variables, or a config file. A list of the available options can be seen by running @mesos-master --help@ or @mesos-slave --help@. Each option can be set in three ways: -* By passing it to the binary using @--option_name=value@. -* By setting the environment variable @MESOS_OPTION_NAME@ (the option name with a @MESOS_@ prefix added to it). -* By adding a line in the @mesos.conf@ file located in @MESOS_HOME/conf@, where @MESOS_HOME@ is the directory in which Mesos is located. - -Configuration values are searched for first on the command line, then in the environment, and then in the config file. - -In addition, it is possible to tell the binaries to use a different configuration directory from the default, in order to run multiple Mesos configurations from the same install directories. This is done by passing the @--conf=DIR@ option to the binary. The directory passed should contain a file called @mesos.conf@. A config directory is used instead of passing a file directly because, in the future, there may be multiple config files in the same directory (e.g. a separate one for the allocation module). - -h1. Common Options - -The following list may not match the version of mesos you are running, as the configuration flags evolve from time to time in the code. - -<div style="font-size:1.5em"><b>The definitive source for which flags your version of Mesos supports can be found by running the binary with the flag <code>--help</code>, for example <code>bin/mesos-master --help</code>.</b></div> - -The following options are commonly configured for both the master and slave: - -|_. Parameter |_. Description| -|@webui_port@ | Port to bind to for user-viewable web UI. | -|@log_dir@ | Directory to place logs into, including "event history":Event-history.md logs. It is recommended to use a local disk for each node. | -|@quiet@ | Disable logging to standard error. | -|@conf@ | Specifies a config directory to use instead of the default one. | - -The following options are commonly configured for the slave: - -|_. Parameter |_. Description| -|@master@ | Master URL to connect to. | -|@resources@ | A semicolon separated set of _key:value_ pairs, e.g. <code>cpus:1;mem:1024</code> | -|@work_dir@ | Directory for slaves to place framework's output files in. It is recommended to use a local disk for each slave. | -|@isolation@ | Isolation module to use for isolating tasks. The default is @process@, which performs no isolation other than running each framework as its user, but @lxc@ can be used on systems that support Linux Containers. See "using Linux containers":Using-Linux-Containers.textile for details. | -|@hadoop_home@ | Location of Hadoop, if you wish to use the Hadoop Distributed File System for distributing framework binaries across the cluster. | - -The following options are commonly configured for the master: - -|_. Parameter |_. Description| -|@url@ | A ZooKeeper URL can be specified when "using ZooKeeper":Using-ZooKeeper.textile. | -|@port@ | Port to bind to for communication between master and slaves. | -|@ip@ | Which IP address to bind to (to make the master bind to a desired network interface if it does not do so by default). |
