Cloud Foundry service broker for Google Cloud Platform services
Clone or download
Permalink
Failed to load latest commit information.
brokerapi/brokers don't use panics as flow-control (#282) Sep 17, 2018
ci ci: revert tile-generator version per pivotal advice Sep 4, 2018
cmd Legacy Plan Support (#281) Sep 19, 2018
db_service Legacy Plan Support (#281) Sep 19, 2018
docs Legacy Plan Support (#281) Sep 19, 2018
examples fix go_vet, ineffassign, and misspell errors (#272) Aug 30, 2018
fakes Removed legacy integration tests (#283) Sep 18, 2018
pkg Legacy Plan Support (#281) Sep 19, 2018
utils added label support for bigquery, cloudsql, spanner and gcs (#276) Sep 11, 2018
vendor updated dependencies to be open Aug 31, 2018
.cfignore added cfignore to cut down on the amount uploaded when using the serv… Nov 18, 2016
.gitignore updated docs for 4.0 release Aug 17, 2018
AUTHORS initial commit Sep 21, 2016
CHANGELOG.md Legacy Plan Support (#281) Sep 19, 2018
CONTRIBUTING.md updated docs for inconsistencies Aug 20, 2018
Gopkg.lock updated dependencies to be open Aug 31, 2018
Gopkg.toml updated dependencies to be open Aug 31, 2018
LICENSE initial commit Sep 21, 2016
NOTICE adding notice file Oct 3, 2016
OSDF-4.0.0.txt updated the docs with the OSDF generation process Aug 17, 2018
Procfile initial commit Sep 21, 2016
README.md fixed upgrading link (#285) Sep 19, 2018
TESTING.md Removed legacy integration tests (#283) Sep 18, 2018
gcp_logo.png initial develop commit, including tests, tile file, documentation, an… Sep 26, 2016
main.go fixed copyright headers #229 Aug 14, 2018
manifest.yml tile: set GOVERSION=1.10 Sep 5, 2018
missing-properties.yml initial develop commit, including tests, tile file, documentation, an… Sep 26, 2016
tile.yml Legacy Plan Support (#281) Sep 19, 2018

README.md

Go Report Card License

Cloud Foundry Service Broker for Google Cloud Platform

This is a service broker built to be used with Cloud Foundry. 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:

Installation

This application can be installed as either a PCF Ops Man Tile or deployed as a PCF 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. See the examples folder to understand how to use services once they are created and bound.

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.
  • migrate - Upgrade your database (you generally won't need this because the databases auto-upgrade).
  • plan-info - Dump plan information from the database.
  • serve - Start the service broker.
  • show - Show info about the provisioned resources.

Testing

Production testing for the GCP Service Broker is administered via a private Concourse pipeline.

To run tests locally, use Ginkgo.

Integration tests require the ROOT_SERVICE_ACCOUNT_JSON environment variable to be set.

Note: Integration tests create and destroy real project resources and therefore have associated costs to run

Support

File a GitHub issue for functional issues or feature requests.

Subscribe to the gcp-service-broker Google group for discussions and updates.

Contributing

See the contributing file for more information.

This is not an officially supported Google product.