You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mesos.apache.org by ti...@apache.org on 2015/06/15 17:28:38 UTC

mesos git commit: Update 'Getting Started' documentation.

Repository: mesos
Updated Branches:
  refs/heads/master c3333bbbc -> e35909e47


Update 'Getting Started' documentation.

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


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

Branch: refs/heads/master
Commit: e35909e4765590448a76d769c040aa1f74b43ede
Parents: c3333bb
Author: Michael Park <mc...@gmail.com>
Authored: Mon Jun 15 15:21:13 2015 +0200
Committer: Till Toenshoff <to...@me.com>
Committed: Mon Jun 15 17:25:49 2015 +0200

----------------------------------------------------------------------
 docs/getting-started.md | 117 ++++++++++++++++++++-----------------------
 1 file changed, 53 insertions(+), 64 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/mesos/blob/e35909e4/docs/getting-started.md
----------------------------------------------------------------------
diff --git a/docs/getting-started.md b/docs/getting-started.md
index af67966..258a1c9 100644
--- a/docs/getting-started.md
+++ b/docs/getting-started.md
@@ -19,71 +19,66 @@ There are different ways you can get Mesos:
 
 ## System Requirements
 
--  Mesos runs on Linux (64 Bit) and Mac OSX (64 Bit).
+Mesos runs on Linux (64 Bit) and Mac OS X (64 Bit).
 
-### Ubuntu
+### Ubuntu 14.04
 
-The following assumes a stock install of Ubuntu 14.04 LTS, to which you should add a current
-Java JDK (for example, OpenJDK):
+Following are the instructions for stock Ubuntu 14.04. If you are using a different OS, please install the packages accordingly.
 
-        # Update the packages
+        # Update the packages.
         $ sudo apt-get update
 
-        # Installs the latest OpenJDK (***Only required if you don't already have a working JDK***)
+        # Install the latest OpenJDK.
         $ sudo apt-get install -y openjdk-7-jdk
 
-If you are building from git repository, you will need to additionally install the following packages:
-
-        # Only necessary if building from git repository
+        # Install autotools (Only necessary if building from git repository).
         $ sudo apt-get install -y autoconf libtool
 
-The following are the necessary dependencies for `Mesos 0.22`:
-
-        $ sudo apt-get -y install build-essential python-dev python-boto \
-            libcurl4-nss-dev libsasl2-dev \
-            maven libapr1-dev libsvn-dev
+        # Install other Mesos dependencies.
+        $ sudo apt-get -y install build-essential python-dev python-boto libcurl4-nss-dev libsasl2-dev maven libapr1-dev libsvn-dev
 
-### Mac OSX (Yosemite)
+### Mac OS X Yosemite
 
-Before starting, you will need to install [XCode](https://developer.apple.com/xcode/) and
-the Command Line Tools via the AppStore.
+Following are the instructions for stock Mac OS X Yosemite. If you are using a different OS, please install the packages accordingly.
 
-Use [homebrew](http://brew.sh/) to install the additional dependencies:
+        # Install Command Line Tools.
+        $ xcode-select --install
 
-        # If you don't already have `brew` installed
+        # Install Homebrew.
         $ ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
 
-        # Install libraries
-        brew install autoconf automake libtool subversion maven
-
-You may (optionally) also need [Python 3](https://www.python.org/downloads) as it's not installed by default
-on OSX.
+        # Install libraries.
+        $ brew install autoconf automake libtool subversion maven
 
 ### CentOS 6.6
 
-- Following are the instructions for stock CentOS 6.6. If you are using a different OS, please install the packages accordingly.
+Following are the instructions for stock CentOS 6.6. If you are using a different OS, please install the packages accordingly.
 
         # Install a few utility tools
-        $ sudo yum install -y wget tar
-
-        # 'Mesos > 0.21.0' requires 'subversion > 1.8' devel package, which is
-        # not available in the default repositories.
-        # Add the Wandisco SVN repo file: '/etc/yum.repos.d/wandisco-svn.repo' with content:
-
-          [WandiscoSVN]
-          name=Wandisco SVN Repo
-          baseurl=http://opensource.wandisco.com/centos/6/svn-1.8/RPMS/$basearch/
-          enabled=1
-          gpgcheck=0
+        $ sudo yum install -y tar wget which
 
         # 'Mesos > 0.21.0' requires a C++ compiler with full C++11 support,
         # (e.g. GCC > 4.8) which is available via 'devtoolset-2'.
-        # Fetch the Scientific Linux CERN devtoolset repo file: '/etc/yum.repos.d/slc6-devtoolset.repo':
+        # Fetch the Scientific Linux CERN devtoolset repo file.
         $ sudo wget -O /etc/yum.repos.d/slc6-devtoolset.repo http://linuxsoft.cern.ch/cern/devtoolset/slc6-devtoolset.repo
 
         # Import the CERN GPG key.
         $ sudo rpm --import http://linuxsoft.cern.ch/cern/centos/7/os/x86_64/RPM-GPG-KEY-cern
 
+        # Fetch the Apache Maven repo file.
+        $ sudo wget http://repos.fedorapeople.org/repos/dchen/apache-maven/epel-apache-maven.repo -O /etc/yum.repos.d/epel-apache-maven.repo
+
+        # 'Mesos > 0.21.0' requires 'subversion > 1.8' devel package, which is
+        # not available in the default repositories.
+        # Add the WANdisco SVN repo file: '/etc/yum.repos.d/wandisco-svn.repo' with content:
+
+          [WANdiscoSVN]
+          name=WANdisco SVN Repo 1.8
+          enabled=1
+          baseurl=http://opensource.wandisco.com/centos/6/svn-1.8/RPMS/$basearch/
+          gpgcheck=1
+          gpgkey=http://opensource.wandisco.com/RPM-GPG-KEY-WANdisco
+
         # Install essential development tools.
         $ sudo yum groupinstall -y "Development Tools"
 
@@ -91,12 +86,7 @@ on OSX.
         $ sudo yum install -y devtoolset-2-toolchain
 
         # Install other Mesos dependencies.
-        $ sudo yum install -y python-devel java-1.7.0-openjdk-devel zlib-devel libcurl-devel openssl-devel cyrus-sasl-devel cyrus-sasl-md5 apr-devel subversion-devel apr-util-devel
-
-        # Install maven.
-        $ wget http://mirror.nexcess.net/apache/maven/maven-3/3.0.5/binaries/apache-maven-3.0.5-bin.tar.gz
-        $ sudo tar -zxf apache-maven-3.0.5-bin.tar.gz -C /opt/
-        $ sudo ln -s /opt/apache-maven-3.0.5/bin/mvn /usr/bin/mvn
+        $ sudo yum install -y apache-maven python-devel java-1.7.0-openjdk-devel zlib-devel libcurl-devel openssl-devel cyrus-sasl-devel cyrus-sasl-md5 apr-devel subversion-devel apr-util-devel
 
         # Enter a shell with 'devtoolset-2' enabled.
         $ scl enable devtoolset-2 bash
@@ -107,35 +97,34 @@ on OSX.
 - Following are the instructions for stock CentOS 7.1. If you are using a different OS, please install the packages accordingly.
 
         # Install a few utility tools
-        $ sudo yum install -y wget tar
+        $ sudo yum install -y tar wget
+
+        # Fetch the Apache Maven repo file.
+        $ sudo wget http://repos.fedorapeople.org/repos/dchen/apache-maven/epel-apache-maven.repo -O /etc/yum.repos.d/epel-apache-maven.repo
 
         # 'Mesos > 0.21.0' requires 'subversion > 1.8' devel package, which is
         # not available in the default repositories.
-        # Add the Wandisco SVN repo file: '/etc/yum.repos.d/wandisco-svn.repo' with content:
+        # Add the WANdisco SVN repo file: '/etc/yum.repos.d/wandisco-svn.repo' with content:
 
-          [WandiscoSVN]
-          name=Wandisco SVN Repo
-          baseurl=http://opensource.wandisco.com/centos/7/svn-1.9/RPMS/$basearch/
+          [WANdiscoSVN]
+          name=WANdisco SVN Repo 1.9
           enabled=1
-          gpgcheck=0
+          baseurl=http://opensource.wandisco.com/centos/7/svn-1.9/RPMS/$basearch/
+          gpgcheck=1
+          gpgkey=http://opensource.wandisco.com/RPM-GPG-KEY-WANdisco
 
         # Install essential development tools.
         $ sudo yum groupinstall -y "Development Tools"
 
         # Install other Mesos dependencies.
-        $ sudo yum install -y python-devel java-1.7.0-openjdk-devel zlib-devel libcurl-devel openssl-devel cyrus-sasl-devel cyrus-sasl-md5 apr-devel subversion-devel apr-util-devel
-
-        # Install maven.
-        $ wget http://mirror.nexcess.net/apache/maven/maven-3/3.0.5/binaries/apache-maven-3.0.5-bin.tar.gz
-        $ sudo tar -zxf apache-maven-3.0.5-bin.tar.gz -C /opt/
-        $ sudo ln -s /opt/apache-maven-3.0.5/bin/mvn /usr/bin/mvn
+        $ sudo yum install -y apache-maven python-devel java-1.7.0-openjdk-devel zlib-devel libcurl-devel openssl-devel cyrus-sasl-devel cyrus-sasl-md5 apr-devel subversion-devel apr-util-devel
 
 ## Building Mesos
 
         # Change working directory.
         $ cd mesos
 
-        # Bootstrap (***Skip this if you are not building from git repo***).
+        # Bootstrap (Only required if building from git repository).
         $ ./bootstrap
 
         # Configure and build.
@@ -144,22 +133,22 @@ on OSX.
         $ ../configure
         $ make
 
-to speed up the build and reduce verbosity of the logs, you can append `-j=<number of cores> V=0`
-to `make`.
+In order to speed up the build and reduce verbosity of the logs, you can append `-j=<number of cores> V=0` to `make`.
 
         # Run test suite.
         $ make check
 
-        # Install (***Optional***).
+        # Install (Optional).
         $ make install
 
 ## Examples
--  Mesos comes bundled with example frameworks written in `C++`, `Java` and `Python`.
+
+Mesos comes bundled with example frameworks written in C++, Java and Python.
 
         # 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 slave.
@@ -168,13 +157,13 @@ to `make`.
         # 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: To build the example frameworks, make sure you build the test suite by doing `make check`.*