Repository: mesos Updated Branches: refs/heads/master eaccd7976 -> 0e7f08786
Fixed typos in docs. Project: http://git-wip-us.apache.org/repos/asf/mesos/repo Commit: http://git-wip-us.apache.org/repos/asf/mesos/commit/0e7f0878 Tree: http://git-wip-us.apache.org/repos/asf/mesos/tree/0e7f0878 Diff: http://git-wip-us.apache.org/repos/asf/mesos/diff/0e7f0878 Branch: refs/heads/master Commit: 0e7f087868992eedfabf6225337f1ed5abe07e6d Parents: eaccd79 Author: Neil Conway <[email protected]> Authored: Mon Mar 27 09:43:09 2017 -0700 Committer: Neil Conway <[email protected]> Committed: Mon Mar 27 09:43:09 2017 -0700 ---------------------------------------------------------------------- docs/configuration.md | 2 +- docs/containerizer-internals.md | 8 ++++---- docs/containerizer.md | 13 ++++++------- docs/getting-started.md | 12 ++++++------ docs/modules.md | 4 ++-- docs/oversubscription.md | 2 +- docs/ssl.md | 4 ++-- 7 files changed, 22 insertions(+), 23 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/mesos/blob/0e7f0878/docs/configuration.md ---------------------------------------------------------------------- diff --git a/docs/configuration.md b/docs/configuration.md index 6f1675f..b8ea941 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -2064,7 +2064,7 @@ quotas for container sandbox directories. Valid project IDs range from </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 + variable will only work if Mesos has been configured with <code>--enable-perftools</code>. </td> </tr> http://git-wip-us.apache.org/repos/asf/mesos/blob/0e7f0878/docs/containerizer-internals.md ---------------------------------------------------------------------- diff --git a/docs/containerizer-internals.md b/docs/containerizer-internals.md index 97776a6..f11f8f6 100644 --- a/docs/containerizer-internals.md +++ b/docs/containerizer-internals.md @@ -21,7 +21,7 @@ events (e.g., statistics). composing containerizer will be used to create a containerizer. * If an executor is not specified in `TaskInfo`, Mesos agent will use the default executor for the task (depending on the Containerizer - the agent is using, it could be `mesos-executor` or + the agent is using, it could be `mesos-executor` or `mesos-docker-executor`). TODO: Update this after MESOS-1718 is completed. After this change, master will be responsible for generating executor information. @@ -38,12 +38,12 @@ Mesos currently supports the following containerizers: Composing containerizer will compose the specified containerizers (using agent flag `--containerizers`) and act like a single -containerizer. This is an implementation of `composite` design +containerizer. This is an implementation of the `composite` design pattern. #### Docker Containerizer -Docker containerizer manages containers using docker engine provided +Docker containerizer manages containers using the docker engine provided in the docker package. ##### Container launch @@ -109,7 +109,7 @@ Launcher is responsible for forking/destroying containers. * Creates a âfreezerâ cgroup for the container. * Creates posix âpipeâ to enable communication between host (parent process) and container process. -* Spawn child process(container process) using `clone` system call. +* Spawn child process (container process) using `clone` system call. * Moves the new container process to the freezer hierarchy. * Signals the child process to continue (execâing) by writing a character to the write end of the pipe in the parent process. http://git-wip-us.apache.org/repos/asf/mesos/blob/0e7f0878/docs/containerizer.md ---------------------------------------------------------------------- diff --git a/docs/containerizer.md b/docs/containerizer.md index cd7be26..b6cf55b 100644 --- a/docs/containerizer.md +++ b/docs/containerizer.md @@ -7,12 +7,12 @@ layout: documentation ## Motivation -Containerizers are intended to run tasks in 'containers' which in turn are used -to: +Containerizers are used to run tasks in 'containers', which in turn are +used to: * Isolate a task from other running tasks. * 'Contain' tasks to run in limited resource runtime environment. -* Control task's individual resources (e.g, CPU, memory) programatically. +* Control a task's resource usage (e.g., CPU, memory) programatically. * Run software in a pre-packaged file system image, allowing it to run in different environments. @@ -21,14 +21,13 @@ to: Mesos plays well with existing container technologies (e.g., docker) and also provides its own container technology. It also supports composing different -container technologies(e.g., docker and mesos). +container technologies (e.g., docker and mesos). Mesos implements the following containerizers: * [Composing](#Composing) * [Docker](#Docker) * [Mesos (default)](#Mesos) -* External (deprecated) User can specify the types of containerizers to use via the agent flag `--containerizers`. @@ -61,7 +60,7 @@ containerizer is enabled when you configure the agent flag as Use cases: -* If task needs to be run with the tooling that comes with the docker package. +* If a task needs to be run with the tooling that comes with the docker package. * If Mesos agent is running inside a docker container. For more details, see @@ -79,7 +78,7 @@ Use cases: * Allow Mesos to control the task's runtime environment without depending on other container technologies (e.g., docker). * Want fine grained operating system controls (e.g., cgroups/namespaces provided - by linux). + by Linux). * Want Mesos's latest container technology features. * Need additional resource controls like disk usage limits, which might not be provided by other container technologies. http://git-wip-us.apache.org/repos/asf/mesos/blob/0e7f0878/docs/getting-started.md ---------------------------------------------------------------------- diff --git a/docs/getting-started.md b/docs/getting-started.md index 8cb6a8d..2578a29 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -245,22 +245,22 @@ described in the ***Building Mesos*** section above. # Change into build directory. $ cd build - # Start mesos master (Ensure work directory exists and has proper permissions). + # Start Mesos master (ensure work directory exists and has proper permissions). $ ./bin/mesos-master.sh --ip=127.0.0.1 --work_dir=/var/lib/mesos - # Start mesos agent (Ensure work directory exists and has proper permissions). + # Start Mesos agent (ensure work directory exists and has proper permissions). $ ./bin/mesos-agent.sh --master=127.0.0.1:5050 --work_dir=/var/lib/mesos - # Visit the mesos web page. + # Visit the Mesos web page. $ http://127.0.0.1:5050 - # Run C++ framework (Exits after successfully running some tasks.). + # Run C++ framework (exits after successfully running some tasks). $ ./src/test-framework --master=127.0.0.1:5050 - # Run Java framework (Exits after successfully running some tasks.). + # Run Java framework (exits after successfully running some tasks). $ ./src/examples/java/test-framework 127.0.0.1:5050 - # Run Python framework (Exits after successfully running some tasks.). + # Run Python framework (exits after successfully running some tasks). $ ./src/examples/python/test-framework 127.0.0.1:5050 *Note: These examples assume you are running Mesos on your local machine. http://git-wip-us.apache.org/repos/asf/mesos/blob/0e7f0878/docs/modules.md ---------------------------------------------------------------------- diff --git a/docs/modules.md b/docs/modules.md index 64204e3..9e19774 100644 --- a/docs/modules.md +++ b/docs/modules.md @@ -319,8 +319,8 @@ mesos::modules::Module<TestModule> org_apache_mesos_TestModule( ### Testing a module Apart from testing the module by hand with explicit use of --modules flag, one -can run the entire mesos test suite with the given module. For example, the -following command will run the mesos test suite with the +can run the entire Mesos test suite with the given module. For example, the +following command will run the Mesos test suite with the `org_apache_mesos_TestCpuIsolator` module selected for isolation: ./bin/mesos-tests.sh --modules="/home/kapil/mesos/isolator-module/modules.json" --isolation="org_apache_mesos_TestCpuIsolator" http://git-wip-us.apache.org/repos/asf/mesos/blob/0e7f0878/docs/oversubscription.md ---------------------------------------------------------------------- diff --git a/docs/oversubscription.md b/docs/oversubscription.md index ec71946..e4a1bae 100644 --- a/docs/oversubscription.md +++ b/docs/oversubscription.md @@ -17,7 +17,7 @@ jobs. Oversubscription was introduced in Mesos 0.23.0 and adds two new agent components: a Resource Estimator and a Quality of Service (QoS) Controller, alongside extending the existing resource allocator, resource monitor, and -mesos agent. The new components and their interactions are illustrated below. +Mesos agent. The new components and their interactions are illustrated below.  http://git-wip-us.apache.org/repos/asf/mesos/blob/0e7f0878/docs/ssl.md ---------------------------------------------------------------------- diff --git a/docs/ssl.md b/docs/ssl.md index be87030..811390f 100644 --- a/docs/ssl.md +++ b/docs/ssl.md @@ -24,7 +24,7 @@ Once you have successfully built and installed your new binaries, here are the e **NOTE:** Prior to 1.0, the SSL related environment variables used to be prefixed by `SSL_`. However, we found that they may collide with other programs and lead to unexpected results (e.g., openssl, see [MESOS-5863](https://issues.apache.org/jira/browse/MESOS-5863) for details). To be backward compatible, we accept environment variables prefixed by both `SSL_` or `LIBPROCESS_SSL_`. New users should use the `LIBPROCESS_SSL_` version. #### LIBPROCESS_SSL_ENABLED=(false|0,true|1) [default=false|0] -Turn on or off SSL. When it is turned off it is the equivalent of default mesos with libevent as the backing for events. All sockets default to the non-SSL implementation. When it is turned on, the default configuration for sockets is SSL. This means outgoing connections will use SSL, and incoming connections will be expected to speak SSL as well. None of the below flags are relevant if SSL is not enabled. If SSL is enabled, `LIBPROCESS_SSL_CERT_FILE` and `LIBPROCESS_SSL_KEY_FILE` must be supplied. +Turn on or off SSL. When it is turned off it is the equivalent of default Mesos with libevent as the backing for events. All sockets default to the non-SSL implementation. When it is turned on, the default configuration for sockets is SSL. This means outgoing connections will use SSL, and incoming connections will be expected to speak SSL as well. None of the below flags are relevant if SSL is not enabled. If SSL is enabled, `LIBPROCESS_SSL_CERT_FILE` and `LIBPROCESS_SSL_KEY_FILE` must be supplied. #### LIBPROCESS_SSL_SUPPORT_DOWNGRADE=(false|0,true|1) [default=false|0] Control whether or not non-SSL connections can be established. If this is enabled __on the accepting side__, then the accepting side will downgrade to a non-SSL socket if the connecting side is attempting to communicate via non-SSL. (e.g. HTTP). See [Upgrading Your Cluster](#Upgrading) for more details. @@ -84,7 +84,7 @@ brew install libevent ### OpenSSL We require [OpenSSL](https://github.com/openssl/openssl). There are multiple branches of OpenSSL that are being maintained by the community. Since security requires being vigilant, we recommend reading the release notes for the current releases of OpenSSL and deciding on a version within your organization based on your security needs. Mesos is not too deeply dependent on specific OpenSSL versions, so there is room for you to make security decisions as an organization. -Please ensure the `event2` and `openssl` headers are available for building mesos. +Please ensure the `event2` and `openssl` headers are available for building Mesos. ~~~ // For example, on OSX:
