Name: service-backup-release
Owner: Pivotal Cloud Foundry
Description: Service Backup BOSH Release
Created: 2017-06-02 10:49:54.0
Updated: 2018-05-21 08:31:12.0
Pushed: 2018-05-21 08:34:29.0
Homepage: https://docs.pivotal.io/svc-sdk/service-backup
Size: 348
Language: Ruby
GitHub Committers
| User | Most Recent Commit | # Commits |
|---|
Other Committers
| User | Most Recent Commit | # Commits |
|---|
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.
User documentation can be found here.
Service Backup releases artifacts can be found on PivNet. Service Metrics 18.1.2+ are licensed under Apache 2.0.
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.
Clone the repo:
t 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 and its dependencies as submodules.
Ensure the submodules are up to date:
service-backup-release
t submodule update --init --recursive
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:
ew install direnv
Update the package spec file
When adding or removing submodules to the BOSH release, use the sync-package-specs helper script as shown below:
scripts/sync-package-specs
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:
sh target lite # or the alias/IP for your BOSH lite director
sh deployment manifests/bosh-lite-deployment.yml
sh create release --name service-backup
sh upload release
sh deploy
Note: to create the release, you will need the Bosh CLI v2.0.48+
Update the .gitmodules file
When adding or removing submodules to the BOSH release, use the sync-submodule-config helper script as shown below:
scripts/sync-submodule-config
This script will overwrite the .gitmodules file. Due to a bug in gosub, it will replace git@ with
https://. This needs to be manually corrected for any private repositories, e.g. pivotal-cf/service-backup.
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!