Couchbase 4.6.x Service Broker for Pivotal Cloud Foundry

The following example is a PCF 2.0 Service Broker written as a Spring Boot application. This is just an example and should be evolved to match a production type setup in terms of bucket creation and access for created service instances.

Install

Clone as follows

git clone https://github.com/papicella/couchbase-service-broker.git

Edit src/main/resources/application.yml to provide bucket details and a main Administrator username/password. The "security." properties use Spring Security BASIC HTTP Authentication to protect the service broker application endpoints

couchbase:
  host: pas-macbook.local
  bucketName: default
  bucketPassword:
  clusterAdminUser: Administrator
  clusterAdminPassword: welcome1
security:
  user:
    name: user
    password: password

Package as shown below

$ mvn -DskipTests=true package

...

[INFO] --- maven-jar-plugin:2.6:jar (default-jar) @ couchdb-service-broker ---
[INFO] Building jar: /Users/pasapicella/pivotal/DemoProjects/spring-starter/pivotal/couchdb-service-broker/target/couchdb-service-broker-0.0.1-SNAPSHOT.jar
[INFO]

Push to CF as follows

$ cf push couchbase-service-broker-pas -p ./target/couchdb-service-broker-0.0.1-SNAPSHOT.jar -m 1g

...

Successfully destroyed container

0 of 1 instances running, 1 starting
1 of 1 instances running

App started

OK

...

     state     since                    cpu    memory         disk             details
#0   running   2017-08-29 11:21:07 PM   7.8%   545.5M of 1G   146.5M of 512M

View pushed application

pasapicella@pas-macbook:~$ cf apps
Getting apps in org pcfdev-org / space pcfdev-space as admin...
OK

name                           requested state   instances   memory   disk   urls
pas-springboot-pcf             started           1/1         756M     512M   pas-springboot-pcf-enharmonic-iceman.local.pcfdev.io
couchbase-service-broker-pas   started           1/1         1G       512M   couchbase-service-broker-pas.local.pcfdev.io

Create a service broker

pasapicella@pas-macbook:~$ cf create-service-broker couchbase user password http://couchbase-service-broker-pas.local.pcfdev.io
Creating service broker couchbase as admin...
OK

View service brokers to ensure it now exists

pasapicella@pas-macbook:~$ cf service-brokers
Getting service brokers as admin...

name           url
couchbase      http://couchbase-service-broker-pas.local.pcfdev.io
local-volume   http://localbroker.local.pcfdev.io
mongodb        http://mongodb-service-broker.local.pcfdev.io
p-mysql        http://mysql-broker.local.pcfdev.io
p-rabbitmq     http://rabbitmq-broker.local.pcfdev.io
p-redis        http://redis-broker.local.pcfdev.io

Enable the service broker

pasapicella@pas-macbook:~$ cf enable-service-access couchbase
Enabling access to all plans of service couchbase for all orgs as admin...
OK

Log into Application Manager UI and verify service appears in Market Place

alt tag alt tag alt tag

View marketplace from command line

pasapicella@pas-macbook:~/apps/pcf-dev$ cf marketplace
Getting services from marketplace in org pcfdev-org / space pcfdev-space as admin...
OK

service        plans             description
couchbase      default*          A simple Couchbase service broker implementation
local-volume   free-local-disk   Local service docs: https://github.com/cloudfoundry-incubator/local-volume-release/
mongodb        default*          A simple MongoDB service broker implementation
p-mysql        512mb, 1gb        MySQL databases on demand
p-rabbitmq     standard          RabbitMQ is a robust and scalable high-performance multi-protocol messaging broker.
p-redis        shared-vm         Redis service to provide a key-value store

Create a service from the command line as follows

pasapicella@pas-macbook:~/apps/pcf-dev$ cf create-service couchbase default couchbase-service
Creating service instance couchbase-service in org pcfdev-org / space pcfdev-space as admin...
OK

Attention: The plan `default` of service `couchbase` is not free.  The instance `couchbase-service` will incur a cost.  Contact your administrator if you think this is in error.

View services

pasapicella@pas-macbook:~/apps/pcf-dev$ cf services
Getting services in org pcfdev-org / space pcfdev-space as admin...
OK

name                service     plan      bound apps           last operation
pas-mysql           p-mysql     512mb     pas-springboot-pcf   create succeeded
mymongodb           mongodb     default                        delete failed
couchbase-service   couchbase   default                        create succeeded

Verify through Couchbase console a new bucket has been created

alt tag

Bind service to an application

pasapicella@pas-macbook:~/apps/pcf-dev$ cf bind-service pas-springboot-pcf couchbase-service
Binding service couchbase-service to app pas-springboot-pcf in org pcfdev-org / space pcfdev-space as admin...
OK
TIP: Use 'cf restage pas-springboot-pcf' to ensure your env variable changes take effect

Verify bound sercice injects bucket and password details into VCAP_SERVICES

pasapicella@pas-macbook:~/apps/pcf-dev$ cf env pas-springboot-pcf
Getting env variables for app pas-springboot-pcf in org pcfdev-org / space pcfdev-space as admin...
OK

System-Provided:
{
 "VCAP_SERVICES": {
  "couchbase": [
   {
    "credentials": {
     "bucketName": "8301d536-771f-4e3b-a63d-b2fe8e95a0de",
     "password": "szBgpmyj0lUKW7x",
     "uri": "couchbase://pas-macbook.local/8301d536-771f-4e3b-a63d-b2fe8e95a0de"
    },
    "label": "couchbase",
    "name": "couchbase-service",
    "plan": "default",
    "provider": null,
    "syslog_drain_url": null,
    "tags": [
     "couchbase",
     "document"
    ],
    "volume_mounts": []
   }
  ],

Unbind the service

pasapicella@pas-macbook:~/apps/pcf-dev$ cf unbind-service pas-springboot-pcf couchbase-service
Unbinding app pas-springboot-pcf from service couchbase-service in org pcfdev-org / space pcfdev-space as admin...
OK

Pas Apicella [papicella at pivotal.io] is a Senior Platform Architect at Pivotal Australia

papicella / couchbase-service-broker

readme

Couchbase 4.6.x Service Broker for Pivotal Cloud Foundry

Install