Page last updated:
This topic provides an overview of services in Cloud Foundry Application Runtime.
CF offers a marketplace of services that operators can use to provision reserved resources on demand. Marketplace services include resources such as databases on a shared or dedicated server, or accounts on a SaaS app. These resources are known as service instances and the systems that deliver and operate these resources are known as services.
For a service to be available in the Marketplace, an operator must integrate the service with CF using APIs.
For more information about provisioning service instances and other lifecycle operations, see Managing Service Instances.
CF enables users to use services that are not available in the Marketplace using user-provided service instances (UPSI). For more information, see User-Provided Service Instances.
Services are integrated with CF by using a documented API for which the Cloud Controller is the client, called the Service Broker API. This should not be confused with the Cloud Controller API (CAPI), often used to refer to the version of Cloud Foundry. The Service Broker API is versioned independently of CAPI.
The component of the service that uses the Service Broker API is called the service broker. This component was formerly referred to as a service gateway. However, as traffic between apps and services does not flow through the service broker, the term caused confusion. Although “gateway” still appears in old code, the term “broker” is used in conversation, in new code, and in documentation.
Service brokers advertise a catalog of service offerings and service plans, as well as interpreting calls for provision, bind, unbind, and deprovision. What a broker does with each call can vary between services. In general, ‘provision’ reserves resources on a service and 'bind’ delivers information to an app necessary for accessing the resource. The reserved resource is called a service instance. What a service instance represents can vary by service. It could be a single database on a multi-tenant server, a dedicated cluster, or even just an account on a web app.
CF enables users to provision credentials needed to interface with a service instance. You can use app binding to automatically deliver these credentials to your CF app. For external and local clients, you can use service keys to generate credentials to communicate directly with a service instance.
Service instance credentials can be delivered automatically to apps running on CF in an environment variable. For more information, see Delivering Service Credentials to an App.
For information about binding to a specific app development framework, see .
Credentials managed manually are known as service keys. Use service keys when you want a set of credentials for use by clients other than the app in the same space. For instance, you can use service keys to connect to a service instance from a local client, or from an app in another space, or even from outside of CF.
For more information about creating a user-provided service instance with service keys, see the User-Provided Service Instances topic. For more information about service keys, see the Managing Service Keys topic.
Note: Not all services support service keys. Some services support credentials through app binding only.
How a service is implemented is up to the service provider or developer. CF only requires that the service provider implement the Service Broker API. A broker can be implemented as a separate app, or by adding the required HTTP endpoints to an existing service.
Because CF only requires that a service implements the Service Broker API to be available to CF end users, many deployment models are possible. The following are examples of valid deployment models:
- Entire service packaged and deployed by BOSH alongside CF
- Service broker packaged and deployed by BOSH alongside CF, rest of the service deployed and maintained by other means
- Broker (and optionally service) pushed as an app to CF user space
- Entire service, including broker, deployed and maintained outside of CF by other means
To allow an app to communicate with a service external to CF, you might need to configure the service to accept connections from your app based on its outbound IP address.
In your external service configuration, you must do one of the following:
- Add the entire IP address range for the Diego Cell where the app is deployed to your allow list.
- Derive the app IP address from its DNS name using a command-line tool such as
nslookup. In your external service configuration, add the IP address or range of the app instance to your allow list.
To learn how your app logs can be streamed to third-party log management services, see Streaming App Logs to Log Management Services.
User-provided service instances can be used to drain app logs to a service not available in the Marketplace. This is also known as setting up a syslog drain. For guidance on configuring some third-party log management services, see Service-Specific Instructions for Streaming App Logs.
To learn how Marketplace services (and user-provided service instances) can be used to perform preprocessing on app requests, see Managing App Requests with Route Services.
If your app relies on a relational database, you must apply schema changes periodically. To perform database schema migrations on CF-managed services, run a database migration task with the CF Command Line Interface (cf CLI) tool.
For more information about running cf CLI tasks, see Running Tasks.
Note: To run tasks with the cf CLI, you must install cf CLI v6.23.0 or later. For information about downloading, installing, and uninstalling the cf CLI, see .
To perform a database schema migration with the cf CLI:
- Push the app:
$ cf push APP-NAME
APP-NAME is the name of the app.
Note: To run a task without starting the app, push the app with
cf push -i 0 and then run the task. You can run the app later by scaling up its instance count.
- Perform a database schema migration as a task on the app:
$ cf run-task APP-NAME --command "bin/rails db:migrate" --name TASK-NAME Creating task for app APP-NAME in org jdoe-org / space development as firstname.lastname@example.org... OK Task 1 has been submitted successfully for execution.
APP-NAME is the name of the app.
TASK-NAME is the name of the task.