= Overview
This project implements a sample service broker that adheres to the https://www.openservicebrokerapi.org/[Open Service Broker API] using the https://cloud.spring.io/spring-cloud-open-service-broker/[Spring Cloud Open Service Broker] framework. It can be deployed to either Cloud Foundry or Kubernetes, and can be registered as a service broker to either platform.
== Compatibility
Branches:
== Getting Started
This service broker manages instances of a bookstore service.
When a service instance is https://github.com/openservicebrokerapi/servicebroker/blob/v2.15/spec.md#provisioning[provisioned], a new data structure is allocated in memory.
When a https://github.com/openservicebrokerapi/servicebroker/blob/v2.15/spec.md#credentials[service binding] is created, a URL and basic auth credentials are provided in the binding credentials. The bookstore URL and credentials can be used to add, retrieve, delete, and list books in the bookstore. Unique credentials are generated for each service binding.
See the blog post https://spring.io/blog/2020/01/14/reactive-bookstore-service-broker[Reactive BookStore Service Broker] for more information about the architecture and integration of other Spring projects within this sample app.
== Build
This project requires Java 8 at a minimum.
The project is built with Gradle. The https://docs.gradle.org/current/userguide/gradle_wrapper.html[Gradle wrapper] allows you to build the project on multiple platforms and even if you do not have Gradle installed; run it in place of the gradle command (as ./gradlew) from the root of the main project directory.
=== To compile the project and run tests
./gradlew build== Deploy
Once the project is built, it can be deployed and registered to either Cloud Foundry or Kubernetes.