Skip to content

Latest commit

 

History

History
70 lines (43 loc) · 2.34 KB

README.md

File metadata and controls

70 lines (43 loc) · 2.34 KB
Raw

csb-brokerpak-gcp

A brokerpak for the Cloud Service Broker that provides support for GCP services.

Development Requirements

  • Either an up-to-date version of Go or Docker
  • make - covers development lifecycle steps

GCP account information

To provision services, the brokerpak currently requires GCP credentials. The brokerpak expects them in environment variables:

  • GOOGLE_CREDENTIALS
  • GOOGLE_PROJECT

Development Tools

A Makefile supports the full local development lifecycle for the brokerpak.

The make targets can be run either with Docker or installing the required libraries in the local OS.

Available make targets can be listed by running make.

Running with docker

  1. Install Docker
  2. Launch an interactive shell into some supported image containing all necessary tools. For example: 
    # From the root of this repo run:
docker run -it --rm -v "${PWD}:/repo" --workdir "/repo" --entrypoint "/bin/bash" golang:latest
make

Running with Go

  1. Make sure you have the right Go version installed (see go.mod file).

The make targets will build the source using the local go installation.

Other targets

There is a make target to push the broker and brokerpak into a CloudFoundry foundation. It will be necessary to manually configure a few items for the broker to work.

  • make push-broker will cf push the broker into CloudFoundry. Requires the cf cli to be installed.
  • make run-integration-tests will test the brokerpak with the latest version of CSB

The broker gets pushed into CloudFoundry as cloud-service-broker-gcp It will be necessary to bind a MySQL database to the broker to provide broker state storage. See GCP Installation docs for more info.

Broker

The version of Cloud Service Broker to use with this brokerpak is encoded in the go.mod file. The make targets will use this version by default.

Tests

Example tests

Services definitions declare examples for each plan they provide. Those examples are then run through the whole cycle of provision, bind, unbind, and delete when running

terminal 1
>> make run

terminal 2
>> make run-examples

Acceptance tests

See acceptance tests