Installing BOSH Backup and Restore

This topic describes how to install BOSH Backup and Restore (BBR).

You install the bbr binary on a jumpbox, and then run bbr from the jumpbox to back up and restore your BOSH deployment or BOSH Director.

Step 1: Set Up Your Jumpbox

Set up your jumpbox with the following settings:

  • The jumpbox must be able to communicate with the network that contains your BOSH deployment.
  • The jumpbox must have sufficient space for the backup.
  • BBR connects to the VMs at their private IP address, so the jumpbox needs to be in the same network as the deployed VMs. BBR does not support SSH gateways.
  • BBR copies the backed-up data from the VMs to the jumpbox, so ensure you have minimal network latency between them to reduce transfer times.

Consult the following table for more information about the network access permissions required by BBR.

VM Default Port Description
BOSH Director 25555 BBR interacts with the BOSH Director API.
Deployed Instances 22 BBR uses SSH to orchestrate the backup on the instances.
BOSH Director UAA 8443 BBR interacts with the UAA API for authentication, if necessary.

Step 2: Transfer BBR to Your Jumpbox

Perform the following steps to transfer the bbr binary to your jumpbox:

  1. Download the latest BBR release.
  2. Change the permissions of bbr in order to make it executable:
    $ chmod a+x bbr
  3. SCP the binary to your jumpbox:
    $ scp LOCAL_PATH_TO_BBR/bbr JUMPBOX_USER/JUMPBOX_ADDRESS
    If your jumpbox has access to the internet, you can also SSH into your jumpbox and use wget:
    $ ssh JUMPBOX_USER/JUMPBOX_ADDRESS -i YOUR_CERTIFICATE.pem
    $ wget BBR_RELEASE_URL
    $ chmod a+x bbr
    
Create a pull request or raise an issue on the source for this page in GitHub