paas-compose-broker

README

PaaS Compose Service Broker

This is a work-in-progress implementation of a service broker for services provisioned via the Compose API. It is intended to be deployed as a CloudFoundry application.

Deployment

• Use the example catalog:

  cp examples/catalog.json .
  

• Deploy to Cloud Foundry:

  cf push --no-start
  

• Set the required environment variables:

  cf set-env compose-broker USERNAME compose-broker
  cf set-env compose-broker PASSWORD unguessable
  

• Start the app:

  cf start compose-broker
  

• Check the catalog endpoint:

  curl -k -u compose-broker:unguessable https://compose-broker.${DEPLOY_ENV}.cloudfoundry-apps-domain.example.com/v2/catalog
  

• Register the service:

   cf update-service-broker compose-broker compose-broker "$COMPOSE_BROKER_PASS" "https://compose-broker.${APPS_DNS_ZONE_NAME}"
  

• Enable the service:

  cf enable-service-access mongodb
  

Environmental variables

USERNAME - broker user name used for basic authentication PASSWORD - username password DB_PREFIX - a prefix that can be used to tag instances. Defaults to compose-broker CLUSTER_NAME - a name of your enterprise cluster if you've got one and want to use it. Defaults to hosted compose COMPOSE_API_KEY - your API key for Compose.

Running tests

Prerequisites:

• Ginkgo version >= 1.4.0
• An API key for Compose if running the full tests.

To run all tests (including integration tests):

COMPOSE_API_KEY=<key> ./scripts/run-all-tests.sh

To only run the unit tests you will need to use Docker for Mac for the database engine suite:

The local test script handles pulling in the required docker containers and then cleans them up afterwards

To run the tests execute either;

./scripts/run-local-tests.sh

or;

make unit