Installation

Supported Platforms

Peloton is maintained on the following platforms:

• Ubuntu Linux 14.04+ (64-bit)
• Ubuntu Linux 16.04+ (64-bit)
• Ubuntu Linux 18.04+ (64-bit)
• macOS 10.12+ (64-bit)

A 64-bit processor with SSE4.2 support is required. Support for Fedora was dropped because of missing official support for Tensorflow.

Ubuntu Quick Setup

1. Clone Peloton repo

   git clone --recursive https://github.com/cmu-db/peloton.git

2. Install the packages in the package list using this script.

   cd peloton/script/installation
   sudo bash packages.sh

3. Now, go to the Build Peloton step.

macOS Quick Setup

1. Command Line Tools: Download Command Line Tools for your system from Apple (login required). The latest confirmed working version is Command Line Tools for Xcode 9.3.

2. Clone Peloton repo

   git clone --recursive https://github.com/cmu-db/peloton.git

3. Install the packages in the package list using this script.

   cd peloton/script/installation
   bash packages.sh

   You might meet some permission problem. You can change the owner of the files. Here are some useful commands.

   sudo chown root /usr/local/bin/brew
   sudo chown -R $(whoami) /usr/local/Cellar

4. Now, go to the Build Peloton step.

Virtual Machine Quick Setup

1. Install Git, Virtualbox, and Vagrant (if needed).

   Git Download Virtualbox Download

   • Vagrant Download
   • Getting Started with Vagrant on OSX Yosemite
   • Getting Started with Vagrant on Windows

2. Clone Peloton repo

   git clone --recursive https://github.com/cmu-db/peloton.git

3. Initialize the vagrant box

   cd peloton/script/installation
   vagrant up

   NOTE: Actual VM is managed by VirtualBox, not stored in the local Peloton repo you just cloned.

4. Connect to the vagrant box

   vagrant ssh

5. Now, go to the Build Peloton step.

   In case you wish to reload the virtual machine so that any changes made in the Vagrantfile take effect, use this command:

   vagrant reload --provision

---

Build Peloton

The following instructions are for building Peloton from the command line. If you'd like to use an IDE, please see the Eclipse and CLion pages.

Before building Peloton, make sure that you have installed all its software dependencies by following the instructions above.

Enter the build directory and run cmake:

• Ubuntu:

   mkdir -p build
   cd build
   cmake -DCMAKE_BUILD_TYPE=Release ..

• macOS:

   mkdir -p build
   cd build
   export LLVM_DIR=/usr/local/Cellar/llvm@3.7/3.7.1/lib/llvm-3.7
   cmake -DCMAKE_BUILD_TYPE=Release ..

  If your system can not find llvm under macOS, please try with following:

   cmake -DCMAKE_PREFIX_PATH=`llvm-config-3.7 --prefix` -DUSE_SANITIZER=Address ..

• Vagrant VirtualBox VM:

  /peloton on VM is automatically created as a shared folder linked to the repo on host. This might not support building directly in the repo, so a separate build dir needs to be created:

   mkdir -p ~/build
   cd ~/build
   cmake -DCMAKE_BUILD_TYPE=Release /peloton

If your system reports error then please try the following alternative instead (it is caused by code coverage not being supported under release mode):

cmake -DCMAKE_BUILD_TYPE=Release -DCOVERALLS=False ..

If you are a developer, please refer to the Developer Build section.

Build and install Peloton

make -j4

If you want peloton to be in your path, update paths in .bashrc or .zshrc or your favorite shell's startup file :

export PATH=$(BUILD_DIR)/bin:$PATH

Enable SSL connection

By default, SSL is disabled. You can enable SSL by running the scripts to generate certificates and keys.

cd script/installation/
sudo bash create_certificates.sh