Quick Setup with Vagrant

This page shows how to set up a custom VM using the provided Vagrantfile. Vagrant handles the installation of dependencies and other common setup tasks. This means that the VM is ready to use once it's been initialized.

1. Install Git and Vagrant (if needed).

• Git download
• Vagrant download
• Getting started with Vagrant

2. Clone the OtterTune repo

   git clone https://github.com/cmu-db/ottertune.git

3. Initialize the vagrant box

   cd ottertune/server/website/script/installation
   vagrant up

4. Connect to the vagrant box

   vagrant ssh

5. The different options for bringing down the VM are listed here: https://www.vagrantup.com/intro/getting-started/teardown.html

6. Now move on to the Getting Started guide

Updating the VM

After making changes to the Vagrantfile or bootstrap.sh, the VM needs to be provisioned again for those changes to take effect.

If the VM is running:

vagrant reload --provision

Otherwise:

vagrant up --provision