This topic describes how to install BOSH Backup and Restore (BBR).
To install BBR, first validate that your jump box VM is a valid BOSH backup host, then copy the bbr
executable to the jump box and configure BBR.
For more information, see Install and Configure BOSH Backup and Restore below.
After installing BBR, you can run bbr
commands to back up and restore your Tanzu Kubernetes Grid Integrated Edition deployment.
For more information about using BOSH Backup and Restore, see:
Using BBR requires the following:
The OpenBSD version of netcat must be installed on the jump box host.
A bbr
executable file. You must have the correct BBR executable version for your TKGI installation.
Note: BBR does not support SSH gateways.
To install and configure BBR:
Your jump box must meet or exceed minimum BBR requirements. You can use the VMware Tanzu Operations Manager VM as your jump box if it can be configured to meet all of the requirements below.
To configure your jump box to meet BBR requirements:
Ensure the jump box can communicate with the network containing your Tanzu Kubernetes Grid Integrated Edition deployment.
BBR uses SSH to orchestrate the back up of your Tanzu Kubernetes Grid Integrated Edition instances using port 22 by default.
Configure the jump box to be in the same network as the deployed VMs.
BBR connects to the deployed VMs at their private IP addresses.
Ensure there is minimal network latency between the jump box and the source VMs BBR backs up.
To install the bbr
executable to your jump box:
To add executable permissions to the bbr
binary file, run the following command:
chmod a+x bbr
To securely copy the bbr
binary file to your jump box, run the following command:
scp LOCAL-PATH-TO-BBR/bbr JUMP-BOX-USER@JUMP-BOX-ADDRESS:
Where:
LOCAL-PATH-TO-BBR
is the path to the bbr
binary you downloaded from Broadcom Support.JUMP-BOX-USER
is the SSH user name for connecting to the jump box.JUMP-BOX-ADDRESS
is the IP address, or hostname, of the jump box.To verify that BBR is installed:
Run the following command:
bbr version
Verify the returned BBR version.
BBR writes back up and restore logs to the current directory in a file named bbr-TIMESTAMP.err.log
.
By default BBR writes errors associated with stack traces to the log file.
BBR also reports default information about the back up and restore run:
pre-backup scripts
or backup scripts
, start and finish.To troubleshoot a failed BBR run, enable verbose logging. When executed in verbose mode, BBR reports the following additional information:
To enable verbose logging, use the optional --debug
flag.