Skip to content
🐘 an ElephantSQL service broker for ☁️ Cloud Foundry and ⛵️ Kubernetes
Go Makefile
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci add circleci config Sep 28, 2019
_fixtures add service binding tests Sep 29, 2019
api test tiny-turtle provisioning Sep 28, 2019
broker add missing yaml tags to catalog Dec 2, 2019
config add catalog tests Sep 28, 2019
env log broker requests Sep 28, 2019
log add catalog tests Sep 28, 2019
util add catalog tests Sep 28, 2019
vendor go mod vendor Sep 29, 2019
.cfignore remove recordings Sep 29, 2019
.env
.gitignore remove recordings Sep 29, 2019
LICENSE
Makefile refactor makefile Dec 21, 2019
README.md document region parameter Sep 30, 2019
catalog.yml
go.mod go mod vendor Sep 29, 2019
go.sum go mod vendor Sep 29, 2019
main.go display service catalog Sep 27, 2019
manifest.yml

README.md

🐘 elephantsql-broker

CircleCI License Platform

PostgreSQL as a Service

Perfectly configured and optimized PostgreSQL databases ready in 2 minutes.

elephantsql-broker is an ElephantSQL service broker for Cloud Foundry and Kubernetes

Usage

Deploy service broker to Cloud Foundry

  1. create an API key for your ElephantSQL account
  2. pick a Cloud Foundry provider. I'd suggest the Swisscom AppCloud
  3. push the app, providing the API key and a username/password to secure the service broker with
  4. register the service broker in your space (--space-scoped)
  5. check cf marketplace to see your new available service plans

create service broker

Provision new databases

  1. create a new service instance (cf cs)
  2. bind the service instance to your app (cf bs), or create a service key (cf csk)
  3. inspect the service binding/key, have a look at the credentials (cf env/cf sk)
  4. use the given credentials to connect to your new Postgres database
  5. enjoy!

provision service

Default Region

By default the service broker will provision new elephantsql database instances in the configured region BROKER_API_DEFAULT_REGION (see manifest.yml) or if none configured at all it will use azure-arm::westeurope as default value. When issuing service provisioning requests to the service broker it is also possible to provide the region as an additional parameter.

Example:
$ cf create-service elephantsql hippo my-db -c '{"region": "amazon-web-services::eu-west-3"}'
You can’t perform that action at this time.