Backing Up and Restoring Spring Cloud Services

Page last updated:

Spring Cloud Services is compatible with the BOSH Backup and Restore (BBR) framework. You can use BBR to back up your installation of Spring Cloud Services and to restore it from a backup. See below for information about backing up and restoring Spring Cloud Services using BBR.

Note: BBR is the only supported method for backing up or restoring Spring Cloud Services. The following information assumes that you have installed and are using the BBR binary.

Data Included in a Backup

The backup file contains all of the state of the Spring Cloud Services BOSH VM. This includes the following data:

  • The scs-service-broker database used by the Spring Cloud Services service broker to store service instance information.
  • The mirror-service database used by the Config Server’s mirror service to store mappings between service instances and Git repository mirrors.
  • All Git repository mirrors used by Config Server service instances.

Backing apps for Spring Cloud Services service instances are included in a backup of VMware Tanzu Application Service for VMs. For more information, see Backing Up and Restoring Pivotal Platform.

Requirements

You will need:

  • The BOSH command line credentials ([client_id] and [client_secret] below). These are available from the Credentials tab of the BOSH Director tile in the Ops Manager Installation Dashboard, in the Bosh Commandline Credentials row. Bosh cli credentials
  • The BOSH Director’s IP address ([bosh_director_ip] below). This is available from the Status tab of the BOSH Director tile in the Installation Dashboard, in the IPs column of the BOSH Director row. Bosh director ip
  • The BOSH Director’s CA certificate ([bosh_ca_cert] below). This is available on the Ops Manager VM at /var/tempest/workspaces/default/root_ca_certificate, or via the Ops Manager API (see the Ops Manager documentation about how to Retrieve the Ops Manager Root CA).
  • (If restoring) A BBR backup artifact from which to restore your Spring Cloud Services installation (the path to this artifact is [path_to_artifact] below).

Backing Up Spring Cloud Services

To back up your Spring Cloud Services installation, run the bbr deployment backup command as shown below:

$ BOSH_CLIENT=[client_id] \
BOSH_CLIENT_SECRET=[client_secret] \
bbr deployment \
  --target [bosh_director_ip] \
  --deployment cf-spring-cloud-deployment \
  --ca-cert [bosh_ca_cert] \
  backup

Restoring Spring Cloud Services from a Backup

To restore your Spring Cloud Services installation from an existing backup, run the bbr deployment restore command as shown below:

$ BOSH_CLIENT=[client_id] \
BOSH_CLIENT_SECRET=[client_secret] \
bbr deployment \
  --target [bosh_director_ip]> \
  --deployment cf-spring-cloud-deployment \
  --ca-cert [bosh_ca_cert] \
  restore \
  --artifact-path [path_to_artifact]