trevorwhitney / bbr-pcf-pipeline-tasks

Concourse tasks to help automate bbr https://github.com/cloudfoundry-incubator/bosh-backup-and-restore

BBR PCF Pipeline Tasks

This is a collection of Concourse tasks for backing up a Pivotal Cloud Foundry installation using bbr.

All Foundations

• export-om-installation: Export Ops Manager installation settings
• bbr-backup-director: Run bbr director backup
• bbr-cleanup-director: Run bbr director backup-cleanup

DEPRECATED - ERT

• bbr-backup-ert: Run bbr deployment backup for ERT
• bbr-cleanup-ert: Run bbr deployment backup-cleanup for ERT

PAS

• bbr-backup-pas: Run bbr deployment backup for PAS
• bbr-cleanup-pas: Run bbr deployment backup-cleanup for PAS

PKS

• bbr-backup-pks: Run bbr deployment backup for PKS control plane
• bbr-cleanup-pks: Run bbr deployment backup-cleanup for PKS control plane
• bbr-backup-pks-clusters: Run bbr deployment --all-deployments backup for all PKS clusters
• bbr-cleanup-pks-clusters: Run bbr deployment --all-deployments backup-cleanup for all PKS clusters
• lock-pks: Lock PKS control plane
• unlock-pks: Unlock PKS control plane

Helper

• extract-bbr-binary: Extracts the linux bbr binary from tarfile

---

Requirements

Networking

To use any of these tasks, apart from export-om-installation, you will need either:

• a Concourse worker with access to your Ops Manager private networks. You can find an example template for deploying an external worker in a different network to your Concourse deployment here
• or, provide the OPSMAN_PRIVATE_KEY to use a SSH tunnel via the Ops Manager VM. Please note, using a SSH tunnel may increase the time taken to drain backup artifacts. Backup artifacts can be very large and using a SSH tunnel will be a significant overhead on network performance.

Disk space

The backup tasks will run bbr commands on your Concourse worker. Ensure that your Concourse workers have enough disk space to accommodate your backup artifacts.

---

Example pipelines

Example pipelines and secrets are provided to show how to use these tasks to back up PAS or PKS.

Triggers

Running regular backups (at least every 24 hours) and storing multiple copies of backup artifacts in different datacenters is highly recommended. The time Concourse resource can be added to the pipeline to trigger backups regularly.

Backup artifact storage

There are a variety of storage resources such as S3 that can be used to move backups to storage. A list of Concourse resources can be found here.

---

Semantic Versioning

The inputs, outputs, params, filename, and filepath of all task files in this repo are part of a semantically versioned API. See our documentation for a detailed discussion of our semver API. See www.semver.org for an explanation of semantic versioning.

Pinning to a version

This repository has git tags that can be used to pin to a specific version. For example, here is how to pin to v1.0.0 using tag_filter:

resources:
- name: bbr-pipeline-tasks-repo
  type: git
  source:
    uri: https://github.com/pivotal-cf/bbr-pcf-pipeline-tasks.git
    branch: master
    tag_filter: v1.0.0