This document contains instructions for deploying the sample service broker to a Cloud Foundry foundation.
All instructions below assume that the commands are being run from the root of the project repository.
These instructions use the cf CLI to interact with a running Cloud Foundry foundation.
Follow the cf documentation to install and verify the CLI.
A Cloud Foundry foundation will be used to deploy the service broker application and register it to the service marketplace. This can be a public hosted Cloud Foundry, a private Cloud Foundry, or a workstation-deployed Cloud Foundry like PCF Dev.
Use the cf CLI to log into Cloud Foundry and target an organization and space for deployment of an application.
The Gradle build file for the service broker sample project can be used to build the application.
$ ./gradlew assemble
Deploy the service broker application to Cloud Foundry:
$ cf push -f deploy/cloudfoundry/manifest.yml
Pushing from manifest to org sample / space test as user@example.com...
Using manifest file deploy/cloudfoundry/manifest.yml
Getting app info...
Creating app with these attributes...
+ name: bookstore-service-broker
path: build/libs/bookstore-service-broker-0.0.1.BUILD-SNAPSHOT.jar
+ memory: 1G
routes:
+ bookstore-service-broker.apps.example.com
...
name: bookstore-service-broker
requested state: started
instances: 1/1
usage: 1G x 1 instances
routes: bookstore-service-broker.apps.example.com
...
state since cpu memory disk details
#0 running 2018-02-13T21:58:44Z 0.0% 290.8M of 1G 144.7M of 1G
Note the value of the route row in the output from the command above.
Use this route to build a URL to access the /v2/catalog endpoint of the service broker application.
$ curl https://bookstore-service-broker.apps.example.com/v2/catalog -u admin:supersecret
{"services":[{"id":"bdb1be2e-360b-495c-8115-d7697f9c6a9e","name":"bookstore","description":"A simple book store service","bindable":true,"plan_updateable":false,"plans":[{"id":"b973fb78-82f3-49ef-9b8b-c1876974a6cd","name":"standard","description":"A simple book store plan","free":true}],"tags":["book-store","books", "sample"]}]}
Now that the application has been deployed and verified, it can be registered to the Cloud Foundry services marketplace.
If you have administrator privileges on Cloud Foundry, you can make the service broker available in all organizations and spaces.
The Open Service Broker API endpoints in the service broker application are secured with a basic auth username and password. Register the service broker using the URL from above and the credentials:
$ cf create-service-broker bookstore admin supersecret https://bookstore-service-broker.apps.example.com Creating service broker bookstore as admin... OK
Make the service offerings from the service broker visible in the services marketplace:
$ cf enable-service-access bookstore Enabling access to all plans of service bookstore for all orgs as admin... OK
If you do not have administrator privileges on Cloud Foundry, you can make the service broker available in a single organization and space that you have privileges in:
$ cf create-service-broker bookstore admin supersecret https://bookstore-service-broker.cfapps.io --space-scoped Creating service broker bookstore in org sample / space test as user@example.com... OK
Show the services marketplace:
$ cf marketplace Getting services from marketplace in org sample / space test as user@example.com... OK service plans description bookstore standard A simple book store service TIP: Use 'cf marketplace -s SERVICE' to view descriptions of individual plans of a given service.
$ cf marketplace -s bookstore Getting service plan information for service bookstore as user@example.com... OK service plan description free or paid standard A simple bookstore plan free
Create an instance of a brokered service from the sample service broker:
$ cf create-service bookstore standard my-bookstore Creating service instance my-bookstore in org sample / space test as user@example.com... OK
Show the details of the created service instance:
$ cf service my-bookstore Showing info of service my-bookstore in org sample / space test as user@example.com... name: my-bookstore service: bookstore bound apps: tags: plan: standard description: A simple bookstore service documentation: dashboard: Showing status of last operation from service my-bookstore... status: create succeeded message: started: 2018-02-13T22:24:21Z updated: 2018-02-13T22:24:21Z
Create a service binding for the service instance:
$ cf create-service-key my-bookstore my-bookstore-binding Creating service key my-bookstore-binding for service instance my-bookstore as user@example.com... OK
Show the details of the created service binding:
$ cf service-key my-bookstore my-bookstore-binding
Getting key my-bookstore-binding for service instance my-bookstore as user@example.com...
{
"password": "b371a19a-cab3-4ee1-9675-6b6cd9493952",
"uri": "https://bookstore-service-broker.apps.example.com/bookstore/ccd45032-5ac9-487a-a37a-506eb65b0cf9",
"username": "55519803-3d8a-4fd4-a17e-e2096ebed9b7"
}
Using the URI and credentials from the service binding, you can access the book store provisioned for the service instance:
# add a book
$ curl https://bookstore-service-broker.apps.example.com/bookstores/ccd45032-5ac9-487a-a37a-506eb65b0cf9/books -u 55519803-3d8a-4fd4-a17e-e2096ebed9b7:b371a19a-cab3-4ee1-9675-6b6cd9493952 -H "Content-Type: application/json" -X PUT -d '{"isbn":"978-1617292545","title":"Spring Boot in Action", "author":"Craig Walls"}'
{"isbn":"978-1617292545","title":"Spring Boot in Action","author":"Craig Walls","links":{...}}%
# add another book
$ curl https://bookstore-service-broker.apps.example.com/bookstores/ccd45032-5ac9-487a-a37a-506eb65b0cf9/books -u 55519803-3d8a-4fd4-a17e-e2096ebed9b7:b371a19a-cab3-4ee1-9675-6b6cd9493952 -H "Content-Type: application/json" -X PUT -d '{"isbn":"978-1784393021","title":"Learning Spring Boot", "author":"Greg L. Turnquist"}'
{"isbn":"978-1784393021","title":"Learning Spring Boot","author":"Greg L. Turnquist","links":{...}}%
# get a list of books
$ curl https://bookstore-service-broker.apps.example.com/bookstores/ccd45032-5ac9-487a-a37a-506eb65b0cf9 -u 55519803-3d8a-4fd4-a17e-e2096ebed9b7:b371a19a-cab3-4ee1-9675-6b6cd9493952 -H "Content-Type: application/json"
{books:[{"isbn":"978-1617292545","title":"Spring Boot in Action","author":"Craig Walls","links":{...}},{"isbn":"978-1784393021","title":"Learning Spring Boot","author":"Greg L. Turnquist","links":{...}},"links":{...}}%
# remove a book
$ curl -k https://bookstore-service-broker.apps.example.com/bookstores/ccd45032-5ac9-487a-a37a-506eb65b0cf9/books/e44db6d7-506a-48e4-9446-44301dd559e6 -u 55519803-3d8a-4fd4-a17e-e2096ebed9b7:b371a19a-cab3-4ee1-9675-6b6cd9493952 -H "Content-Type: application/json" -X DELETE
{"isbn":"978-1617292545","title":"Spring Boot in Action","author":"Craig Walls","links":{...}}%