Reorganized configuration documentation. This splits `docs/configuration.md` into the `docs/configuration` folder. The documentation had grown too large, and so with `configuration.md` becoming a table of contents, the discoverability of the various runtime and build configurations is improved.
Review: https://reviews.apache.org/r/62733/ Project: http://git-wip-us.apache.org/repos/asf/mesos/repo Commit: http://git-wip-us.apache.org/repos/asf/mesos/commit/8c0b3512 Tree: http://git-wip-us.apache.org/repos/asf/mesos/tree/8c0b3512 Diff: http://git-wip-us.apache.org/repos/asf/mesos/diff/8c0b3512 Branch: refs/heads/master Commit: 8c0b3512eb06fc256d7420ff35c2f25bb2e0d2ed Parents: 5824eaf Author: Andrew Schwartzmeyer <and...@schwartzmeyer.com> Authored: Wed Oct 11 12:24:05 2017 -0700 Committer: Joseph Wu <josep...@apache.org> Committed: Wed Oct 11 12:27:24 2017 -0700 ---------------------------------------------------------------------- docs/agent-recovery.md | 2 +- docs/authorization.md | 2 +- docs/cmake.md | 2 +- docs/configuration.md | 3099 +-------------------------- docs/configuration/agent.md | 1324 ++++++++++++ docs/configuration/autotools.md | 575 +++++ docs/configuration/cmake.md | 160 ++ docs/configuration/libprocess.md | 109 + docs/configuration/master-and-agent.md | 382 ++++ docs/configuration/master.md | 577 +++++ docs/container-image.md | 2 +- docs/docker-containerizer.md | 2 +- docs/fetcher.md | 2 +- docs/home.md | 2 +- docs/logging.md | 3 +- docs/sandbox.md | 2 +- 16 files changed, 3154 insertions(+), 3091 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/mesos/blob/8c0b3512/docs/agent-recovery.md ---------------------------------------------------------------------- diff --git a/docs/agent-recovery.md b/docs/agent-recovery.md index f8f9cae..35cd5b1 100644 --- a/docs/agent-recovery.md +++ b/docs/agent-recovery.md @@ -41,7 +41,7 @@ A framework can control whether its executors will be recovered by setting the ` ## Agent Configuration -Three [configuration flags](configuration.md) control the recovery behavior of a Mesos agent: +Three [configuration flags](configuration/agent.md) control the recovery behavior of a Mesos agent: * `strict`: Whether to do agent recovery in strict mode [Default: true]. - If strict=true, all recovery errors are considered fatal. http://git-wip-us.apache.org/repos/asf/mesos/blob/8c0b3512/docs/authorization.md ---------------------------------------------------------------------- diff --git a/docs/authorization.md b/docs/authorization.md index da51e8b..fdbef77 100644 --- a/docs/authorization.md +++ b/docs/authorization.md @@ -15,7 +15,7 @@ A reference implementation _local authorizer_ provides basic security for most use cases. This authorizer is configured using Access Control Lists (ACLs). Alternative implementations could express their authorization rules in different ways. The local authorizer is used if the -[`--authorizers`](configuration.md) flag is not specified (or manually set to +[`--authorizers`](configuration/master.md) flag is not specified (or manually set to the default value `local`) and ACLs are specified via the [`--acls`](configuration.md) flag. http://git-wip-us.apache.org/repos/asf/mesos/blob/8c0b3512/docs/cmake.md ---------------------------------------------------------------------- diff --git a/docs/cmake.md b/docs/cmake.md index 3e7e229..74df542 100644 --- a/docs/cmake.md +++ b/docs/cmake.md @@ -33,7 +33,7 @@ Download and install the MSI from [CMake.org][cmake-download]. # Supported options -See [configuration options](configuration.md#cmake-configuration-options). +See [configuration options](configuration/cmake.md). # Examples http://git-wip-us.apache.org/repos/asf/mesos/blob/8c0b3512/docs/configuration.md ---------------------------------------------------------------------- diff --git a/docs/configuration.md b/docs/configuration.md index 62562b0..6c593ff 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -3,8 +3,7 @@ title: Apache Mesos - Configuration layout: documentation --- - -# Mesos Configuration +# Mesos Runtime Configuration The Mesos master and agent can take a variety of configuration options through command-line arguments or environment variables. A list of the @@ -22,3102 +21,38 @@ name with a `MESOS_` prefix added to it). Configuration values are searched for first in the environment, then on the command-line. -**Important Options** - -If you have special compilation requirements, please refer to -`./configure --help` when configuring Mesos. Additionally, this -documentation lists only a recent snapshot of the options in Mesos. A -definitive source for which flags your version of Mesos supports can -be found by running the binary with the flag `--help`, for example -`mesos-master --help`. +Additionally, this documentation lists only a recent snapshot of the options in +Mesos. A definitive source for which flags your version of Mesos supports can be +found by running the binary with the flag `--help`, for example `mesos-master +--help`. ## Master and Agent Options -*These options can be supplied to both masters and agents.* - -<table class="table table-striped"> - <thead> - <tr> - <th width="30%"> - Flag - </th> - <th> - Explanation - </th> - </tr> - </thead> -<tr> - <td> - --advertise_ip=VALUE - </td> - <td> -IP address advertised to reach this Mesos master/agent. -The master/agent does not bind to this IP address. -However, this IP address may be used to access this master/agent. - </td> -</tr> -<tr> - <td> - --advertise_port=VALUE - </td> - <td> -Port advertised to reach this Mesos master/agent (along with -<code>advertise_ip</code>). The master/agent does not bind using this port. -However, this port (along with <code>advertise_ip</code>) may be used to -access Mesos master/agent. - </td> -</tr> -<tr> - <td> - --[no-]authenticate_http_readonly - </td> - <td> -If <code>true</code>, only authenticated requests for read-only HTTP endpoints -supporting authentication are allowed. If <code>false</code>, unauthenticated -requests to such HTTP endpoints are also allowed. - </td> -</tr> -<tr> - <td> - --[no-]authenticate_http_readwrite - </td> - <td> -If <code>true</code>, only authenticated requests for read-write HTTP endpoints -supporting authentication are allowed. If <code>false</code>, unauthenticated -requests to such HTTP endpoints are also allowed. - </td> -</tr> -<tr> - <td> - --firewall_rules=VALUE - </td> - <td> -The value could be a JSON-formatted string of rules or a -file path containing the JSON-formatted rules used in the endpoints -firewall. Path must be of the form <code>file:///path/to/file</code> -or <code>/path/to/file</code>. -<p/> -See the <code>Firewall</code> message in <code>flags.proto</code> for the expected format. -<p/> -Example: -<pre><code>{ - "disabled_endpoints" : { - "paths" : [ - "/files/browse", - "/metrics/snapshot" - ] - } -}</code></pre> - </td> -</tr> -<tr> - <td> - --domain=VALUE - </td> - <td> -Domain that the master or agent belongs to. Mesos currently only supports -fault domains, which identify groups of hosts with similar failure -characteristics. A fault domain consists of a region and a zone. All masters -in the same Mesos cluster must be in the same region (they can be in -different zones). Agents configured to use a different region than the -master's region will not appear in resource offers to frameworks that have -not enabled the <code>REGION_AWARE</code> capability. This value can be -specified as either a JSON-formatted string or a file path containing JSON. -<p/> -Example: -<pre><code>{ - "fault_domain": - { - "region": - { - "name": "aws-us-east-1" - }, - "zone": - { - "name": "aws-us-east-1a" - } - } -}</code></pre> - </td> -</tr> -<tr> - <td> - --[no-]help - </td> - <td> -Show the help message and exit. (default: false) - </td> -</tr> -<tr> - <td> - --hooks=VALUE - </td> - <td> -A comma-separated list of hook modules to be installed inside master/agent. - </td> -</tr> -<tr> - <td> - --hostname=VALUE - </td> - <td> -The hostname the agent node should report, or that the master -should advertise in ZooKeeper. -If left unset, the hostname is resolved from the IP address -that the master/agent binds to; unless the user explicitly prevents -that, using <code>--no-hostname_lookup</code>, in which case the IP itself -is used. - </td> -</tr> -<tr> - <td> - --[no-]hostname_lookup - </td> - <td> -Whether we should execute a lookup to find out the server's hostname, -if not explicitly set (via, e.g., <code>--hostname</code>). -True by default; if set to <code>false</code> it will cause Mesos -to use the IP address, unless the hostname is explicitly set. (default: true) - </td> -</tr> -<tr> - <td> - --http_authenticators=VALUE - </td> - <td> -HTTP authenticator implementation to use when handling requests to -authenticated endpoints. Use the default <code>basic</code>, or load an -alternate HTTP authenticator module using <code>--modules</code>. -(default: basic, or basic and JWT if executor authentication is enabled) - </td> -</tr> -<tr> - <td> - --ip=VALUE - </td> - <td> -IP address to listen on. This cannot be used in conjunction -with <code>--ip_discovery_command</code>. - </td> -</tr> -<tr> - <td> - --ip_discovery_command=VALUE - </td> - <td> -Optional IP discovery binary: if set, it is expected to emit -the IP address which the master/agent will try to bind to. -Cannot be used in conjunction with <code>--ip</code>. - </td> -</tr> -<tr> - <td> - --ip6=VALUE - </td> - <td> -IPv6 address to listen on. This cannot be used in conjunction -with <code>--ip6_discovery_command</code>. -<p/> -NOTE: Currently Mesos doesn't listen on IPv6 sockets and hence -this IPv6 address is only used to advertise IPv6 addresses for -containers running on the host network. - </td> -</tr> -<tr> - <td> - --ip6_discovery_command=VALUE - </td> - <td> -Optional IPv6 discovery binary: if set, it is expected to emit -the IPv6 address on which Mesos will try to bind when IPv6 socket -support is enabled in Mesos. -<p/> -NOTE: Currently Mesos doesn't listen on IPv6 sockets and hence -this IPv6 address is only used to advertise IPv6 addresses for -containers running on the host network. - </td> -</tr> -<tr> - <td> - --modules=VALUE - </td> - <td> -List of modules to be loaded and be available to the internal -subsystems. -<p/> -Use <code>--modules=filepath</code> to specify the list of modules via a -file containing a JSON-formatted string. <code>filepath</code> can be -of the form <code>file:///path/to/file</code> or <code>/path/to/file</code>. -<p/> -Use <code>--modules="{...}"</code> to specify the list of modules inline. -<p/> -Example: -<pre><code>{ - "libraries": [ - { - "file": "/path/to/libfoo.so", - "modules": [ - { - "name": "org_apache_mesos_bar", - "parameters": [ - { - "key": "X", - "value": "Y" - } - ] - }, - { - "name": "org_apache_mesos_baz" - } - ] - }, - { - "name": "qux", - "modules": [ - { - "name": "org_apache_mesos_norf" - } - ] - } - ] -}</code></pre> -<p/> Cannot be used in conjunction with --modules_dir. - </td> -</tr> -<tr> - <td> - --modules_dir=VALUE - </td> - <td> -Directory path of the module manifest files. The manifest files are processed in -alphabetical order. (See <code>--modules</code> for more information on module -manifest files). Cannot be used in conjunction with <code>--modules</code>. - </td> -</tr> -<tr> - <td> - --port=VALUE - </td> - <td> -Port to listen on. (master default: 5050; agent default: 5051) - </td> -</tr> -<tr> - <td> - --[no-]version - </td> - <td> -Show version and exit. (default: false) - </td> -</tr> -<tr> - <td> - --zk_session_timeout=VALUE - </td> - <td> -ZooKeeper session timeout. (default: 10secs) - </td> -</tr> -</table> - -*These logging options can also be supplied to both masters and agents.* -For more about logging, see the [logging documentation](logging.md). +*These are options common to both the Mesos master and agent.* -<table class="table table-striped"> - <thead> - <tr> - <th width="30%"> - Flag - </th> - <th> - Explanation - </th> - </tr> - </thead> -<tr> - <td> - --[no-]quiet - </td> - <td> -Disable logging to stderr. (default: false) - </td> -</tr> -<tr> - <td> - --log_dir=VALUE - </td> - <td> -Location to put log files. By default, nothing is written to disk. -Does not affect logging to stderr. -If specified, the log file will appear in the Mesos WebUI. -<b>NOTE</b>: 3rd party log messages (e.g. ZooKeeper) are -only written to stderr! - </td> -</tr> -<tr> - <td> - --logbufsecs=VALUE - </td> - <td> -Maximum number of seconds that logs may be buffered for. -By default, logs are flushed immediately. (default: 0) - </td> -</tr> -<tr> - <td> - --logging_level=VALUE - </td> - <td> -Log message at or above this level. -Possible values: <code>INFO</code>, <code>WARNING</code>, <code>ERROR</code>. -If <code>--quiet</code> is specified, this will only affect the logs -written to <code>--log_dir</code>, if specified. (default: INFO) - </td> -</tr> -<tr> - <td> - --[no-]initialize_driver_logging - </td> - <td> -Whether the master/agent should initialize Google logging for the -scheduler and executor drivers, in the same way as described here. -The scheduler/executor drivers have separate logs and do not get -written to the master/agent logs. -<p/> -This option has no effect when using the HTTP scheduler/executor APIs. -(default: true) - </td> -</tr> -<tr> - <td> - --external_log_file=VALUE - </td> - <td> -Location of the externally managed log file. Mesos does not write to -this file directly and merely exposes it in the WebUI and HTTP API. -This is only useful when logging to stderr in combination with an -external logging mechanism, like syslog or journald. -<p/> -This option is meaningless when specified along with <code>--quiet</code>. -<p/> -This option takes precedence over <code>--log_dir</code> in the WebUI. -However, logs will still be written to the <code>--log_dir</code> if -that option is specified. - </td> -</tr> -</table> +See [configuration/master-and-agent.md](configuration/master-and-agent.md). ## Master Options -*Required Flags* - -<table class="table table-striped"> - <thead> - <tr> - <th width="30%"> - Flag - </th> - <th> - Explanation - </th> - </tr> - </thead> -<tr> - <td> - --quorum=VALUE - </td> - <td> -The size of the quorum of replicas when using <code>replicated_log</code> based -registry. It is imperative to set this value to be a majority of -masters i.e., <code>quorum > (number of masters)/2</code>. -<b>NOTE</b>: Not required if master is run in standalone mode (non-HA). - </td> -</tr> -<tr> - <td> - --work_dir=VALUE - </td> - <td> -Path of the master work directory. This is where the persistent -information of the cluster will be stored. Note that locations like -<code>/tmp</code> which are cleaned automatically are not suitable for the work -directory when running in production, since long-running masters could -lose data when cleanup occurs. (Example: <code>/var/lib/mesos/master</code>) - </td> -</tr> -<tr> - <td> - --zk=VALUE - </td> - <td> -ZooKeeper URL (used for leader election amongst masters). -May be one of: -<pre><code>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)</code></pre> -<b>NOTE</b>: Not required if master is run in standalone mode (non-HA). - </td> -</tr> -</table> - -*Optional Flags* - -<table class="table table-striped"> - <thead> - <tr> - <th width="30%"> - Flag - </th> - <th> - Explanation - </th> - </tr> - </thead> -<tr> - <td> - --acls=VALUE - </td> - <td> -The value could be a JSON-formatted string of ACLs -or a file path containing the JSON-formatted ACLs used -for authorization. Path could be of the form <code>file:///path/to/file</code> -or <code>/path/to/file</code>. -<p/> -Note that if the flag <code>--authorizers</code> is provided with a value -different than <code>local</code>, the ACLs contents will be -ignored. -<p/> -See the ACLs protobuf in acls.proto for the expected format. -<p/> -Example: -<pre><code>{ - "register_frameworks": [ - { - "principals": { "type": "ANY" }, - "roles": { "values": ["a"] } - } - ], - "run_tasks": [ - { - "principals": { "values": ["a", "b"] }, - "users": { "values": ["c"] } - } - ], - "teardown_frameworks": [ - { - "principals": { "values": ["a", "b"] }, - "framework_principals": { "values": ["c"] } - } - ], - "set_quotas": [ - { - "principals": { "values": ["a"] }, - "roles": { "values": ["a", "b"] } - } - ], - "remove_quotas": [ - { - "principals": { "values": ["a"] }, - "quota_principals": { "values": ["a"] } - } - ], - "get_endpoints": [ - { - "principals": { "values": ["a"] }, - "paths": { "values": ["/flags"] } - } - ] -}</code></pre> - </td> -</tr> -<tr> - <td> - --agent_ping_timeout=VALUE, - <p/> - --slave_ping_timeout=VALUE - </td> - <td> -The timeout within which an agent is expected to respond to a -ping from the master. Agents that do not respond within -max_agent_ping_timeouts ping retries will be asked to shutdown. -<b>NOTE</b>: The total ping timeout (<code>agent_ping_timeout</code> multiplied by -<code>max_agent_ping_timeouts</code>) should be greater than the ZooKeeper -session timeout to prevent useless re-registration attempts. -(default: 15secs) - </td> -</tr> -<tr> - <td> - --agent_removal_rate_limit=VALUE - <p/> - --slave_removal_rate_limit=VALUE - </td> - <td> -The maximum rate (e.g., <code>1/10mins</code>, <code>2/3hrs</code>, etc) at which agents -will be removed from the master when they fail health checks. -By default, agents will be removed as soon as they fail the health -checks. The value is of the form <code>(Number of agents)/(Duration)</code>. - </td> -</tr> -<tr> - <td> - --agent_reregister_timeout=VALUE - <p/> - --slave_reregister_timeout=VALUE - </td> - <td> -The timeout within which an agent is expected to re-register. -Agents re-register when they become disconnected from the master -or when a new master is elected as the leader. Agents that do not -re-register within the timeout will be marked unreachable in the -registry; if/when the agent re-registers with the master, any -non-partition-aware tasks running on the agent will be terminated. -<b>NOTE</b>: This value has to be at least 10mins. (default: 10mins) - </td> -</tr> -<tr> - <td> - --allocation_interval=VALUE - </td> - <td> -Amount of time to wait between performing -(batch) allocations (e.g., 500ms, 1sec, etc). (default: 1secs) - </td> -</tr> -<tr> - <td> - --allocator=VALUE - </td> - <td> -Allocator to use for resource allocation to frameworks. -Use the default <code>HierarchicalDRF</code> allocator, or -load an alternate allocator module using <code>--modules</code>. -(default: HierarchicalDRF) - </td> -</tr> -<tr> - <td> - --[no-]authenticate_agents, - <p/> - --[no-]authenticate_slaves - </td> - <td> -If <code>true</code> only authenticated agents are allowed to register. -If <code>false</code> unauthenticated agents are also allowed to register. (default: false) - </td> -</tr> -<tr> - <td> - --[no-]authenticate_frameworks, - <p/> - --[no-]authenticate - </td> - <td> -If <code>true</code>, only authenticated frameworks are allowed to register. If -<code>false</code>, unauthenticated frameworks are also allowed to register. For -HTTP based frameworks use the <code>--authenticate_http_frameworks</code> flag. (default: false) - </td> -</tr> -<tr> - <td> - --[no-]authenticate_http_frameworks - </td> - <td> -If <code>true</code>, only authenticated HTTP based frameworks are allowed to -register. If <code>false</code>, HTTP frameworks are not authenticated. (default: false) - </td> -</tr> -<tr> - <td> - --authenticators=VALUE - </td> - <td> -Authenticator implementation to use when authenticating frameworks -and/or agents. Use the default <code>crammd5</code>, or -load an alternate authenticator module using <code>--modules</code>. (default: crammd5) - </td> -</tr> -<tr> - <td> - --authorizers=VALUE - </td> - <td> -Authorizer implementation to use when authorizing actions that -require it. -Use the default <code>local</code>, or -load an alternate authorizer module using <code>--modules</code>. -<p/> -Note that if the flag <code>--authorizers</code> is provided with a value -different than the default <code>local</code>, the ACLs -passed through the <code>--acls</code> flag will be ignored. -<p/> -Currently there is no support for multiple authorizers. (default: local) - </td> -</tr> -<tr> - <td> - --cluster=VALUE - </td> - <td> -Human readable name for the cluster, displayed in the webui. - </td> -</tr> -<tr> - <td> - --credentials=VALUE - </td> - <td> -Path to a JSON-formatted file containing credentials. -Path can be of the form <code>file:///path/to/file</code> or <code>/path/to/file</code>. -Example: -<pre><code>{ - "credentials": [ - { - "principal": "sherman", - "secret": "kitesurf" - } - ] -}</code></pre> - </td> -</tr> -<tr> - <td> - --fair_sharing_excluded_resource_names=VALUE - </td> - <td> -A comma-separated list of the resource names (e.g. 'gpus') that will be excluded -from fair sharing constraints. This may be useful in cases where the fair -sharing implementation currently has limitations. E.g. See the problem of -"scarce" resources: - <a href="http://www.mail-archive.com/dev@mesos.apache.org/msg35631.html";>msg35631</a> - <a href="https://issues.apache.org/jira/browse/MESOS-5377";>MESOS-5377</a> - </td> -</tr> -<tr> - <td> - --[no_]filter_gpu_resources - </td> - <td> -When set to true, this flag will cause the mesos master to filter all offers -from agents with GPU resources by only sending them to frameworks that opt into -the 'GPU_RESOURCES' framework capability. When set to false, this flag will -cause the master to not filter offers from agents with GPU resources, and -indiscriminately send them to all frameworks whether they set the -'GPU_RESOURCES' capability or not. This flag is meant as a temporary workaround -towards the eventual deprecation of the 'GPU_RESOURCES' capability. Please see -the following for more information: - <a href="https://www.mail-archive.com/dev@mesos.apache.org/msg37571.html";>msg37571</a> - <a href="https://issues.apache.org/jira/browse/MESOS-7576";>MESOS-7576</a> - </td> -</tr> -<tr> - <td> - --framework_sorter=VALUE - </td> - <td> -Policy to use for allocating resources between a given user's -frameworks. Options are the same as for <code>--user_sorter</code>. -(default: drf) - </td> -</tr> -<tr> - <td> - --http_framework_authenticators=VALUE - </td> - <td> -HTTP authenticator implementation to use when authenticating HTTP frameworks. -Use the <code>basic</code> authenticator or load an alternate HTTP authenticator -module using <code>--modules</code>. This must be used in conjunction with -<code>--authenticate_http_frameworks</code>. -<p/> -Currently there is no support for multiple HTTP authenticators. - </td> -</tr> -<tr> - <td> - --[no-]log_auto_initialize - </td> - <td> -Whether to automatically initialize the [replicated log](replicated-log-internals.md) -used for the registry. If this is set to false, the log has to be manually -initialized when used for the very first time. (default: true) - </td> -</tr> -<tr> - <td> - --master_contender=VALUE - </td> - <td> -The symbol name of the master contender to use. This symbol should exist in a -module specified through the <code>--modules</code> flag. Cannot be used in -conjunction with <code>--zk</code>. Must be used in conjunction with -<code>--master_detector</code>. - </td> -</tr> -<tr> - <td> - --master_detector=VALUE - </td> - <td> -The symbol name of the master detector to use. This symbol should exist in a -module specified through the <code>--modules</code> flag. Cannot be used in -conjunction with <code>--zk</code>. Must be used in conjunction with -<code>--master_contender</code>. - </td> -</tr> -<tr> - <td> - --max_agent_ping_timeouts=VALUE, - <p/> - --max_slave_ping_timeouts=VALUE - </td> - <td> -The number of times an agent can fail to respond to a -ping from the master. Agents that do not respond within -<code>max_agent_ping_timeouts</code> ping retries will be asked to shutdown. -(default: 5) - </td> -</tr> -<tr> - <td> - --max_completed_frameworks=VALUE - </td> - <td> -Maximum number of completed frameworks to store in memory. (default: 50) - </td> -</tr> -<tr> - <td> - --max_completed_tasks_per_framework=VALUE - </td> - <td> -Maximum number of completed tasks per framework to store in memory. (default: 1000) - </td> -</tr> -<tr> - <td> - --max_unreachable_tasks_per_framework=VALUE - </td> - <td> -Maximum number of unreachable tasks per framework to store in memory. (default: 1000) - </td> -</tr> -<tr> - <td> - --offer_timeout=VALUE - </td> - <td> -Duration of time before an offer is rescinded from a framework. -This helps fairness when running frameworks that hold on to offers, -or frameworks that accidentally drop offers. -If not set, offers do not timeout. - </td> -</tr> -<tr> - <td> - --rate_limits=VALUE - </td> - <td> -The value could be a JSON-formatted string of rate limits -or a file path containing the JSON-formatted rate limits used -for framework rate limiting. -Path could be of the form <code>file:///path/to/file</code> -or <code>/path/to/file</code>. -<p/> -See the RateLimits protobuf in mesos.proto for the expected format. -<p/> -Example: -<pre><code>{ - "limits": [ - { - "principal": "foo", - "qps": 55.5 - }, - { - "principal": "bar" - } - ], - "aggregate_default_qps": 33.3 -}</code></pre> - </td> -</tr> -<tr> - <td> - --recovery_agent_removal_limit=VALUE, - <p/> - --recovery_slave_removal_limit=VALUE - </td> - <td> -For failovers, limit on the percentage of agents that can be removed -from the registry *and* shutdown after the re-registration timeout -elapses. If the limit is exceeded, the master will fail over rather -than remove the agents. -This can be used to provide safety guarantees for production -environments. Production environments may expect that across master -failovers, at most a certain percentage of agents will fail -permanently (e.g. due to rack-level failures). -Setting this limit would ensure that a human needs to get -involved should an unexpected widespread failure of agents occur -in the cluster. -Values: [0%-100%] (default: 100%) - </td> -</tr> -<tr> - <td> - --registry=VALUE - </td> - <td> -Persistence strategy for the registry; available options are -<code>replicated_log</code>, <code>in_memory</code> (for testing). (default: replicated_log) - </td> -</tr> -<tr> - <td> - --registry_fetch_timeout=VALUE - </td> - <td> -Duration of time to wait in order to fetch data from the registry -after which the operation is considered a failure. (default: 1mins) - </td> -</tr> -<tr> - <td> - --registry_store_timeout=VALUE - </td> - <td> -Duration of time to wait in order to store data in the registry -after which the operation is considered a failure. (default: 20secs) - </td> -</tr> -<tr> - <td> - --roles=VALUE - </td> - <td> -A comma-separated list of the allocation roles that frameworks -in this cluster may belong to. This flag is deprecated; -if it is not specified, any role name can be used. - </td> -</tr> -<tr> - <td> - --[no-]root_submissions - </td> - <td> -Can root submit frameworks? (default: true) - </td> -</tr> -<tr> - <td> - --user_sorter=VALUE - </td> - <td> -Policy to use for allocating resources between users. May be one of: - dominant_resource_fairness (drf) (default: drf) - </td> -</tr> -<tr> - <td> - --webui_dir=VALUE - </td> - <td> -Directory path of the webui files/assets (default: /usr/local/share/mesos/webui) - </td> -</tr> -<tr> - <td> - --weights=VALUE - </td> - <td> -A comma-separated list of role/weight pairs of the form -<code>role=weight,role=weight</code>. Weights can be used to control the -relative share of cluster resources that is offered to different roles. This -flag is deprecated. Instead, operators should configure weights dynamically -using the <code>/weights</code> HTTP endpoint. - </td> -</tr> -<tr> - <td> - --whitelist=VALUE - </td> - <td> -Path to a file which contains a list of agents (one per line) to -advertise offers for. The file is watched and periodically re-read to -refresh the agent whitelist. By default there is no whitelist: all -machines are accepted. Path can be of the form -<code>file:///path/to/file</code> or <code>/path/to/file</code>. - </td> -</tr> -</table> - -*Flags available when configured with `--with-network-isolator`* - -<table class="table table-striped"> - <thead> - <tr> - <th width="30%"> - Flag - </th> - <th> - Explanation - </th> - </tr> - </thead> -<tr> - <td> - --max_executors_per_agent=VALUE, - <p/> - --max_executors_per_slave=VALUE - </td> - <td> -Maximum number of executors allowed per agent. The network -monitoring/isolation technique imposes an implicit resource -acquisition on each executor (# ephemeral ports), as a result -one can only run a certain number of executors on each agent. - </td> -</tr> -</table> +See [configuration/master.md](configuration/master.md). ## Agent Options -*Required Flags* - -<table class="table table-striped"> - <thead> - <tr> - <th width="30%"> - Flag - </th> - <th> - Explanation - </th> - </tr> - </thead> -<tr> - <td> - --master=VALUE - </td> - <td> -May be one of: - <code>host:port</code> - <code>zk://host1:port1,host2:port2,.../path</code> - <code>zk://username:password@host1:port1,host2:port2,.../path</code> - <code>file:///path/to/file</code> (where file contains one of the above) - </td> -</tr> -<tr> - <td> - --work_dir=VALUE - </td> - <td> -Path of the agent work directory. This is where executor sandboxes -will be placed, as well as the agent's checkpointed state in case of -failover. Note that locations like <code>/tmp</code> which are cleaned -automatically are not suitable for the work directory when running in -production, since long-running agents could lose data when cleanup -occurs. (Example: <code>/var/lib/mesos/agent</code>) - </td> -</tr> -</table> - -*Optional Flags* - -<table class="table table-striped"> - <thead> - <tr> - <th width="30%"> - Flag - </th> - <th> - Explanation - </th> - </tr> - </thead> -<tr> - <td> - --acls=VALUE - </td> - <td> -The value could be a JSON-formatted string of ACLs -or a file path containing the JSON-formatted ACLs used -for authorization. Path could be of the form <code>file:///path/to/file</code> -or <code>/path/to/file</code>. -<p/> -Note that if the <code>--authorizer</code> flag is provided with a value -other than <code>local</code>, the ACLs contents will be -ignored. -<p/> -See the ACLs protobuf in acls.proto for the expected format. -<p/> -Example: -<pre><code>{ - "get_endpoints": [ - { - "principals": { "values": ["a"] }, - "paths": { "values": ["/flags", "/monitor/statistics"] } - } - ] -}</code></pre> - </td> -</tr> -<tr> - <td> - --agent_subsystems=VALUE, - <p/> - --slave_subsystems=VALUE - </td> - <td> -List of comma-separated cgroup subsystems to run the agent binary -in, e.g., <code>memory,cpuacct</code>. The default is none. -Present functionality is intended for resource monitoring and -no cgroup limits are set, they are inherited from the root mesos -cgroup. - </td> - -</tr> -<tr> - <td> - --effective_capabilities=VALUE - </td> - <td> -JSON representation of the Linux capabilities that the agent will -grant to a task that will be run in containers launched by the -containerizer (currently only supported by the Mesos Containerizer). -This set overrides the default capabilities for the user but not -the capabilities requested by the framework. -<p/> -To set capabilities the agent should have the <code>SETPCAP</code> capability. -<p/> -This flag is effective iff <code>linux/capabilities</code> isolation is enabled. -When <code>linux/capabilities</code> isolation is enabled, the absence of this flag -implies that the operator intends to allow ALL capabilities. -<p/> -Example: -<pre><code> -{ - "capabilities": [ - "NET_RAW", - "SYS_ADMIN" - ] -} -</code></pre> - </td> -</tr> - -</tr> -<tr> - <td> - --bounding_capabilities=VALUE - </td> - <td> -JSON representation of the Linux capabilities that the operator -will allow as the maximum level of privilege that a task launched -by the containerizer may acquire (currently only supported by the -Mesos Containerizer). -<p/> -This flag is effective iff <code>linux/capabilities</code> isolation is enabled. -When <code>linux/capabilities</code> isolation is enabled, the absence of this flag -implies that the operator intends to allow ALL capabilities. -<p/> -This flag has the same syntax as <code>--effective_capabilities</code>. - </td> -</tr> - -<tr> - <td> - --appc_simple_discovery_uri_prefix=VALUE - </td> - <td> -URI prefix to be used for simple discovery of appc images, -e.g., <code>http://</code>, <code>https://</code>, -<code>hdfs://<hostname>:9000/user/abc/cde</code>. -(default: http://) - </td> -</tr> -<tr> - <td> - --appc_store_dir=VALUE - </td> - <td> -Directory the appc provisioner will store images in. -(default: /tmp/mesos/store/appc) - </td> -</tr> -<tr> - <td> - --attributes=VALUE - </td> - <td> -Attributes of the agent machine, in the form: -<code>rack:2</code> or <code>rack:2;u:1</code> - </td> -</tr> -<tr> - <td> - --[no-]authenticate_http_executors - </td> - <td> -If <code>true</code>, only authenticated requests for the HTTP executor API are -allowed. If <code>false</code>, unauthenticated requests are also allowed. This -flag is only available when Mesos is built with SSL support. -(default: false) - </td> -</tr> -<tr> - <td> - --authenticatee=VALUE - </td> - <td> -Authenticatee implementation to use when authenticating against the -master. Use the default <code>crammd5</code>, or -load an alternate authenticatee module using <code>--modules</code>. (default: crammd5) - </td> -</tr> -<tr> - <td> - --authentication_backoff_factor=VALUE - </td> - <td> -After a failed authentication the agent picks a random amount of time between -<code>[0, b]</code>, where <code>b = authentication_backoff_factor</code>, to -authenticate with a new master. Subsequent retries are exponentially backed -off based on this interval (e.g., 1st retry uses a random value between -<code>[0, b * 2^1]</code>, 2nd retry between <code>[0, b * 2^2]</code>, 3rd -retry between <code>[0, b * 2^3]</code>, etc up to a maximum of 1mins -(default: 1secs) - </td> -</tr> -<tr> - <td> - --authorizer=VALUE - </td> - <td> -Authorizer implementation to use when authorizing actions that -require it. -Use the default <code>local</code>, or -load an alternate authorizer module using <code>--modules</code>. -<p/> -Note that if the <code>--authorizer</code> flag is provided with a value -other than the default <code>local</code>, the ACLs -passed through the <code>--acls</code> flag will be ignored. - </td> -</tr> -<tr> - <td> - --[no]-cgroups_cpu_enable_pids_and_tids_count - </td> - <td> -Cgroups feature flag to enable counting of processes and threads -inside a container. (default: false) - </td> -</tr> -<tr> - <td> - --[no]-cgroups_enable_cfs - </td> - <td> -Cgroups feature flag to enable hard limits on CPU resources -via the CFS bandwidth limiting subfeature. (default: false) - </td> -</tr> -<tr> - <td> - --cgroups_hierarchy=VALUE - </td> - <td> -The path to the cgroups hierarchy root. (default: /sys/fs/cgroup) - </td> -</tr> -<tr> - <td> - --[no]-cgroups_limit_swap - </td> - <td> -Cgroups feature flag to enable memory limits on both memory and -swap instead of just memory. (default: false) - </td> -</tr> -<tr> - <td> - --cgroups_net_cls_primary_handle - </td> - <td> -A non-zero, 16-bit handle of the form `0xAAAA`. This will be used as -the primary handle for the net_cls cgroup. - </td> -</tr> -<tr> - <td> - --cgroups_net_cls_secondary_handles - </td> - <td> -A range of the form 0xAAAA,0xBBBB, specifying the valid secondary -handles that can be used with the primary handle. This will take -effect only when the <code>--cgroups_net_cls_primary_handle</code> is set. - </td> -</tr> -<tr> - <td> - --allowed_devices - </td> - <td> -JSON object representing the devices that will be additionally -whitelisted by cgroups devices subsystem. Noted that the following -devices always be whitelisted by default: -<pre><code> * /dev/console - * /dev/tty0 - * /dev/tty1 - * /dev/pts/* - * /dev/ptmx - * /dev/net/tun - * /dev/null - * /dev/zero - * /dev/full - * /dev/tty - * /dev/urandom - * /dev/random -</code></pre> -This flag will take effect only when <code>cgroups/devices</code> is set in -<code>--isolation</code> flag. -<p/> -Example: -<pre><code>{ - "allowed_devices": [ - { - "device": { - "path": "/path/to/device" - }, - "access": { - "read": true, - "write": false, - "mknod": false - } - } - ] -} -</code></pre> - </td> -</tr> -<tr> - <td> - --cgroups_root=VALUE - </td> - <td> -Name of the root cgroup. (default: mesos) - </td> -</tr> -<tr> - <td> - --container_disk_watch_interval=VALUE - </td> - <td> -The interval between disk quota checks for containers. This flag is -used for the <code>disk/du</code> isolator. (default: 15secs) - </td> -</tr> -<tr> - <td> - --container_logger=VALUE - </td> - <td> -The name of the container logger to use for logging container -(i.e., executor and task) stdout and stderr. The default -container logger writes to <code>stdout</code> and <code>stderr</code> files -in the sandbox directory. - </td> -</tr> -<tr> - <td> - --containerizers=VALUE - </td> - <td> -Comma-separated list of containerizer implementations -to compose in order to provide containerization. -Available options are <code>mesos</code> and -<code>docker</code> (on Linux). The order the containerizers -are specified is the order they are tried. -(default: mesos) - </td> -</tr> -<tr> - <td> - --credential=VALUE - </td> - <td> -Path to a JSON-formatted file containing the credential -to use to authenticate with the master. -Path could be of the form <code>file:///path/to/file</code> or <code>/path/to/file</code>. -Example: -<pre><code>{ - "principal": "username", - "secret": "secret" -}</code></pre> - </td> -</tr> -<tr> - <td> - --default_container_dns=VALUE - </td> - <td> -JSON-formatted DNS information for CNI networks (Mesos containerizer) -and CNM networks (Docker containerizer). For CNI networks, this flag -can be used to configure `nameservers`, `domain`, `search` and -`options`, and its priority is lower than the DNS information returned -by a CNI plugin, but higher than the DNS information in agent host's -/etc/resolv.conf. For CNM networks, this flag can be used to configure -`nameservers`, `search` and `options`, it will only be used if there -is no DNS information provided in the ContainerInfo.docker.parameters -message. -<p/> -See the ContainerDNS message in `flags.proto` for the expected format. -<p/> -Example: -<pre><code>{ - "mesos": [ - { - "network_mode": "CNI", - "network_name": "net1", - "dns": { - "nameservers": [ "8.8.8.8", "8.8.4.4" ] - } - } - ], - "docker": [ - { - "network_mode": "BRIDGE", - "dns": { - "nameservers": [ "8.8.8.8", "8.8.4.4" ] - } - }, - { - "network_mode": "USER", - "network_name": "net2", - "dns": { - "nameservers": [ "8.8.8.8", "8.8.4.4" ] - } - } - ] -}</code></pre> - </td> -</tr> -<tr> - <td> - --default_container_info=VALUE - </td> - <td> -JSON-formatted ContainerInfo that will be included into -any ExecutorInfo that does not specify a ContainerInfo. -<p/> -See the ContainerInfo protobuf in mesos.proto for -the expected format. -<p/> -Example: -<pre><code>{ - "type": "MESOS", - "volumes": [ - { - "host_path": ".private/tmp", - "container_path": "/tmp", - "mode": "RW" - } - ] -}</code></pre> - </td> -</tr> -<tr> - <td> - --default_role=VALUE - </td> - <td> -Any resources in the <code>--resources</code> flag that -omit a role, as well as any resources that -are not present in <code>--resources</code> but that are -automatically detected, will be assigned to -this role. (default: *) - </td> -</tr> -<tr> - <td> - --disk_watch_interval=VALUE - </td> - <td> -Periodic time interval (e.g., 10secs, 2mins, etc) -to check the overall disk usage managed by the agent. -This drives the garbage collection of archived -information and sandboxes. (default: 1mins) - </td> -</tr> -<tr> - <td> - --docker=VALUE - </td> - <td> -The absolute path to the docker executable for docker -containerizer. -(default: docker) - </td> -</tr> -<tr> - <td> - --docker_config=VALUE - </td> - <td> -The default docker config file for agent. Can be provided either as an -absolute path pointing to the agent local docker config file, or as a -JSON-formatted string. The format of the docker config file should be -identical to docker's default one (e.g., either -<code>$HOME/.docker/config.json</code> or <code>$HOME/.dockercfg</code>). -Example JSON (<code>$HOME/.docker/config.json</code>): -<pre><code>{ - "auths": { - "https://index.docker.io/v1/": { - "auth": "xXxXxXxXxXx=", - "email": "usern...@example.com" - } - } -} -</code></pre> - </td> -</tr> -<tr> - <td> - --[no-]docker_kill_orphans - </td> - <td> -Enable docker containerizer to kill orphaned containers. -You should consider setting this to false when you launch multiple -agents in the same OS, to avoid one of the DockerContainerizer -removing docker tasks launched by other agents. -(default: true) - </td> -</tr> -<tr> - <td> - --docker_mesos_image=VALUE - </td> - <td> -The Docker image used to launch this Mesos agent instance. -If an image is specified, the docker containerizer assumes the agent -is running in a docker container, and launches executors with -docker containers in order to recover them when the agent restarts and -recovers. - </td> -</tr> -<tr> - <td> - --docker_registry=VALUE - </td> - <td> -The default url for Mesos containerizer to pull Docker images. It could -either be a Docker registry server url (i.e: <code>https://registry.docker.io</code>), -or a local path (i.e: <code>/tmp/docker/images</code>) in which Docker -image archives (result of <code>docker save</code>) are stored. Note -that this option won't change the default registry server for Docker -containerizer. (default: https://registry-1.docker.io) - </td> -</tr> -<tr> - <td> - --docker_remove_delay=VALUE - </td> - <td> -The amount of time to wait before removing docker containers -(e.g., <code>3days</code>, <code>2weeks</code>, etc). -(default: 6hrs) - </td> -</tr> -<tr> - <td> - --docker_socket=VALUE - </td> - <td> -Resource used by the agent and the executor to provide CLI access to the -Docker daemon. On Unix, this is typically a path to a socket, such as -<code>/var/run/docker.sock</code>. On Windows this must be a named pipe, -such as <code>//./pipe/docker_engine</code>. <b>NOTE</b>: This must be the path -used by the Docker image used to run the agent. (default: -//./pipe/docker_engine on Windows; /var/run/docker.sock on other -platforms). - </td> -</tr> -<tr> - <td> - --docker_stop_timeout=VALUE - </td> - <td> -The time docker daemon waits after stopping a container before killing -that container. This flag is deprecated; use task's kill policy instead. -(default: 0ns) - </td> -</tr> -<tr> - <td> - --docker_store_dir=VALUE - </td> - <td> -Directory the Docker provisioner will store images in (default: /tmp/mesos/store/docker) - </td> -</tr> -<tr> - <td> - --docker_volume_checkpoint_dir=VALUE - </td> - <td> -The root directory where we checkpoint the information about docker -volumes that each container uses. -(default: /var/run/mesos/isolators/docker/volume) - </td> -</tr> -<tr> - <td> - --[no-]enforce_container_disk_quota - </td> - <td> -Whether to enable disk quota enforcement for containers. This flag -is used by the <code>disk/du</code> and <code>disk/xfs</code> isolators. (default: false) - </td> -</tr> -<tr> - <td> - --executor_environment_variables=VALUE - </td> - <td> -JSON object representing the environment variables that should be -passed to the executor, and thus subsequently task(s). By default this -flag is none. Users have to define executor environment explicitly. -Example: -<pre><code>{ - "PATH": "/bin:/usr/bin", - "LD_LIBRARY_PATH": "/usr/local/lib" -}</code></pre> - </td> -</tr> -<tr> - <td> - --executor_registration_timeout=VALUE - </td> - <td> -Amount of time to wait for an executor -to register with the agent before considering it hung and -shutting it down (e.g., 60secs, 3mins, etc) (default: 1mins) - </td> -</tr> -<tr> - <td> - --executor_reregistration_timeout=VALUE - </td> - <td> -The timeout within which an executor is expected to re-register after -the agent has restarted, before the agent considers it gone and shuts -it down. Note that currently, the agent will not re-register with the -master until this timeout has elapsed (see MESOS-7539). (default: 2secs) - </td> -</tr> -<tr> - <td> - --executor_reregistration_retry_interval=VALUE - </td> - <td> -For PID-based executors, how long the agent waits before retrying -the reconnect message sent to the executor during recovery. -NOTE: Do not use this unless you understand the following -(see MESOS-5332): PID-based executors using Mesos libraries >= 1.1.2 -always re-link with the agent upon receiving the reconnect message. -This avoids the executor replying on a half-open TCP connection to -the old agent (possible if netfilter is dropping packets, -see: MESOS-7057). However, PID-based executors using Mesos -libraries < 1.1.2 do not re-link and are therefore prone to -replying on a half-open connection after the agent restarts. If we -only send a single reconnect message, these "old" executors will -reply on their half-open connection and receive a RST; without any -retries, they will fail to reconnect and be killed by the agent once -the executor re-registration timeout elapses. To ensure these "old" -executors can reconnect in the presence of netfilter dropping -packets, we introduced optional retries of the reconnect message. -This results in "old" executors correctly establishing a link -when processing the second reconnect message. (default: no retries) - </td> -</tr> -<tr> - <td> - --max_completed_executors_per_framework=VALUE - </td> - <td> -Maximum number of completed executors per framework to store -in memory. (default: 150) - </td> -</tr> -<tr> - <td> - --executor_secret_key=VALUE - </td> - <td> -Path to a file containing the key used when generating executor -secrets. This flag is only available when Mesos is built with SSL -support. - </td> -</tr> -<tr> - <td> - --executor_shutdown_grace_period=VALUE - </td> - <td> -Default amount of time to wait for an executor to shut down -(e.g. 60secs, 3mins, etc). ExecutorInfo.shutdown_grace_period -overrides this default. Note that the executor must not assume -that it will always be allotted the full grace period, as the -agent may decide to allot a shorter period, and failures / forcible -terminations may occur. -(default: 5secs) - </td> -</tr> -<tr> - <td> - --fetcher_cache_dir=VALUE - </td> - <td> -Parent directory for fetcher cache directories -(one subdirectory per agent). (default: /tmp/mesos/fetch) - -Directory for the fetcher cache. The agent will clear this directory -on startup. It is recommended to set this value to a separate volume -for several reasons: -<ul> -<li> The cache directories are transient and not meant to be - backed up. Upon restarting the agent, the cache is always empty. </li> -<li> The cache and container sandboxes can potentially interfere with - each other when occupying a shared space (i.e. disk contention). </li> -</ul> - </td> -</tr> -<tr> - <td> - --fetcher_cache_size=VALUE - </td> - <td> -Size of the fetcher cache in Bytes. (default: 2GB) - </td> -</tr> -<tr> - <td> - --frameworks_home=VALUE - </td> - <td> -Directory path prepended to relative executor URIs (default: ) - </td> -</tr> -<tr> - <td> - --gc_delay=VALUE - </td> - <td> -Maximum amount of time to wait before cleaning up -executor directories (e.g., 3days, 2weeks, etc). -Note that this delay may be shorter depending on -the available disk usage. (default: 1weeks) - </td> -</tr> -<tr> - <td> - <a name="gc_disk_headroom"></a> - --gc_disk_headroom=VALUE - </td> - <td> -Adjust disk headroom used to calculate maximum executor -directory age. Age is calculated by: -<code>gc_delay * max(0.0, (1.0 - gc_disk_headroom - disk usage))</code> -every <code>--disk_watch_interval</code> duration. <code>gc_disk_headroom</code> must -be a value between 0.0 and 1.0 (default: 0.1) - </td> -</tr> -<tr> - <td> - --hadoop_home=VALUE - </td> - <td> -Path to find Hadoop installed (for -fetching framework executors from HDFS) -(no default, look for <code>HADOOP_HOME</code> in -environment or find hadoop on <code>PATH</code>) (default: ) - </td> -</tr> -<tr> - <td> - --http_credentials=VALUE - </td> - <td> -Path to a JSON-formatted file containing credentials. These -credentials are used to authenticate HTTP endpoints on the agent. -Path can be of the form <code>file:///path/to/file</code> or <code>/path/to/file</code>. -<p/> -Example: -<pre><code>{ - "credentials": [ - { - "principal": "yoda", - "secret": "usetheforce" - } - ] -} -</code></pre> - </td> -</tr> -<tr> - <td> - --[no-]http_command_executor - </td> - <td> -The underlying executor library to be used for the command executor. -If set to <code>true</code>, the command executor would use the HTTP based -executor library to interact with the Mesos agent. If set to <code>false</code>, -the driver based implementation would be used. -<b>NOTE</b>: This flag is *experimental* and should not be used in -production yet. (default: false) - </td> -</tr> -<tr> - <td> - --http_heartbeat_interval=VALUE - </td> - <td> -This flag sets a heartbeat interval (e.g. '5secs', '10mins') for -messages to be sent over persistent connections made against -the agent HTTP API. Currently, this only applies to the -<code>LAUNCH_NESTED_CONTAINER_SESSION</code> and <code>ATTACH_CONTAINER_OUTPUT</code> calls. -(default: 30secs) - </td> -</tr> -<tr> - <td> - --image_providers=VALUE - </td> - <td> -Comma-separated list of supported image providers, -e.g., <code>APPC,DOCKER</code>. - </td> -</tr> -<tr> - <td> - --image_provisioner_backend=VALUE - </td> - <td> -Strategy for provisioning container rootfs from images, e.g., <code>aufs</code>, -<code>bind</code>, <code>copy</code>, <code>overlay</code>. - </td> -</tr> -<tr> - <td> - --isolation=VALUE - </td> - <td> -Isolation mechanisms to use, e.g., <code>posix/cpu,posix/mem</code>, or -<code>cgroups/cpu,cgroups/mem</code>, or <code>network/port_mapping</code> -(configure with flag: <code>--with-network-isolator</code> to enable), -or <code>gpu/nvidia</code> for nvidia specific gpu isolation, or load an alternate -isolator module using the <code>--modules</code> flag. Note that this -flag is only relevant for the Mesos Containerizer. -(default: posix/cpu,posix/mem) - </td> -</tr> -<tr> - <td> - --launcher=VALUE - </td> - <td> -The launcher to be used for Mesos containerizer. It could either be -<code>linux</code> or <code>posix</code>. The Linux launcher is required for cgroups -isolation and for any isolators that require Linux namespaces such as -network, pid, etc. If unspecified, the agent will choose the Linux -launcher if it's running as root on Linux. - </td> -</tr> -<tr> - <td> - --launcher_dir=VALUE - </td> - <td> -Directory path of Mesos binaries. Mesos looks for the health-check, -fetcher, containerizer, and executor binary files under this -directory. (default: /usr/local/libexec/mesos) - </td> -</tr> -<tr> - <td> - --master_detector=VALUE - </td> - <td> -The symbol name of the master detector to use. This symbol should exist in a -module specified through the <code>--modules</code> flag. Cannot be used in -conjunction with <code>--master</code>. - </td> -</tr> -<tr> - <td> - --nvidia_gpu_devices=VALUE - </td> - <td> -A comma-separated list of Nvidia GPU devices. When <code>gpus</code> is specified -in the <code>--resources</code> flag, this flag determines which GPU devices will -be made available. The devices should be listed as numbers that -correspond to Nvidia's NVML device enumeration (as seen by running the -command <code>nvidia-smi</code> on an Nvidia GPU equipped system). The GPUs -listed will only be isolated if the <code>--isolation</code> flag contains the -string <code>gpu/nvidia</code>. - </td> -</tr> -<tr> - <td> - --network_cni_plugins_dir=VALUE - </td> - <td> -Directory path of the CNI plugin binaries. The <code>network/cni</code> -isolator will find CNI plugins under this directory so that it can execute -the plugins to add/delete container from the CNI networks. It is the operator's -responsibility to install the CNI plugin binaries in the specified directory. - </td> -</tr> -<tr> - <td> - --network_cni_config_dir=VALUE - </td> - <td> -Directory path of the CNI network configuration files. For each network that -containers launched in Mesos agent can connect to, the operator should install -a network configuration file in JSON format in the specified directory. - </td> -</tr> -<tr> - <td> - --oversubscribed_resources_interval=VALUE - </td> - <td> -The agent periodically updates the master with the current estimation -about the total amount of oversubscribed resources that are allocated -and available. The interval between updates is controlled by this flag. -(default: 15secs) - </td> -</tr> -<tr> - <td> - --perf_duration=VALUE - </td> - <td> -Duration of a perf stat sample. The duration must be less -than the <code>perf_interval</code>. (default: 10secs) - </td> -</tr> -<tr> - <td> - --perf_events=VALUE - </td> - <td> -List of command-separated perf events to sample for each container -when using the perf_event isolator. Default is none. -Run command <code>perf list</code> to see all events. Event names are -sanitized by downcasing and replacing hyphens with underscores -when reported in the PerfStatistics protobuf, e.g., <code>cpu-cycles</code> -becomes <code>cpu_cycles</code>; see the PerfStatistics protobuf for all names. - </td> -</tr> -<tr> - <td> - --perf_interval=VALUE - </td> - <td> -Interval between the start of perf stat samples. Perf samples are -obtained periodically according to <code>perf_interval</code> and the most -recently obtained sample is returned rather than sampling on -demand. For this reason, <code>perf_interval</code> is independent of the -resource monitoring interval. (default: 60secs) - </td> -</tr> -<tr> - <td> - --qos_controller=VALUE - </td> - <td> -The name of the QoS Controller to use for oversubscription. - </td> -</tr> -<tr> - <td> - --qos_correction_interval_min=VALUE - </td> - <td> -The agent polls and carries out QoS corrections from the QoS -Controller based on its observed performance of running tasks. -The smallest interval between these corrections is controlled by -this flag. (default: 0secs) - </td> -</tr> -<tr> - <td> - --recover=VALUE - </td> - <td> -Whether to recover status updates and reconnect with old executors. -Valid values for <code>recover</code> are -reconnect: Reconnect with any old live executors. -cleanup : Kill any old live executors and exit. - Use this option when doing an incompatible agent - or executor upgrade!). (default: reconnect) - </td> -</tr> -<tr> - <td> - --recovery_timeout=VALUE - </td> - <td> -Amount of time allotted for the agent to recover. If the agent takes -longer than recovery_timeout to recover, any executors that are -waiting to reconnect to the agent will self-terminate. -(default: 15mins) - </td> -</tr> -<tr> - <td> - --registration_backoff_factor=VALUE - </td> - <td> -Agent initially picks a random amount of time between <code>[0, b]</code>, where -<code>b = registration_backoff_factor</code>, to (re-)register with a new master. -Subsequent retries are exponentially backed off based on this -interval (e.g., 1st retry uses a random value between <code>[0, b * 2^1]</code>, -2nd retry between <code>[0, b * 2^2]</code>, 3rd retry between <code>[0, b * 2^3]</code>, -etc) up to a maximum of 1mins (default: 1secs) - </td> -</tr> -<tr> - <td> - --resource_estimator=VALUE - </td> - <td> -The name of the resource estimator to use for oversubscription. - </td> -</tr> -<tr> - <td> - --resources=VALUE - </td> - <td> -Total consumable resources per agent. Can be provided in JSON format -or as a semicolon-delimited list of key:value pairs, with the role -optionally specified. -<p/> -As a key:value list: -<code>name(role):value;name:value...</code> -<p/> -To use JSON, pass a JSON-formatted string or use -<code>--resources=filepath</code> to specify the resources via a file containing -a JSON-formatted string. 'filepath' can be of the form -<code>file:///path/to/file</code> or <code>/path/to/file</code>. -<p/> -Example JSON: -<pre><code>[ - { - "name": "cpus", - "type": "SCALAR", - "scalar": { - "value": 24 - } - }, - { - "name": "mem", - "type": "SCALAR", - "scalar": { - "value": 24576 - } - } -]</code></pre> - </td> -</tr> -<tr> - <td> - --resource_provider_config_dir=VALUE - </td> - <td> -Path to a directory that contains local resource provider configs. -Each file in the config dir should contain a JSON object representing -a <code>ResourceProviderInfo</code> object. Each local resource -provider provides resources that are local to the agent. It is also -responsible for handling operations on the resources it provides. -Please note that <code>resources</code> field might not need to be -specified if the resource provider determines the resources -automatically. -<p/> -Example config file in this directory: -<pre><code>{ - "type": "org.mesos.apache.rp.local.storage", - "name": "lvm" -}</code></pre> - </td> -</tr> -<tr> - <td> - --[no-]revocable_cpu_low_priority - </td> - <td> -Run containers with revocable CPU at a lower priority than -normal containers (non-revocable cpu). Currently only -supported by the cgroups/cpu isolator. (default: true) - </td> -</tr> -<tr> - <td> - --runtime_dir - </td> - <td> -Path of the agent runtime directory. This is where runtime data -is stored by an agent that it needs to persist across crashes (but -not across reboots). This directory will be cleared on reboot. -(Example: <code>/var/run/mesos</code>) - </td> -</tr> -<tr> - <td> - --sandbox_directory=VALUE - </td> - <td> -The absolute path for the directory in the container where the -sandbox is mapped to. -(default: /mnt/mesos/sandbox) - </td> -</tr> -<tr> - <td> - --[no-]disallow_sharing_agent_pid_namespace - </td> - <td> -If set to <code>true</code>, each top-level container will have its own pid -namespace, and if the framework requests to share the agent pid namespace for -the top level container, the container launch will be rejected. If set to -<code>false</code>, the top-level containers will share the pid namespace with -agent if the framework requests it. This flag will be ignored if the -`namespaces/pid` isolator is not enabled. -(default: false) - </td> -</tr> -<tr> - <td> - --[no-]strict - </td> - <td> -If <code>strict=true</code>, any and all recovery errors are considered fatal. -If <code>strict=false</code>, any expected errors (e.g., agent cannot recover -information about an executor, because the agent died right before -the executor registered.) during recovery are ignored and as much -state as possible is recovered. -(default: true) - </td> -</tr> -<tr> - <td> - --secret_resolver=VALUE - </td> - <td> -The name of the secret resolver module to use for resolving -environment and file-based secrets. If this flag is not specified, -the default behavior is to resolve value-based secrets and error on -reference-based secrets. - </td> -</tr> - -<tr> - <td> - --[no-]switch_user - </td> - <td> -If set to <code>true</code>, the agent will attempt to run tasks as -the <code>user</code> who submitted them (as defined in <code>FrameworkInfo</code>) -(this requires <code>setuid</code> permission and that the given <code>user</code> -exists on the agent). -If the user does not exist, an error occurs and the task will fail. -If set to <code>false</code>, tasks will be run as the same user as the Mesos -agent process. -<b>NOTE</b>: This feature is not yet supported on Windows agent, and -therefore the flag currently does not exist on that platform. (default: true) - </td> -</tr> -<tr> - <td> - --[no-]systemd_enable_support - </td> - <td> -Top level control of systemd support. When enabled, features such as -executor life-time extension are enabled unless there is an explicit -flag to disable these (see other flags). This should be enabled when -the agent is launched as a systemd unit. -(default: true) - </td> -</tr> -<tr> - <td> - --systemd_runtime_directory=VALUE - </td> - <td> -The path to the systemd system run time directory. -(default: /run/systemd/system) - </td> -</tr> -</table> - -*Flags available when configured with `--with-network-isolator`* - -<table class="table table-striped"> - <thead> - <tr> - <th width="30%"> - Flag - </th> - <th> - Explanation - </th> - </tr> - </thead> -<tr> - <td> - --ephemeral_ports_per_container=VALUE - </td> - <td> -Number of ephemeral ports allocated to a container by the network -isolator. This number has to be a power of 2. This flag is used -for the <code>network/port_mapping</code> isolator. (default: 1024) - </td> -</tr> -<tr> - <td> - --eth0_name=VALUE - </td> - <td> -The name of the public network interface (e.g., <code>eth0</code>). If it is -not specified, the network isolator will try to guess it based -on the host default gateway. This flag is used for the -<code>network/port_mapping</code> isolator. - </td> -</tr> -<tr> - <td> - --lo_name=VALUE - </td> - <td> -The name of the loopback network interface (e.g., lo). If it is -not specified, the network isolator will try to guess it. This -flag is used for the <code>network/port_mapping</code> isolator. - </td> -</tr> -<tr> - <td> - --egress_rate_limit_per_container=VALUE - </td> - <td> -The limit of the egress traffic for each container, in Bytes/s. -If not specified or specified as zero, the network isolator will -impose no limits to containers' egress traffic throughput. -This flag uses the Bytes type (defined in stout) and is used for -the <code>network/port_mapping</code> isolator. - </td> -</tr> -<tr> - <td> - --[no-]egress_unique_flow_per_container - </td> - <td> -Whether to assign an individual flow for each container for the -egress traffic. This flag is used for the <code>network/port_mapping</code> -isolator. (default: false) - </td> -</tr> -<tr> - <td> - --egress_flow_classifier_parent=VALUE - </td> - <td> -When <code>egress_unique_flow_per_container</code> is enabled, we need to install -a flow classifier (fq_codel) qdisc on egress side. This flag specifies -where to install it in the hierarchy. By default, we install it at root. - </td> -</tr> -<tr> - <td> - --[no-]network_enable_socket_statistics_summary - </td> - <td> -Whether to collect socket statistics summary for each container. -This flag is used for the <code>network/port_mapping</code> isolator. -(default: false) - </td> -</tr> -<tr> - <td> - --[no-]network_enable_socket_statistics_details - </td> - <td> -Whether to collect socket statistics details (e.g., TCP RTT) for -each container. This flag is used for the <code>network/port_mapping</code> -isolator. (default: false) - </td> -</tr> -<tr> - <td> - --[no-]network_enable_snmp_statistics - </td> - <td> -Whether to collect SNMP statistics details (e.g., TCPRetransSegs) for -each container. This flag is used for the 'network/port_mapping' -isolator. (default: false) - </td> -</tr> -</table> - -*XFS disk isolator flags available when configured with -`--enable-xfs-disk-isolator`* - -<table class="table table-striped"> - <thead> - <tr> - <th width="30%"> - Flag - </th> - <th> - Explanation - </th> - </tr> - </thead> -<tr> - <td> - --xfs_project_range=VALUE - </td> -<td> -The ranges of XFS project IDs that the isolator can use to track disk -quotas for container sandbox directories. Valid project IDs range from -1 to max(uint32). (default `[5000-10000]`) -</td> -</tr> -</table> +See [configuration/agent.md](configuration/agent.md). ## Libprocess Options -*The bundled libprocess library can be controlled with the following environment variables.* - -<table class="table table-striped"> - <thead> - <tr> - <th width="30%"> - Variable - </th> - <th> - Explanation - </th> - </tr> - </thead> - <tr> - <td> - LIBPROCESS_IP - </td> - <td> - Sets the IP address for communication to and from libprocess. - </td> - </tr> - <tr> - <td> - LIBPROCESS_PORT - </td> - <td> - Sets the port for communication to and from libprocess. - </td> - </tr> - <tr> - <td> - LIBPROCESS_ADVERTISE_IP - </td> - <td> - If set, this provides the IP address that will be advertised to - the outside world for communication to and from libprocess. - This is useful, for example, for containerized tasks in which - communication is bound locally to a non-public IP that will be - inaccessible to the master. - </td> - </tr> - <tr> - <td> - LIBPROCESS_ADVERTISE_PORT - </td> - <td> - If set, this provides the port that will be advertised to the - outside world for communication to and from libprocess. Note that - this port will not actually be bound (the local LIBPROCESS_PORT - will be), so redirection to the local IP and port must be - provided separately. - </td> - </tr> - <tr> - <td> - LIBPROCESS_REQUIRE_PEER_ADDRESS_IP_MATCH - </td> - <td> - If set, the IP address portion of the libprocess UPID in - incoming messages is required to match the IP address - of the socket from which the message was sent. This can be a - security enhancement since it prevents unauthorized senders - impersonating other libprocess actors. This check may - break configurations that require setting LIBPROCESS_IP, - or LIBPROCESS_ADVERTISE_IP. Additionally, multi-homed - configurations may be affected since the address on - which libprocess is listening may not match the address from - which libprocess connects to other actors. - </td> - </tr> - <tr> - <td> - LIBPROCESS_ENABLE_PROFILER - </td> - <td> - To enable the profiler, this variable must be set to 1. Note that this - variable will only work if Mesos has been configured with - <code>--enable-perftools</code>. - </td> - </tr> - <tr> - <td> - LIBPROCESS_METRICS_SNAPSHOT_ENDPOINT_RATE_LIMIT - </td> - <td> - If set, this variable can be used to configure the rate limit - applied to the /metrics/snapshot endpoint. The format is - `<number of requests>/<interval duration>`. - Examples: `10/1secs`, `100/10secs`, etc. - </td> - </tr> - <tr> - <td> - LIBPROCESS_NUM_WORKER_THREADS - </td> - <td> - If set to an integer value in the range 1 to 1024, it overrides - the default setting of the number of libprocess worker threads, - which is the maximum of 8 and the number of cores on the machine. - </td> - </tr> -</table> - - -## Mesos Autotools Build Configuration Options - -### Autotools `configure` script options - -<table class="table table-striped"> - <thead> - <tr> - <th width="30%"> - Flag - </th> - <th> - Explanation - </th> - </tr> - </thead> - <tr> - <td> - --enable-static[=PKGS] - </td> - <td> - Build static libraries. [default=yes] - </td> - </tr> - <tr> - <td> - --enable-dependency-tracking - </td> - <td> - Do not reject slow dependency extractors. - </td> - </tr> - <tr> - <td> - --disable-dependency-tracking - </td> - <td> - Speeds up one-time build. - </td> - </tr> - <tr> - <td> - --enable-silent-rules - </td> - <td> - Less verbose build output (undo: "make V=1"). - </td> - </tr> - <tr> - <td> - --disable-silent-rules - </td> - <td> - Verbose build output (undo: "make V=0"). - </td> - </tr> - <tr> - <td> - --disable-maintainer-mode - </td> - <td> - Disable make rules and dependencies not useful (and sometimes confusing) - to the casual installer. - </td> - </tr> - <tr> - <td> - --enable-shared[=PKGS] - </td> - <td> - Build shared libraries. [default=yes] - </td> - </tr> - <tr> - <td> - --enable-fast-install[=PKGS] - </td> - <td> - Optimize for fast installation. [default=yes] - </td> - </tr> - <tr> - <td> - --disable-libtool-lock - </td> - <td> - Avoid locking. Note that this might break parallel builds. - </td> - </tr> - <tr> - <td> - --disable-bundled - </td> - <td> - Configures Mesos to build against preinstalled dependencies - instead of bundled libraries. - </td> - </tr> - <tr> - <td> - --disable-bundled-pip - </td> - <td> - Excludes building and using the bundled pip package in lieu of an - installed version in <code>PYTHONPATH</code>. - </td> - </tr> - <tr> - <td> - --disable-bundled-setuptools - </td> - <td> - Excludes building and using the bundled setuptools package in lieu of an - installed version in <code>PYTHONPATH</code>. - </td> - </tr> - <tr> - <td> - --disable-bundled-wheel - </td> - <td> - Excludes building and using the bundled wheel package in lieu of an - installed version in <code>PYTHONPATH</code>. - </td> - </tr> - <tr> - <td> - --enable-debug - </td> - <td> - Whether debugging is enabled. If CFLAGS/CXXFLAGS are set, this - option won't change them. [default=no] - </td> - </tr> - <tr> - <td> - --disable-java - </td> - <td> - Don't build Java bindings. - </td> - </tr> - <tr> - <td> - --enable-libevent - </td> - <td> - Use <a href="https://github.com/libevent/libevent";>libevent</a> - instead of libev for the libprocess event loop. Note that the libevent - version 2+ development package is required. [default=no] - </td> - </tr> - <tr> - <td> - --enable-install-module-dependencies - </td> - <td> - Install third-party bundled dependencies required for module development. - [default=no] - </td> - </tr> - <tr> - <td> - --enable-optimize - </td> - <td> - Whether optimizations are enabled. If CFLAGS/CXXFLAGS are set, - this option won't change them. [default=no] - </td> - </tr> - <tr> - <td> - --enable-perftools - </td> - <td> - Whether profiling with Google perftools is enabled. [default=no] - </td> - </tr> - <tr> - <td> - --enable-parallel-test-execution - </td> - <td> - Whether to attempt to run tests in parallel. - </td> - </tr> - <tr> - <td> - --disable-python - </td> - <td> - Don't build Python bindings. - </td> - </tr> - <tr> - <td> - --disable-python-dependency-install - </td> - <td> - When the python packages are installed during make install, no external - dependencies will be downloaded or installed. - </td> - </tr> - <tr> - <td> - --enable-ssl - </td> - <td> - Enable <a href="/documentation/latest/ssl">SSL</a> for libprocess - communication. Note that <code>--enable-libevent</code> is currently - required for SSL functionality. [default=no] - </td> - </tr> - <tr> - <td> - --enable-static-unimplemented - </td> - <td> - Generate static assertion errors for unimplemented functions. [default=no] - </td> - </tr> - <tr> - <td> - --enable-tests-install - </td> - <td> - Build and install tests and their helper tools. [default=no] - </td> - </tr> - <tr> - <td> - --enable-xfs-disk-isolator - </td> - <td> - Builds the XFS disk isolator. [default=no] - </td> - </tr> - <tr> - <td> - --disable-zlib - </td> - <td> - Disables zlib compression, which means the webui will be far less - responsive; not recommended. - </td> - </tr> - <tr> - <td> - --enable-lock-free-event-queue - </td> - <td> - Enables the lock-free event queue to be used in libprocess which - greatly improves message passing performance! - </td> - </tr> - <tr> - <td> - --disable-werror - </td> - <td> - Disables treating compiler warnings as fatal errors. - </td> - </tr> -</table> - -### Autotools `configure` script optional package flags +See [configuration/libprocess.md](configuration/libprocess.md). -<table class="table table-striped"> - <thead> - <tr> - <th width="30%"> - Flag - </th> - <th> - Explanation - </th> - </tr> - </thead> - <tr> - <td> - --with-gnu-ld - </td> - <td> - Assume the C compiler uses GNU <code>ld</code>. [default=no] - </td> - </tr> - <tr> - <td> - --with-sysroot[=DIR] - </td> - <td> - Search for dependent libraries within <code>DIR</code> - (or the compiler's sysroot if not specified). - </td> - </tr> - <tr> - <td> - --with-apr[=DIR] - </td> - <td> - Specify where to locate the apr-1 library. - </td> - </tr> - <tr> - <td> - --with-boost[=DIR] - </td> - <td> - Excludes building and using the bundled Boost package in lieu of an - installed version at a location prefixed by the given path. - </td> - </tr> - <tr> - <td> - --with-concurrentqueue[=DIR] - </td> - <td> - Excludes building and using the bundled concurrentqueue package in lieu - of an installed version at a location prefixed by the given path. - </td> - </tr> - <tr> - <td> - --with-curl[=DIR] - </td> - <td> - Specify where to locate the curl library. - </td> - </tr> - <tr> - <td> - --with-elfio[=DIR] - </td> - <td> - Excludes building and using the bundled ELFIO package in lieu of an - installed version at a location prefixed by the given path. - </td> - </tr> - <tr> - <td> - --with-glog[=DIR] - </td> - <td> - excludes building and using the bundled glog package in lieu of an - installed version at a location prefixed by the given path. - </td> - </tr> - <tr> - <td> - --with-gmock[=DIR] - </td> - <td> - Excludes building and using the bundled gmock package in lieu of an - installed version at a location prefixed by the given path. - </td> - </tr> - <tr> - <td> - --with-http-parser[=DIR] - </td> - <td> - Excludes building and using the bundled http-parser package in lieu of an - installed version at a location prefixed by the given path. - </td> - </tr> - <tr> - <td> - --with-leveldb[=DIR] - </td> - <td> - Excludes building and using the bundled LevelDB package in lieu of an - installed version at a location prefixed by the given path. - </td> - </tr> - <tr> - <td> - --with-libev[=DIR] - </td> - <td> - Excludes building and using the bundled libev package in lieu of an - installed version at a location prefixed by the given path. - </td> - </tr> - <tr> - <td> - --with-libevent[=DIR] - </td> - <td> - Specify where to locate the libevent library. - </td> - </tr> - <tr> - <td> - --with-libprocess[=DIR] - </td> - <td> - Specify where to locate the libprocess library. - </td> - </tr> - <tr> - <td> - --with-network-isolator - </td> - <td> - Builds the network isolator. - </td> - </tr> - <tr> - <td> - --with-nl[=DIR] - </td> - <td> - Specify where to locate the - <a href="https://www.infradead.org/~tgr/libnl/";>libnl3</a> library, - which is required for the network isolator. - </td> - </tr> - <tr> - <td> - --with-nvml[=DIR] - </td> - <td> - Excludes building and using the bundled NVML headers in lieu of an - installed version at a location prefixed by the given path. - </td> - </tr> - <tr> - <td> - --with-picojson[=DIR] - </td> - <td> - Excludes building and using the bundled picojson package in lieu of an - installed version at a location prefixed by the given path. - </td> - </tr> - <tr> - <td> - --with-protobuf[=DIR] - </td> - <td> - Excludes building and using the bundled protobuf package in lieu of an - installed version at a location prefixed by the given path. - </td> - </tr> - <tr> - <td> - --with-sasl[=DIR] - </td> - <td> - Specify where to locate the sasl2 library. - </td> - </tr> - <tr> - <td> - --with-ssl[=DIR] - </td> - <td> - Specify where to locate the ssl library. - </td> - </tr> - <tr> - <td> - --with-stout[=DIR] - </td> - <td> - Specify where to locate stout library. - </td> - </tr> - <tr> - <td> - --with-svn[=DIR] - </td> - <td> - Specify where to locate the svn-1 library. - </td> - </tr> - <tr> - <td> - --with-zlib[=DIR] - </td> - <td> - Specify where to locate the zlib library. - </td> - </tr> - <tr> - <td> - --with-zookeeper[=DIR] - </td> - <td> - Excludes building and using the bundled ZooKeeper package in lieu of an - installed version at a location prefixed by the given path. - </td> - </tr> -</table> +# Mesos Build Configuration -### Environment variables which affect the Autotools `configure` script +## Autotools Options -Use these variables to override the choices made by `configure` or to help -it to find libraries and programs with nonstandard names/locations. +If you have special compilation requirements, please refer to `./configure +--help` when configuring Mesos. -<table class="table table-striped"> - <thead> - <tr> - <th width="30%"> - Variable - </th> - <th> - Explanation - </th> - </tr> - </thead> - <tr> - <td> - JAVA_HOME - </td> - <td> - Location of Java Development Kit (JDK). - </td> - </tr> - <tr> - <td> - JAVA_CPPFLAGS - </td> - <td> - Preprocessor flags for JNI. - </td> - </tr> - <tr> - <td> - JAVA_JVM_LIBRARY - </td> - <td> - Full path to <code>libjvm.so</code>. - </td> - </tr> - <tr> - <td> - MAVEN_HOME - </td> - <td> - Looks for <code>mvn</code> at <code>MAVEN_HOME/bin/mvn</code>. - </td> - </tr> - <tr> - <td> - PROTOBUF_JAR - </td> - <td> - Full path to protobuf jar on prefixed builds. - </td> - </tr> - <tr> - <td> - PYTHON - </td> - <td> - Which Python interpreter to use. - </td> - </tr> - <tr> - <td> - PYTHON_VERSION - </td> - <td> - The installed Python version to use, for example '2.3'. This string will - be appended to the Python interpreter canonical name. - </td> - </tr> -</table> +See [configuration/autotools.md](configuration/autotools.md). -### CMake configuration options +## CMake Options -<table class="table table-striped"> - <thead> - <tr> - <th width="30%"> - Flag - </th> - <th> - Explanation - </th> - </tr> - </thead> - <tr> - <td> - -DVERBOSE=(TRUE|FALSE) - </td> - <td> - Generate a build solution that produces verbose output - (for example, verbose Makefiles). [default=TRUE] - </td> - </tr> - <tr> - <td> - -DBUILD_SHARED_LIBS=(TRUE|FALSE) - </td> - <td> - Build shared libraries (where possible). - [default=FALSE for Windows, TRUE otherwise] - </td> - </tr> - <tr> - <td> - -DENABLE_PRECOMPILED_HEADERS=(TRUE|FALSE) - </td> - <td> - Enable auto-generated precompiled headers using cotire. - [default=TRUE for Windows, FALSE otherwise] - </td> - </tr> - <tr> - <td> - -DCPACK_BINARY_[TYPE]=(TRUE|FALSE) - </td> - <td> - Where [TYPE] is one of BUNDLE, DEB, DRAGNDROP, IFW, NSIS, OSXX11, - PACKAGEMAKER, RPM, STGZ, TBZ2, TGZ, TXZ. This modifies the 'package' - target to generate binary package of the specified format. A binary - package contains everything that would be installed via CMake's 'install' - target. [default=FALSE] - </td> - </tr> - <tr> - <td> - -DCPACK_SOURCE_[TYPE]=(TRUE|FALSE) - </td> - <td> - Where [TYPE] is one of TBZ2, TXZ, TZ, ZIP. This modifies the - 'package_source' target to generate a package of the sources required to - build and test Mesos, in the specified format. [default=FALSE] - </td> - </tr> - <tr> - <td> - -DREBUNDLED=(TRUE|FALSE) - </td> - <td> - Attempt to build against the third-party dependencies included as tarballs - in the Mesos repository. NOTE: This is not always possible. For example, a - dependency might not be included as a tarball in the Mesos repository; - additionally, Windows does not have a package manager, so we do not expect - system dependencies like APR to exist natively, and we therefore must - acquire them. In these cases (or when <code>-DREBUNDLED=FALSE</code>), we - will acquire the dependency from the location specified by the - <code>3RDPARTY_DEPENDENCIES</code>, which by default points to the - official Mesos <a - href="https://github.com/3rdparty/mesos-3rdparty";>third-party dependency - mirror</a>. [default=TRUE] - </td> - </tr> - <tr> - <td> - -DENABLE_LIBEVENT=(TRUE|FALSE) - </td> - <td> - Use <a href="https://github.com/libevent/libevent";>libevent</a> instead of - libev for the event loop. This is required (but not the default) on - Windows. [default=FALSE] - </td> - </tr> - <tr> - <td> - -DENABLE_SSL=(TRUE|FALSE) - </td> - <td> - Build libprocess with SSL support. [default=FALSE] - </td> - </tr> - <tr> - <td> - -DOPENSSL_ROOT_DIR=[path] - </td> - <td> - Specify the path to OpenSSL, e.g. "C:\OpenSSL-Win64". - [default=unspecified] - </td> - </tr> - <tr> - <td> - -DENABLE_LOCK_FREE_RUN_QUEUE=(TRUE|FALSE) - </td> - <td> - Build libprocess with lock free run queue. [default=FALSE] - </td> - </tr> - <tr> - <td> - -DENABLE_JAVA=(TRUE|FALSE) - </td> - <td> - Build Java components. Warning: this is SLOW. [default=FALSE] - </td> - </tr> - <tr> - <td> - -D3RDPARTY_DEPENDENCIES=[path_or_url] - </td> - <td> - Location of the dependency mirror. In some cases, the Mesos build system - needs to acquire third-party dependencies that aren't rebundled as - tarballs in the Mesos repository. For example, on Windows, we must aquire - newer versions of some dependencies, and since Windows does not have a - package manager, we must acquire system dependencies like cURL. This - parameter can be either a URL (for example, pointing at the Mesos official - <a href="https://github.com/3rdparty/mesos-3rdparty";>third-party - dependency mirror</a>), or a local folder (for example, a local clone of - the dependency mirror). - [default="https://github.com/3rdparty/mesos-3rdparty/raw/master";] - </td> - </tr> - <tr> - <td> - -DPATCHEXE_PATH=[path] - </td> - <td> - Location of - <a href="http://gnuwin32.sourceforge.net/packages/patch.htm";>GNU Patch for - Windows</a> binary. [default=%PROGRAMFILESX86%/GnuWin32/bin/patch.exe] - </td> - </tr> -</table> +See [configuration/cmake.md](configuration/cmake.md).
