Spring Cloud Services for Cloud Foundry 3.2

Backing up and restoring Spring Cloud Services

Last Updated February 27, 2025

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. This topic provides information about backing up and restoring Spring Cloud Services using BBR.

Prerequisites

BBR is the only supported method for backing up or restoring Spring Cloud Services. To follow the instructions in this topic, you must have installed the BBR binary, and you must be using it to make backups.

Data included in a backup

The backup file contains all of the state information for 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 Tanzu Platform for Cloud Foundry. For more information, see the Tanzu Operations Manager documentation.

Requirements

You will need:

  • The BOSH command line credentials ([client_id] and [client_secret]). These are available from the Credentials tab of the BOSH Director tile in the Tanzu Operations Manager Installation Dashboard, in the Bosh Commandline Credentials row.

    BOSH Command Line Credentials

  • The BOSH Director’s IP address ([bosh_director_ip]). 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 Address

  • The BOSH Director’s CA certificate ([bosh_ca_cert]). This is available on the Tanzu Operations Manager VM at /var/tempest/workspaces/default/root_ca_certificate, or through the Tanzu Operations Manager API. See the Tanzu Operations Manager documentation for information about how to retrieve the Tanzu Operations Manager Root CA.

  • When restoring: A BBR backup artifact from which to restore your Spring Cloud Services installation. The path to this artifact is [path_to_artifact].

Backing up Spring Cloud Services

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

$ 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:

$ 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]