On-Demand Services SDK v0.21

On-Demand Services SDK

This guide is intended for people who want to author service tiles for Pivotal Cloud Foundry (PCF) using the on-demand services SDK, part of the Pivotal Cloud Foundry Services SDK.


PCF operators make software services such as databases available to developers by using the Ops Manager Installation Dashboard to install service tiles. Before BOSH 2.0, operators configured a service tile by pre-assigning a block of VMs with fixed CPU, hard disk, and RAM levels to allocate as instances for each service. This limited the possible number of instances and demanded wasteful one-size-fits-all resource provisioning.

On-demand services let you provision instances with more flexibility. The operator does not pre-allocate a block of VMs for the instance pool, and they can specify an allowable range rather than fixed settings for instance resource levels. When a developer creates an on-demand service instance, they then provision it at creation time.

The on-demand services SDK simplifies broker and tile authoring, and is the standard approach for both Pivotal internal services teams and Pivotal partner independent software vendors (ISVs) to develop on-demand services for PCF.

The About the On-Demand Services SDK topic describes in greater detail how the on-demand broker works within PCF.

Product Snapshot

The following table provides version and version-support information about the on-demand services SDK.

Element Details
Version 0.21.1
Release date April 23, 2018
Compatible Ops Manager version(s) v1.11, v1.12, v2.0, and v2.1
Compatible Elastic Runtime* version(s) v1.11 and v1.12
Compatible Pivotal Application Service (PAS)* version(s) v2.0 and v2.1
IaaS support AWS, Azure, GCP, OpenStack, and vSphere

* As of PCF v2.0, Elastic Runtime is renamed Pivotal Application Service (PAS). For more information, see Pivotal Application Service (PAS) Highlights.

Key Features

The benefits of provisioning IaaS resources on-demand are:

  • Scale resource consumption linearly with need, without having to plan for pre-provisioning.
  • App developers get more control over resources, and do not have to do acquire them through the operator.

The benefits of using ODB to develop on-demand services are:

  • ODB reduces the amount of code service developers have to write by abstracting away functionality common to most single-tenant on-demand service brokers.
  • ODB uses BOSH to deploy service instances, so anything that is BOSH-deployable can integrate with Cloud Foundry’s services marketplace.

ODB uses the following BOSH features:

  • Dynamic IP management
  • Availability zones
  • Globally-defined resources (Cloud Config). This results in manifests that are portable across BOSH CPIs, and are substantially smaller than old-style manifests.
  • Links between deployed BOSH instances consuming information, e.g. IP addresses, of other instances.

Prerequisites for deploying brokers that use ODB

Minimum versions of Cloud Foundry and BOSH are described in the operator section.

Create a pull request or raise an issue on the source for this page in GitHub