Difference between revisions of "WOCE Build Environment"
BigBlueHat (talk | contribs) |
|||
| (23 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
<big>Develop in your environment, Build in ours. </big> | <big>Develop in your environment, Build in ours. </big> | ||
| − | |||
== WOCE Build Environment == | == WOCE Build Environment == | ||
| − | |||
===Introduction=== | ===Introduction=== | ||
The WOCE BE uses Vagrant and Virtualbox to create a self-contained build environment for use on OSX and Linux Hosts. | The WOCE BE uses Vagrant and Virtualbox to create a self-contained build environment for use on OSX and Linux Hosts. | ||
| + | |||
| + | ''Note: Windows Hosts will work, but are unsupported.'' | ||
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. | 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. | ||
| Line 29: | Line 29: | ||
3. Install Virtualbox | 3. Install Virtualbox | ||
| − | 4. Install Vagrant [ | + | 4. Install Vagrant [https://docs-v1.vagrantup.com/v1/docs/getting-started/index.html (Vagrant Getting Started Guide)] |
| − | 5. From a Command Prompt in the directory you have set aside for | + | 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'. | |
| − | + | When you're done: | |
| + | '''Shut down the VM''' | ||
| + | vagrant halt | ||
| − | + | And if you want to destroy the VM to start with a clean slate: | |
| + | vagrant destroy | ||
| − | + | ===Shared Folder=== | |
| − | + | Also note there ''is'' a shared folder between the host and virtual machine. The folder your vagrant files are stored in is shared with the virtual machine in /srv/share. This is useful in allowing you to do dev work in the environment you are most comfortable with while still making it easy to use our build environment. Anything you want the build environment to be able to access for the build should be placed in this folder. Assuming your vagrant install is as recommended, see the following as an example. | |
| − | + | '''Host System:''' | |
| + | ~/woce-be/ | ||
| − | + | ''*is*'' | |
| − | + | '''Virtual Machine:''' | |
| − | + | /srv/share/ | |
| − | + | ===Extra=== | |
| − | |||
| − | |||
| − | + | To maximize build performance, it is recommended 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 ''or'' via editing Vagrantfile, recommended settings are half of the host system's CPU cores, and half of it's RAM. | |
| − | + | '''WARNING:''' If you plan on editing Vagrantfile, make sure you know what you are doing! | |
| − | |||
| − | |||
| − | + | Example: | |
| − | |||
| − | + | '''Host System:''' | |
| − | |||
| − | |||
| − | + | 8 CPU Cores | |
| − | + | 8Gb RAM | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | + | '''Virtual Machine:''' | |
| − | |||
| − | + | 4 CPU Cores | |
| − | + | 4Gb RAM | |
| − | |||
| − | + | If you plan on making changes in Vagrantfile, you'll want to make changes like the following. | |
| − | + | config.vm.customize ["modifyvm", :id, "--memory", 2048] | |
| − | + | config.vm.customize ["modifyvm", :id, "--cpus", 2] | |
| − | |||
Latest revision as of 20:21, 31 March 2016
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.
Note: Windows Hosts will work, but are unsupported.
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'.
When you're done: Shut down the VM
vagrant halt
And if you want to destroy the VM to start with a clean slate:
vagrant destroy
Also note there is a shared folder between the host and virtual machine. The folder your vagrant files are stored in is shared with the virtual machine in /srv/share. This is useful in allowing you to do dev work in the environment you are most comfortable with while still making it easy to use our build environment. Anything you want the build environment to be able to access for the build should be placed in this folder. Assuming your vagrant install is as recommended, see the following as an example.
Host System:
~/woce-be/
*is*
Virtual Machine:
/srv/share/
Extra
To maximize build performance, it is recommended 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 or via editing Vagrantfile, recommended settings are half of the host system's CPU cores, and half of it's RAM.
WARNING: If you plan on editing Vagrantfile, make sure you know what you are doing!
Example:
Host System:
8 CPU Cores 8Gb RAM
Virtual Machine:
4 CPU Cores 4Gb RAM
If you plan on making changes in Vagrantfile, you'll want to make changes like the following.
config.vm.customize ["modifyvm", :id, "--memory", 2048] config.vm.customize ["modifyvm", :id, "--cpus", 2]