Apigee Edge Service Broker for Pivotal Cloud Foundry

Page last updated:

This documentation describes the Apigee Edge Service Broker for Pivotal Cloud Foundry (PCF). The Apigee Edge Service Broker for PCF enables developers to proxy APIs for their PCF apps.

Overview

The Apigee Edge Service Broker for PCF registers a service broker with PCF and exposes its service plans on the Marketplace. Using the service broker, you can create service plan instances using Apps Manager or the Cloud Foundry Command Line Interface (cf CLI) and bind them to their apps. Creating an Apigee service instance and binding it to an app creates an API proxy that handles requests for the PCF app.

Through the service broker, you can proxy calls to your PCF app with one of two varieties of Apigee Edge:

  • Apigee Edge Public Cloud

    Calls to your PCF app are routed first through proxies you create on Apigee Edge Public Cloud. You can use the Apigee Edge management console to configure API request handling between clients and your PCF app.

  • Apigee Edge Microgateway

    Calls to your PCF app are routed first through proxies exposed by Apigee Edge Microgateway. When you use Apigee Edge Microgateway, you can specify whether you want the Microgateway instance and your PCF app to run in the same or separate Cloud Foundry containers.

See Getting Started for more about each option.

Key Features

After creating an Apigee Edge API proxy, developers can access the Apigee Edge management console to enhance the proxy with the following features:

  • Data transformation, mediation, orchestration, and policies for rate limits
  • Security, such as authentication and Role-Based Access Control
  • Onboarding, including a developer portal to enable self-service
  • Analytics for monitoring and business metrics analysis
  • Monetization for rate plans, internationalization, and usage tracking

Product Snapshot

Note: As of PCF v2.0, Elastic Runtime is renamed Pivotal Application Service (PAS).

The following table provides version and version-support information about Apigee Edge Service Broker for PCF:

Element Details
Version v3.1.1
Release date September 24, 2018
Software component version Apigee Edge Service Broker for PCF v3.1.1
Compatible Ops Manager version(s) v2.1.x, v2.2.x, and v2.3.x
Compatible Pivotal Application Service version(s) v2.1.x, 2.2.x, and v2.3.x
IaaS support vSphere

Getting Started

To begin using the Apigee Edge Service Broker, perform the procedures in the following topics:

  1. Installing and Configuring Apigee Edge for PCF: Install and configure the Apigee Edge Service Broker for PCF tile to expose the Apigee Edge service plans on the Marketplace of your PCF deployment.

  2. Choose an Apigee Edge product type and service plan to use.

When creating an instance of the Apigee service, you specify one of the following service plans. Each has its own benefits.

Apigee Product Service Plan Description
Apigee Edge Public Cloud org Calls to your PCF app will be routed through a proxy in your Apigee Edge organization. For more on getting started, see Proxying a PCF App with Apigee Edge (“org” plan).
Apigee Edge Microgateway (same container) microgateway-coresident Calls to your PCF app will be routed through a proxy in an instance of Apigee Edge Microgateway running in the same Cloud Foundry container as your PCF app. For more on getting started, see Proxying a PCF App with Apigee Edge Microgateway (“microgateway-coresident” plan).
Apigee Edge Microgateway (separate containers) microgateway Calls to your PCF app will be routed through a proxy in an instance of Apigee Edge Microgateway running in a separate Cloud Foundry container from your PCF app. For more on getting started, see Proxying a PCF App with Apigee Edge Microgateway (“microgateway” plan).

Prerequisites

The Apigee Edge Service Broker for PCF has the following prerequisites:

  • An Apigee Edge account (Public Cloud or Private Cloud) with an organization where API proxies can be created. To create an Edge account, see Creating an Apigee Edge account. For more information about Apigee organizations, see Organization structure.
  • Apigee Edge Microgateway, depending on the service plan you are using.
  • A PCF Elastic Runtime (v2.1 to v2.2) deployment with Route Services enabled.
  • A PAS Pivotal Application Services deployment for PCF v2.1.0 or later with Route Services enabled.
  • The cf CLI v6.20.0 or later, which includes support for route-services operations.
  • Node.js v4.x or later. PCF includes Node.js as a system buildpack, so you can install and run the service broker without Node installed locally, if necessary.

Feedback

Post any bugs, feature requests, questions, and usage articles to the Apigee PCF Community Forum.

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