Difference between revisions of "WOCE Build Environment"

From WebOS-Ports
Jump to: navigation, search
(Linux Setup)
(Installation Procedure)
 
(44 intermediate revisions by 7 users not shown)
Line 1: Line 1:
<big>This is a Work in Progress </big>
+
<big>Develop in your environment, Build in ours. </big>
  
 +
== WOCE Build Environment ==
  
== WOCE Self-Contained Development 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 SDE uses Vagrant and Virtualbox to create a self-contained development and build environment for use on Windows, OSX and Linux Hosts.
+
''Note: Windows Hosts will work, but are unsupported.''
  
Our goal is to create a consistent setup for developers so that if there are issues with development 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.
  
 
'''Minimum Requirements'''
 
'''Minimum Requirements'''
  
x86 based computer running Windows(XP minimum), OSX(10.5 minimum) or Linux(32bit or 64bit).
+
x86 based computer running OSX(10.5 minimum) or Linux(32bit or 64bit).
  
 
Enough resources to allot:  
 
Enough resources to allot:  
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:
 
 
 
vagrant box add precise32 http://files.vagrantup.com/precise32.box
 
 
 
6.
 
 
 
===OSX Setup===
 
 
 
'''Host:'''
 
 
 
1. Edit:
 
/System/Library/LaunchDaemons/com.apple.nfsd.plist
 
''(requires superuser)''
 
 
 
2. Scroll down to the line that reads:
 
<string>/sbin/nfsd</string>
 
 
 
3. Add a new line below it that reads:
 
<string>-N</string>
 
 
 
4. Save the file, close it
 
 
 
5. Edit:
 
/etc/exports
 
''(requires superuser)''
 
 
 
6. Add the following:
 
 
 
/path/to/shared/dir -mapall=501
 
  
7. Save and close it
+
5. From a Command Prompt in the directory you have set aside for the build environment
  
8. Open Terminal.app and run the following:
+
git clone git://www.github.com/woce/woce-be
  
sudo nfsd enable
+
===Usage===
  
sudo nfsd checkexports
+
From a Command Prompt in the woce-be directory:
  
  showmount -e
+
'''Bring the VM online'''
 +
  vagrant up
 +
''(You can ignore stdin: not a tty errors- these are normal.)''
  
If successful, your share's path should be printed to stdout.
+
'''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'.
  
'''Client:'''
+
When you're done:
 +
'''Shut down the VM'''
 +
vagrant halt
  
1. Edit:  
+
And if you want to destroy the VM to start with a clean slate:
  /etc/fstab
+
  vagrant destroy
  
2. Modify the bottom line, replacing:
+
===Shared Folder===
/PATH/TO/HOST/SHARE
 
with the location of woce-build clone on your host machine
 
  
3. Save and close the fstab
+
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.
  
4. run the following command:
+
'''Host System:'''
  sudo mount /srv/share
+
  ~/woce-be/
''(Subject to change if using the host's WOCE folder)''
 
  
===Windows Setup===
+
''*is*''
  
'''Host:'''
+
'''Virtual Machine:'''
 +
/srv/share/
  
'''Client:'''
+
===Extra===
  
1. Edit:
+
To maximize build performance, it is recommended to configure the Virtual Machine with as many CPU cores and as much RAM as is possible.
/etc/fstab
 
  
2. Modify the bottom line, replacing:
+
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.
/PATH/TO/HOST/SHARE
 
with the location of woce-build clone on your host machine
 
  
3. Save and close the fstab
+
'''WARNING:''' If you plan on editing Vagrantfile, make sure you know what you are doing!
  
4. run the following command:
 
sudo mount /srv/share
 
''(Subject to change if using the host's WOCE folder)''
 
  
===Linux Setup===
+
Example:
  
 +
'''Host System:'''
  
'''Host:'''
+
8 CPU Cores
 +
8Gb RAM
  
'''Client:'''
 
  
1. Edit:  
+
'''Virtual Machine:'''
/etc/fstab
 
  
2. Modify the bottom line, replacing:
+
4 CPU Cores
  /PATH/TO/HOST/SHARE
+
  4Gb RAM
with the location of woce-build clone on your host machine
 
  
3. Save and close the fstab
+
If you plan on making changes in Vagrantfile, you'll want to make changes like the following.
  
4. run the following command:
+
config.vm.customize ["modifyvm", :id, "--memory", 2048]
  sudo mount /srv/share
+
  config.vm.customize ["modifyvm", :id, "--cpus", 2]
''(Subject to change if using the host's WOCE folder)''
 

Latest revision as of 19: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

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]