Skip to content

Latest commit

 

History

History
67 lines (39 loc) · 2.42 KB

README.md

File metadata and controls

67 lines (39 loc) · 2.42 KB
Raw

Service Backups for Cloud Foundry

BOSH operators running services (e.g. Redis service broker for Cloud Foundry) may want to back up certain files from the virtual machines running these services so that they can restore them after a disaster.

This product is not under active development. We only address security vulnerabilities and issue patches.

Using Service Backup

User documentation can be found here.

BOSH Release Artifacts

Service Backup releases artifacts can be found on PivNet. Service Metrics 18.1.2+ are licensed under Apache 2.0.

Contributing to Service Backup

We welcome contributions to Service Backup.

Below are the steps to clone and work on the Service Backup repo, however, if you have an idea for an improvement, we encourage you to get in touch with us via GitHub, Slack, or email, and we will help you.

Setting up development environment

  • Clone the repo:

    $ git clone git@github.com:pivotal-cf/service-backup-release.git

    Note that development is carried out on a branch called master; this will be checked out by default.

This repository is the BOSH release, and contains the Go code for the service backup daemon as submodule.

  • Set the $GOPATH

    The $GOPATH should be set to the release directory. To do this automatically, we recommend using direnv. In this example, we have used homebrew:

    $ brew install direnv

Deploying a release

  • Create your own standalone (i.e. not co-located) BOSH manifest

    An example of a bosh-lite manifest can be found at manifests/bosh-lite-deployment.yml.template.

    The values in the first section must be updated with your own director_uuid and properties.

  • Deploy the standalone BOSH release

    As above, the example provided assumes you are using bosh-lite:

    $ bosh target lite # or the alias/IP for your BOSH lite director
$ bosh deployment manifests/bosh-lite-deployment.yml
$ bosh create release --name service-backup
$ bosh upload release
$ bosh deploy

    Note: to create the release, you will need the Bosh CLI v2.0.48+

Committing your changes

  • Send a pull request

    Set up a pull request to the service-backup repository. Remember that development is carried out on a branch called master; please submit to this branch!