forked from pivotal-cf/docs-pks
-
Notifications
You must be signed in to change notification settings - Fork 0
/
bbr-install.html.md.erb
69 lines (46 loc) · 3.39 KB
/
bbr-install.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
---
title: Installing BOSH Backup and Restore
owner: PKS
---
<strong><%= modified_date %></strong>
This topic describes how to install BOSH Backup and Restore (BBR).
##<a id="overview"></a> Overview
To install BBR, first validate that your jumpbox VM is a valid BOSH backup host, then copy the BBR executable to the jumpbox.
After installing BBR, you can run `bbr` commands to back up and restore your <%= vars.product_short %>
deployment.
For more information about using BOSH Backup and Restore, see:
* To perform a backup, see [Backing up <%= vars.product_short %>](bbr-backup.html).
* To perform a restore of the BOSH Director, see [Restore the BOSH Director](bbr-restore.html#redeploy-restore-director).
* To perform a restore of the <%= vars.product_short %> Control Plane, see [Restore the <%= vars.product_short %> Control Plane](bbr-restore.html#redeploy-restore-control-plane).
* To perform a restore of the <%= vars.product_short %> Clusters. see [Restore <%= vars.product_short %> Clusters](bbr-restore.html#redeploy-restore-clusters).
##<a id="prerequisites"></a> Prerequisite
Using BBR requires the following:
* A jumpbox. You must have a jumpbox before you can install BBR to the jumpbox.
* A bbr executable file. You must have the correct BBR executable version for your PKS installation.
A jumpbox 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 jumpbox deployment.
To determine the correct version of BBR for your deployment, see the [<%= vars.product_short %> Release Notes](release-notes.html).
To download a BBR installation file, see [BOSH Backup and Restore](https://network.pivotal.io/products/p-bosh-backup-and-restore) on the Pivotal Network.
##<a id="jumpbox-setup"></a> Configure Your Jumpbox
Configure your jumpbox to meet the following requirements:
* Your jumpbox must be able to communicate with the network that contains your <%= vars.product_short %> deployment. You
can use the Ops Manager VM as your jumpbox.
* Your jumpbox must have sufficient space for the backup.
* Your jumpbox must be in the same network as the deployed VMs because BBR connects to the VMs at their private IP addresses. BBR does not support SSH gateways.
* Your jumpbox should be a host with minimal network latency to the source VMs you are configuring BBR to backup.
<p class="note"><strong>Note</strong>: BBR uses SSH to orchestrate the backup of your <%= vars.product_short %> instances using port 22 by default.</p>
## <a id='scp'></a> Transfer BBR to Your Jumpbox
Copy the `bbr` executable to a local disk then upload the executable to the jumpbox:
1. Download the latest [BOSH Backup and Restore release](https://network.pivotal.io/products/p-bosh-backup-and-restore) from Pivotal Network.
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 jumpbox, run the following command:
```
scp LOCAL-PATH-TO-BBR/bbr JUMPBOX-USER@JUMPBOX-ADDRESS:
```
Where:
* `LOCAL-PATH-TO-BBR` is the path to the `bbr` binary you downloaded from Pivotal Network.
* `JUMPBOX-USER` is the ssh username for connecting to the jumpbox.
* `JUMPBOX-ADDRESS` is the IP address, or hostname, of the jumpbox.