Need help with spring-cloud-open-service-broker?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

147 Stars 108 Forks Apache License 2.0 618 Commits 8 Opened issues


Spring Cloud project for creating service brokers that conform to the Open Server Broker API specification

Services available


Need anything else?

Contributors list

image:["GitHub Actions", link=""]

= Overview

Spring Cloud Open Service Broker is a framework for building[Spring Boot] applications that implement the[Open Service Broker API].

[NOTE] This project was formerly named Spring Cloud - Cloud Foundry Service Broker. View the[1.0.x] branch of this repository for information on using the released versions of the project with artifacts using that name.

== Version Compatibility

The following table describes the version compatibility matrix for the various releases of Spring Cloud Open Service Broker.

[%header,cols=4*] |=== |Spring Cloud Open Service Broker |[Open Service Broker API] |[Spring Boot] |[Spring Framework] |3.4.x |2.16 |2.5.x |5.3.x |3.3.x |2.15 |2.4.x |5.3.x |3.2.x |2.15 |2.3.x |5.2.x |3.1.x |2.15 |2.2.x |5.2.x |3.0.x |2.14 |2.1.x |5.1.x |2.1.x |2.14 |2.0.x |5.0.x |===

[NOTE] Spring WebFlux and Spring MVC are both supported in version 3.0 and later

== Getting Started

See the[project site] and[reference documentation] to get started building a service broker using this framework.

=== Gradle Dependencies


=== Maven Dependencies:

See the[migration guide] if you are migrating a project from

Spring Cloud - Cloud Foundry Service Broker
1.x to
Spring Cloud Open Service Broker

== Build

This project requires Java 8.

The project is built with Gradle. The[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

command (as
) from the root of the main project directory.

=== Compile the project and run tests

./gradlew build

Deploy the artifacts to your local maven repository:

./gradlew publishToMavenLocal

Perform all checks, including checkstyle, pmd, unit tests, and contract tests:

./gradlew check

Run only unit tests:

./gradlew test

Run only contract tests:

./gradlew contractTest

== Working with the code If you don't have an IDE preference we would recommend that you use[Spring Tool Suite] or[Eclipse] when working with the code. We use the[m2eclipse] eclipse plugin for maven support. Other IDEs and tools should also work without issue as long as they use Maven 3.3.3 or better.

== Contributing

Spring Cloud is released under the non-restrictive Apache 2.0 license, and follows a very standard Github development process, using Github tracker for issues and merging pull requests into master. If you want to contribute even something trivial please do not hesitate, but follow the guidelines below.

=== Sign the Contributor License Agreement Before we accept a non-trivial patch or pull request we will need you to sign the[Contributor License Agreement]. Signing the contributor's agreement does not grant anyone commit rights to the main repository, but it does mean that we can accept your contributions, and you will get an author credit if we do. Active contributors might be asked to join the core team, and given the ability to merge pull requests.

=== Code of Conduct This project adheres to the Contributor Covenant link:/CODEOFCONDUCT.adoc[code of conduct]. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected]

=== Code Conventions and Housekeeping None of these is essential for a pull request, but they will all help. They can also be added after the original pull request but before a merge.

  • Use the Spring Framework code format conventions. If you use Eclipse you can import formatter settings using the
    file from the[Spring Cloud Build] project. If using IntelliJ, you can use the[Eclipse Code Formatter Plugin] to import the same file.
  • Make sure all new
    files to have a simple Javadoc class comment with at least an
    tag identifying you, and preferably at least a paragraph on what the class is for.
  • Add the ASF license header comment to all new
    files (copy from existing files in the project)
  • Add yourself as an
    to the .java files that you modify substantially (more than cosmetic changes).
  • Add some Javadocs and, if you change the namespace, some XSD doc elements.
  • A few unit tests would help a lot as well -- someone has to do it.
  • If no-one else is using your branch, please rebase it against the current master (or other target branch in the main project).
  • When writing a commit message please follow[these conventions], if you are fixing an existing issue please add
    Fixes #XXXX
    at the end of the commit message (where XXXX is the GitHub issue number).

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.