image:https://img.shields.io/gitter/room/spring-cloud-app-broker/community.svg?style=flat-square["Gitter", link="https://gitter.im/spring-cloud-app-broker/community"]

== Spring Cloud App Broker

Spring Cloud App Broker is a framework for building Spring Boot applications that implement the Open Service Broker API to deploy applications to a platform.

The Open Service Broker API project allows developers to deliver services to applications running within cloud native platforms such as Cloud Foundry, Kubernetes, and OpenShift.
Spring Cloud App Broker provides a framework based on Spring Boot that enables you to quickly create a service broker that deploys applications and services to the platform when managed services are provisioned.

Currently, Cloud Foundry is supported as a target platform for service instance backing applications and services.

=== Getting Started

See the https://spring.io/projects/spring-cloud-app-broker/[project site] and https://docs.spring.io/spring-cloud-app-broker/docs/current/reference/[reference documentation] to get started building a service broker using this framework.

Take a look at this https://spring.io/blog/2019/05/30/introducing-spring-cloud-app-broker[introduction blog post] and to our https://github.com/spring-cloud-samples/spring-cloud-app-broker-samples[sample apps].

Join us in our gitter channel: https://gitter.im/spring-cloud-app-broker/community

=== Compatibility

==== 2.3.x

* https://projects.spring.io/spring-framework/[Spring Framework] 6.2.x
* https://projects.spring.io/spring-boot/[Spring Boot] 3.3.x
* https://github.com/cloudfoundry/cf-java-client/[Cloud Foundry Java Client] 5.x
* https://github.com/reactor/[Reactor] 2023.0.0
* https://spring.io/projects/spring-cloud-open-service-broker/[Spring Cloud Open Service Broker] 4.3.x
* https://github.com/openservicebrokerapi/servicebroker/tree/v2.16/[Open Service Broker API] 2.16

==== 2.2.x

* https://projects.spring.io/spring-framework/[Spring Framework] 6.1.x
* https://projects.spring.io/spring-boot/[Spring Boot] 3.2.x
* https://github.com/cloudfoundry/cf-java-client/[Cloud Foundry Java Client] 5.x
* https://github.com/reactor/[Reactor] 2023.0.0
* https://spring.io/projects/spring-cloud-open-service-broker/[Spring Cloud Open Service Broker] 4.2.x
* https://github.com/openservicebrokerapi/servicebroker/tree/v2.16/[Open Service Broker API] 2.16

==== 2.1.x

* https://projects.spring.io/spring-framework/[Spring Framework] 6.0.x
* https://projects.spring.io/spring-boot/[Spring Boot] 3.1.x
* https://github.com/cloudfoundry/cf-java-client/[Cloud Foundry Java Client] 5.x
* https://github.com/reactor/[Reactor] 2022.0.0
* https://spring.io/projects/spring-cloud-open-service-broker/[Spring Cloud Open Service Broker] 4.1.x
* https://github.com/openservicebrokerapi/servicebroker/tree/v2.16/[Open Service Broker API] 2.16

==== 2.0.x

* https://projects.spring.io/spring-framework/[Spring Framework] 6.0.x
* https://projects.spring.io/spring-boot/[Spring Boot] 3.0.x
* https://github.com/cloudfoundry/cf-java-client/[Cloud Foundry Java Client] 5.x
* https://github.com/reactor/[Reactor] 2022.0.0
* https://spring.io/projects/spring-cloud-open-service-broker/[Spring Cloud Open Service Broker] 4.0.x
* https://github.com/openservicebrokerapi/servicebroker/tree/v2.16/[Open Service Broker API] 2.16

==== 1.6.x

* https://projects.spring.io/spring-framework/[Spring Framework] 5.3.x
* https://projects.spring.io/spring-boot/[Spring Boot] 2.7.x
* https://github.com/cloudfoundry/cf-java-client/[Cloud Foundry Java Client] 5.x
* https://github.com/reactor/[Reactor] 3.4.x
* https://spring.io/projects/spring-cloud-open-service-broker/[Spring Cloud Open Service Broker] 3.6.x
* https://github.com/openservicebrokerapi/servicebroker/tree/v2.16/[Open Service Broker API] 2.16

=== End-of-Support

==== 1.5.x

* https://projects.spring.io/spring-framework/[Spring Framework] 5.3.x
* https://projects.spring.io/spring-boot/[Spring Boot] 2.6.x
* https://github.com/cloudfoundry/cf-java-client/[Cloud Foundry Java Client] 5.x
* https://github.com/reactor/[Reactor] 3.4.x
* https://spring.io/projects/spring-cloud-open-service-broker/[Spring Cloud Open Service Broker] 3.5.x
* https://github.com/openservicebrokerapi/servicebroker/tree/v2.16/[Open Service Broker API] 2.16

==== 1.4.x

* https://projects.spring.io/spring-framework/[Spring Framework] 5.3.x
* https://projects.spring.io/spring-boot/[Spring Boot] 2.5.x
* https://github.com/cloudfoundry/cf-java-client/[Cloud Foundry Java Client] 5.x
* https://github.com/reactor/[Reactor] 3.4.x
* https://spring.io/projects/spring-cloud-open-service-broker/[Spring Cloud Open Service Broker] 3.4.x
* https://github.com/openservicebrokerapi/servicebroker/tree/v2.16/[Open Service Broker API] 2.16

==== 1.3.x

* https://projects.spring.io/spring-framework/[Spring Framework] 5.3.x
* https://projects.spring.io/spring-boot/[Spring Boot] 2.4.x
* https://github.com/cloudfoundry/cf-java-client/[Cloud Foundry Java Client] 5.x
* https://github.com/reactor/[Reactor] 3.4.x
* https://spring.io/projects/spring-cloud-open-service-broker/[Spring Cloud Open Service Broker] 3.3.x
* https://github.com/openservicebrokerapi/servicebroker/tree/v2.15/[Open Service Broker API] 2.15

==== 1.2.x

* https://projects.spring.io/spring-framework/[Spring Framework] 5.2.x
* https://projects.spring.io/spring-boot/[Spring Boot] 2.3.x
* https://github.com/cloudfoundry/cf-java-client/[Cloud Foundry Java Client] 4.x
* https://github.com/reactor/[Reactor] 3.3.x
* https://spring.io/projects/spring-cloud-open-service-broker/[Spring Cloud Open Service Broker] 3.3.x
* https://github.com/openservicebrokerapi/servicebroker/tree/v2.15/[Open Service Broker API] 2.15

==== 1.1.x

* https://projects.spring.io/spring-framework/[Spring Framework] 5.2.x
* https://projects.spring.io/spring-boot/[Spring Boot] 2.2.x
* https://github.com/cloudfoundry/cf-java-client/[Cloud Foundry Java Client] 4.x
* https://github.com/reactor/[Reactor] 3.3.x
* https://spring.io/projects/spring-cloud-open-service-broker/[Spring Cloud Open Service Broker] 3.1.x
* https://github.com/openservicebrokerapi/servicebroker/tree/v2.15/[Open Service Broker API] 2.15

==== 1.0.x

* https://projects.spring.io/spring-framework/[Spring Framework] 5.1.x
* https://projects.spring.io/spring-boot/[Spring Boot] 2.1.x
* https://github.com/cloudfoundry/cf-java-client/[Cloud Foundry Java Client] 3.x
* https://github.com/reactor/[Reactor] 3.2.x
* https://spring.io/projects/spring-cloud-open-service-broker/[Spring Cloud Open Service Broker] 3.0.x
* https://github.com/openservicebrokerapi/servicebroker/tree/v2.14/[Open Service Broker API] 2.14

=== Build

This project requires Java 17 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.

==== Compile the project and run tests

    ./gradlew build