WOCE Build Environment

From WebOS-Ports
Revision as of 00:26, 6 July 2012 by ShiftyAxel (talk | contribs) (Usage)
Jump to: navigation, search

Develop in your environment, Build in ours.

WOCE Build Environment

Introduction

The WOCE BE uses Vagrant and Virtualbox to create a self-contained build environment for use on OSX and Linux Hosts.

Our goal is to create a consistent build setup for developers so that if there are issues with builds we can know that we all are singing off the same sheet of music.

Minimum Requirements

x86 based computer running OSX(10.5 minimum) or Linux(32bit or 64bit).

Enough resources to allot:

  • 1 "Virtual CPU"
  • 1GB "Virtual RAM"
  • 20GB "Virtual HD"

Installation Procedure

1. From your development host go to Vagrant Downloads and download the latest version for your host.

2. From your development host go to Virtualbox Downloads and download the latest version for your host.

3. Install Virtualbox

4. Install Vagrant (Vagrant Getting Started Guide)

5. From a Command Prompt in the directory you have set aside for the build environment

git clone git://www.github.com/woce/woce-be

Usage

From a Command Prompt in the woce-be directory:

Bring the VM online

vagrant up

(You can ignore stdin: not a tty errors- these are normal.)

SSH into the VM

vagrant ssh

From here, there will be a woce-build directory in /vagrant/home, cloned down from git during 'vagrant up'. Also for convenience of custom builds, the directory containing the Vagrantfile on the host OS will be mounted at /srv/share inside the virtual machine.

And when you're done: Shut down the VM

vagrant destroy

Extra

To maximise build performance, it is suggested to configure the Virtual Machine with as many CPU cores and as much RAM as is possible.

This can be done through the VirtualBox Settings dialogue, recommended settings are half the host system's CPU cores, and half of it's RAM.


Example:

Host System:

8 CPU Cores 
8Gb RAM


Virtual Machine:

4 CPU Cores 
4Gb RAM