vmware-archive / simple-service-broker

Simplest service broker
Apache License 2.0
11 stars 7 forks source link

simple-service-broker is no longer actively maintained by VMware.

simple-service-broker


NOTE

Outdated superceeded by newer tooling such as Spring App Broker which provides a framework for building service brokers by using the Spring Cloud Open Service Broker API.

Some other Java based examples are:

simple-service-broker was created based on feedback from Pivotal partners who wanted to focus less on "the plumbing," and more on functionality in direct support of their products' unique capabilities.

The project is made up of several modules, each with individual READMEs that explain things in more detail:

simple-broker

This is where the main library classes exist. The rest of the modules are examples that show how to use these classes to create a service broker.

sample-broker

An example broker that uses the simple-broker for demonstration purposes. This module could be used as a starting point for your custom broker.

sample-service

An very simple demo back-end for the broker to talk to.

sample-connector

An example spring cloud service connector that vastly simplifies the use of a brokered service. This is an optional feature that service broker providers can create for users of their services.

sample-client

An example spring boot app that uses the sample-broker provided service, via the sample-connector.

The Demo

Together, the sample projects can be used to demo the sample-broker, and as a template for a fully functional demo of a custom service broker. Heck, why not also re-purpose the READMEs to help document your broker?

To deploy and run the samples as a group, follow this order (details in the individual project READMEs):

  1. git clone the simple-service-broker project
  2. mvn install the simple-service-broker
  3. cf push the sample-service
  4. cf push, register, and enable the sample-broker
  5. cf push the sample-client

Create a tile for your broker

For instructions on how to create an Ops Manager tile for your broker in the sample-broker README.