-
Notifications
You must be signed in to change notification settings - Fork 68
/
bbr-install-config.html.md.erb
126 lines (83 loc) · 5.14 KB
/
bbr-install-config.html.md.erb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
---
title: Installing and Configuring BOSH Backup and Restore
owner: TKGI
---
This topic describes how to install BOSH Backup and Restore (BBR).
##<a id="overview"></a> Overview
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](#install-bbr-overview) 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:
* To back up and restore Kubernetes clusters provisioned by TKGI, see [Backing Up and Restoring TKGI Clusters](backup-and-restore-clusters.html).
* To back up and restore TKGI Management Plane Components, see [Backing Up and Restoring TKGI Managmenent Plane](backup-and-restore-tkgi.html).
##<a id="prerequisites"></a> Prerequisites
Using BBR requires the following:
* A jump box.
<br>
A jump box is a separate, hardened server on your network that provides a controlled means of accessing the other VMs on your network.
See the [jumpbox-deployment](https://github.com/cloudfoundry/jumpbox-deployment) GitHub repository for an example jump box deployment.
<br>
You must have a jump box before you can install BBR to the jump box.
<br>
* 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.
* To determine the correct version of BBR for your deployment, see the [Tanzu Kubernetes Grid Integrated Edition Release Notes](release-notes.html).
* To download a BBR installation file, see [BOSH Backup and Restore](https://support.broadcom.com/group/ecx/productdownloads?subfamily=BOSH%20Backup%20and%20Restore) on the Broadcom Support.
<p class="note"><strong>Note</strong>: BBR does not support SSH gateways.</p>
##<a id="install-bbr-overview"></a> Install and Configure BOSH Backup and Restore
To install and configure BBR:
1. [Configure Your Jump Box for BBR](#bbr-jumpbox)
1. [Install BBR on Your Jump Box](#bbr-install)
1. [Verify Your BBR Installation](#bbr-install)
1. [Configure BBR Logging](#bbr-logging)
###<a id="bbr-jumpbox"></a> Configure Your Jump Box for BBR
Your jump box must meet or exceed minimum BBR requirements.
You can use the VMware Tanzu Operations Manager (Ops 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:
1. Size the jump box to have sufficient storage space for your backups.
1. Ensure the jump box can communicate with the network containing your Tanzu Kubernetes Grid Integrated Edition deployment.
<br>
BBR uses SSH to orchestrate the back up of your Tanzu Kubernetes Grid Integrated Edition instances using port 22 by default.
1. Configure the jump box to be in the same network as the deployed VMs.
<br>
BBR connects to the deployed VMs at their private IP addresses.
1. Ensure there is minimal network latency between the jump box and the source VMs BBR backs up.
###<a id='bbr-install'></a> Install BBR on Your Jump Box
To install the `bbr` executable to your jump box:
1. Download the latest compatible [BOSH Backup and Restore release](https://support.broadcom.com/group/ecx/productdownloads?subfamily=BOSH%20Backup%20and%20Restore) from the Broadcom Support.
1. To add executable permissions to the `bbr` binary file, run the following command:
```
chmod a+x bbr
```
1. 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.
###<a id='bbr-install'></a> Verify Your BBR Installation
To verify that BBR is installed:
1. Run the following command:
```
bbr version
```
Verify the returned BBR version.
###<a id='bbr-logging'></a>Configure BBR Logging
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:
* The back up and restore scripts that it finds.
* The time when the process starts and finishes.
* The time when stages, such as `pre-backup scripts` or `backup scripts`, start and finish.
* The errors that occur.
To troubleshoot a failed BBR run, enable verbose logging.
When executed in verbose mode, BBR reports the following additional information:
* Logs about the API requests made to the BOSH server.
* All commands executed on remote instances.
* All commands executed on local environment.
* Standard in and standard out streams for the back up and restore scripts when they are executed.
To enable verbose logging, use the optional `--debug` flag.