BOSH Lite

• IRC: #bosh on freenode
• Mailing lists:
  • cf-bosh for asking BOSH usage and development questions
  • cf-dev for asking CloudFoundry questions
• CI: https://main.bosh-ci.cf-app.com/pipelines/bosh-lite
• Roadmap: Pivotal Tracker (label:bosh-lite)

A local development environment for BOSH using Warden containers in a Vagrant box.

This readme walks through deploying Cloud Foundry with BOSH Lite. BOSH and BOSH Lite can be used to deploy just about anything once you've got the hang of it.

1. Install BOSH Lite
   a. Prepare the Environment
   b. Install and Boot a Virtual Machine
   c. Customizing the Local VM IP
2. Deploy Cloud Foundry
3. Upgrading the BOSH Lite VM
4. Troubleshooting
5. Miscellaneous

Install BOSH Lite

Prepare the Environment

1. Install latest version of bosh_cli

   $ gem install bosh_cli
   

   Refer to BOSH CLI installation instructions for more information and troubleshooting tips.

2. Install Vagrant

   Known working version:

   $ vagrant --version
   Vagrant 1.6.3
   

3. Clone this repository

   $ cd ~/workspace
   $ git clone https://github.com/cloudfoundry/bosh-lite
   

Install and Boot a Virtual Machine

Installation instructions for different Vagrant providers:

• Virtualbox (below)
• AWS

Using the Virtualbox Provider

1. Install Virtualbox

   Known working version:

   $ VBoxManage --version
   4.3.14r95030
   

   Note: If you encounter problems with VirtualBox networking try installing Oracle VM VirtualBox Extension Pack as suggested by Issue 202.

2. Start Vagrant from the base directory of this repository, which contains the Vagrantfile. The most recent version of the BOSH Lite boxes will be downloaded by default from the Vagrant Cloud when you run vagrant up. If you have already downloaded an older version you will be warned that your version is out of date.

   $ vagrant up --provider=virtualbox
   

3. Target the BOSH Director. When prompted to log in, use admin/admin.

   # if behind a proxy, exclude both the VM's private IP and xip.io by setting no_proxy (xip.io is introduced later)
   $ export no_proxy=xip.io,192.168.50.4
   
   $ bosh target 192.168.50.4 lite
   Target set to `Bosh Lite Director'
   
   $ bosh login
   Your username: admin
   Enter password: *****
   Logged in as `admin'
   

4. Add a set of route entries to your local route table to enable direct Warden container access every time your networking gets reset (e.g. reboot or connect to a different network). Your sudo password may be required.

   $ bin/add-route
   

Customizing the Local VM IP

The local VMs (virtualbox, vmware providers) will be accessible at 192.168.50.4. You can optionally change this IP, uncomment the private_network line in the appropriate provider and change the IP address.

  config.vm.provider :virtualbox do |v, override|
    # To use a different IP address for the bosh-lite director, uncomment this line:
    # override.vm.network :private_network, ip: '192.168.59.4', id: :local
  end

Deploy Cloud Foundry

• See deploying Cloud Foundry documentation

Upgrading the BOSH Lite VM

If you wish to upgrade the BOSH Lite VM, you can run the following commands from the root of the bosh-lite directory. Make sure you have the latest version of this repository checked out. WARNING: these operations are destructive, and essentially amount to starting from scratch.

$ vagrant box update
$ vagrant destroy
$ vagrant up --provider=DESIRED_PROVIDER

Troubleshooting

• Starting over again is often the quickest path to success; you can use vagrant destroy from the base directory of this project to remove the VM.
• Another option is to use bosh cleanup. This will clean up the blob store to free up some space on the virtual machine.
• There is an issue (discussed here and here) with Vagrant permissions running on OS X Mavericks 10.9.2+ (after applying Apple's Security Update 2014-002). To diagnose, run vagrant up --debug and see if there is an error mentioning Symbol not found: _iconv. To resolve try one of the two

  1. Purging vagrant

     Purging ~/.vagrant.d

     Reinstalling vagrant

  2. Removing code block as described here

Miscellaneous

• bosh cck documentation for restoring deployments after VM reboot
• bosh ssh documentation for SSH into deployment jobs
• Offline documentation to configure BOSH lite firewall rules
• xip.io to access local IPs via DNS