Skip to content

VirtualBox

BOSH Lite v2 is a Director VM running in VirtualBox (typically locally). It is managed via CLI v2. Internally CPI uses containers to emulate VMs which makes it an excellent choice for:

  • General BOSH exploration without investing time and resources to configure an IaaS
  • Development of releases (including BOSH itself)
  • Testing releases locally or in CI

Install

Follow below steps to get it running on locally on VirtualBox:

  1. Check that your machine has at least 8GB RAM, and 100GB free disk space. Smaller configurations may work.

  2. Install CLI v2

  3. Install VirtualBox

    Known working version:

    VBoxManage --version
# 5.1...

    Note: If you encounter problems with VirtualBox networking try installing Oracle VM VirtualBox Extension Pack as suggested by Issue 202. Alternatively make sure you are on VirtualBox 5.1+ since previous versions had a network connectivity bug.

  4. Install Director VM

    git clone https://github.com/cloudfoundry/bosh-deployment ~/workspace/bosh-deployment
mkdir -p ~/deployments/vbox
cd ~/deployments/vbox

    Below command will try automatically create/enable [Host-only network][vbox_host_only] 192.168.56.0/24 and [NAT network][vbox_nat_net] called NatNetwork with DHCP enabled.

    [vbox_host_only]: https://github.com/cloudfoundry/bosh-virtualbox-cpi-release/blob/master/docs/networks-host-only.md [vbox_nat_net]: https://github.com/cloudfoundry/bosh-virtualbox-cpi-release/blob/master/docs/networks-nat-network.md

    bosh create-env ~/workspace/bosh-deployment/bosh.yml \
  --state ./state.json \
  -o ~/workspace/bosh-deployment/virtualbox/cpi.yml \
  -o ~/workspace/bosh-deployment/virtualbox/outbound-network.yml \
  -o ~/workspace/bosh-deployment/bosh-lite.yml \
  -o ~/workspace/bosh-deployment/bosh-lite-runc.yml \
  -o ~/workspace/bosh-deployment/uaa.yml \
  -o ~/workspace/bosh-deployment/credhub.yml \
  -o ~/workspace/bosh-deployment/jumpbox-user.yml \
  --vars-store ./creds.yml \
  -v director_name=bosh-lite \
  -v internal_ip=192.168.56.6 \
  -v internal_gw=192.168.56.1 \
  -v internal_cidr=192.168.56.0/24 \
  -v outbound_network_name=NatNetwork

  5. Alias and log into the Director

    export BOSH_CLIENT=admin
export BOSH_CLIENT_SECRET=`bosh int ./creds.yml --path /admin_password`
bosh alias-env vbox -e 192.168.56.6 --ca-cert <(bosh int ./creds.yml --path /director_ssl/ca)

  6. Confirm that it works

    bosh -e vbox env
# Using environment '192.168.56.6' as '?'
#
# Name: ...
# User: admin
# Succeeded

  7. Optionally, set up a local route for bosh ssh commands or accessing VMs directly

    sudo route add -net 10.244.0.0/16     192.168.56.6 # Mac OS X
sudo ip route add   10.244.0.0/16 via 192.168.56.6 # Linux (using iproute2 suite)
sudo route add -net 10.244.0.0/16 gw  192.168.56.6 # Linux (using DEPRECATED route command)
route add           10.244.0.0/16     192.168.56.6 # Windows

Deploy example Zookeeper deployment

Run through quick steps below or follow deploy workflow that goes through the same steps but with more explanation.

  1. Update cloud config

    bosh -e vbox update-cloud-config ~/workspace/bosh-deployment/warden/cloud-config.yml

  2. Upload stemcell

    bosh -e vbox upload-stemcell \
  https://bosh.io/d/stemcells/bosh-warden-boshlite-ubuntu-xenial-go_agent?v=315.45 \
  --sha1 674cd3c1e64d8c51e62770697a63c07ca04e9bbd

  3. Deploy example deployment

    bosh -e vbox -d zookeeper deploy <(wget -O- https://raw.githubusercontent.com/cppforlife/zookeeper-release/master/manifests/zookeeper.yml)

  4. Run Zookeeper smoke tests

    bosh -e vbox -d zookeeper run-errand smoke-tests

Tips

  • In case you need to SSH into the Director VM, see Jumpbox.
  • In case VirtualBox VM shuts down or reboots, you will have to re-run create-env command from above with --recreate flag. The containers will be lost after a VM restart, but you can restore your deployment with bosh cck command. Alternatively Pause the VM from the VirtualBox UI before shutting down VirtualBox host, or making your computer sleep.