Setting Up Your Jumpbox for BBR
Page last updated:
Warning: Pivotal Cloud Foundry (PCF) v2.4 is no longer supported because it has reached the End of General Support (EOGS) phase as defined by the Support Lifecycle Policy. To stay up to date with the latest software and security updates, upgrade to a supported version.
Page last updated:
This topic describes how to set up your jumpbox for BOSH Backup and Restore (BBR).
To use BBR to back up and restore your Pivotal Cloud Foundry (PCF) deployment, you must first set up a jumpbox to run BBR from. The Ops Manager VM might be suitable.
Configure your jumpbox to meet the following requirements:
- Your jumpbox must have sufficient space for the backup. A PCF backup requires at least 1.5 GB.
- Your jumpbox must exist on the same network as the VMs in your PCF deployment because BBR connects to the VMs at their private IP addresses. BBR does not support SSH gateways.
- Because BBR copies the backed-up data from the VMs to the jumpbox, you should 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.
|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.|
Perform the following steps to transfer the
bbr binary to your jumpbox:
Download the latest BOSH Backup and Restore release from Pivotal Network.
bbrbinary file from the BBR release.
To add executable permissions to the
bbrbinary file run the following command:
chmod a+x bbr
$ chmod a+x bbr
To securely copy the BBR binary to your jumpbox, run the following command:
rsync -Pv -e "ssh -i LOCAL-PATH-TO-JUMPBOX-PRIVATE-KEY" LOCAL-PATH-TO-BINARY-FILE JUMPBOX-USER@JUMPBOX-ADDRESS:
LOCAL-PATH-TO-JUMPBOX-PRIVATE-KEYis the local path to your private key file for the jumpbox host.
LOCAL-PATH-TO-BINARY-FILEis the local path for the binary file.
JUMPBOX-USERis your jumpbox username.
JUMPBOX-ADDRESSis the IP address of your jumpbox.
If the certificate chain on your local machine cannot verify the Certificate Authority (CA) certificate for the BOSH Director, you must have the path to the root CA certificate to run BBR commands.
If you have configured the Ops Manager VM as your jumpbox, the path to the root CA certificate
If you have configured another machine as your jumpbox, use the Ops Manager API to download the CA certificate.
To download the CA certificate using the Ops Manager API, run the following command:
curl -k "https://OPS-MAN-FQDN/api/v0/security/root_ca_certificate" \ -H "Authorization: Bearer UAA-ACCESS-TOKEN" \ | jq --raw-output '.root_ca_certificate_pem' > PATH-TO-BOSH-SERVER-CERTIFICATE
OPS-MAN-FQDNis the fully-qualified domain name (FQDN) for your Ops Manager deployment.
UAA-ACCESS-TOKENis your UAA access token. For more information, see Access the API.
PATH-TO-BOSH-SERVER-CERTIFICATEis file path location where you want the certificate to be written.
The open source
jqutility is available to download.
Note: See the Using the Ops Manager API topic to obtain a
UAA-ACCESS-TOKENusing the UAA CLI.