gcp-service-broker

command module
v4.4.0-rc2+incompatible Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 25, 2019 License: Apache-2.0 Imports: 1 Imported by: 0

README

License

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:

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. 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

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.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
brokerapi
pkg
broker/brokerfakes
Code generated by counterfeiter.
Code generated by counterfeiter.
providers/builtin/base/basefakes
Code generated by counterfeiter.
Code generated by counterfeiter.
server/fakes
Code generated by counterfeiter.
Code generated by counterfeiter.
toggles
Package toggles defines a standard way to define, list, and use feature toggles in the service broker.
Package toggles defines a standard way to define, list, and use feature toggles in the service broker.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL