gcp-service-broker

README

Open Service Broker for Google Cloud Platform

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 GCP Service Broker provides support for:

• BigQuery
• Bigtable
• Cloud SQL
• Cloud Storage
• Dataflow (preview)
• Dataproc (preview)
• Datastore
• Dialogflow (preview)
• Firestore (preview)
• Memorystore for Redis (preview)
• ML APIs
• PubSub
• Spanner
• Stackdriver Debugger
• Stackdriver Monitoring (preview)
• Stackdriver Trace
• Stackdriver Profiler

Installation

This application can be installed as either a Tanzu Ops Man Tile or deployed as a Cloud Foundry application. See the installation instructions for a more detailed walkthrough.

Upgrading

If you're upgrading, check the upgrade guide.

Usage

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

For developers: see docs/use.md for information about creating and binding specific GCP services with the broker. Complete Spring Boot sample applications which use services can be found in the service-broker-samples repository.

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.

Testing

Pull requests are unit-tested with Travis. You can run the same tests Travis does using go test ./....

Integration tests are run on a private Concourse pipeline for all changes to the master branch. You can set up your own pipeline using the sources in the ci directory if you like.

Support

This is not an officially supported Google product.

File a GitHub issue for functional issues or feature requests and use GitHub's notification settings to watch the repository for new releases.

Contributing

See the contributing file for more information.