Open Service Broker for Cloud Platform (GCP, Azure, AWS)

This is a service broker built to be used with Cloud Foundry and Kubernetes. It adheres to the Open Service Broker API v2.13.

Service brokers provide a consistent way to create resources and accounts that can access those resources across a variety of different services.

The service broker uses Terraform to provision services.

The service broker provides support for:

GCP	Azure	AWS
GCP Cloud SQL (MySQL)	Azure Database for MySQL	Amazon RDS for MySQL
GCP Memorystore for Redis	Azure Cache for Redis
	MongoDB for CosmosDB
	Azure SQL
	Azure SQL Failover Groups
	Azure Eventhubs

Installation

This service broker can be installed as a CF application. See the instructions for Azure for a detailed walkthrough.

Usage

For operators: see docs/configuration.md for details about configuring the service broker.

For developers: see docs/use.md for service options and details.

You can get documentation specific to your install from the /docs endpoint of your deployment.

Commands

The service broker can be run as both a server (the service broker) and as a general purpose command line utility. It supports the following sub-commands:

• client - A CLI client for the service broker.
• config - Show and merge configuration options together.
• generate - Generate documentation and tiles.
• help - Help about any command.
• serve - Start the service broker.

Development

make is used to orchestrate most development tasks. golang 1.14 is required to build the broker. If you don't have golang installed, it is possible to use a docker image to build and unit test the broker. If the environment variable USE_GO_CONTAINERS exists, make will use docker versions of the tools so you don't need to have them installed locally.

There are make targets for most common dev tasks.

command	action
make build	builds broker into ./build
make test-units	runs unit tests
make run-broker-gcp	builds broker and broker pak and starts broker for gcp
make run-broker-azure	builds broker and broker pak and starts broker for azure
make run-broker-aws	builds broker and broker pak and starts broker for aws
make test-acceptance	runs broker client run-examples tests
make clean	removes binaries and built broker paks
make push-broker-gcp	will push and register the broker in PAS for GCP
make push-broker-azure	will push and register the broker in PAS for Azure

Support

File a GitHub issue for functional issues or feature requests.

Contributing

See the contributing file for more information.

This is not an officially supported VMware product.