Installing and Configuring Apigee Edge for PCF
Page last updated:
This topic describes how to install and configure the Apigee Edge Service Broker for Pivotal Cloud Foundry (PCF).
Download the product file from Pivotal Network.
Navigate to the Ops Manager Installation Dashboard and click Import a Product to upload the product file.
Click Add next to the uploaded Apigee Edge Service Broker for PCF tile in the Ops Manager Available Products view to add it to your staging area.
Click the newly-added Apigee Edge Service Broker for PCF tile.
Under Settings, click Apigee Edge Tile. Note the Add button in the top left. This allows for the addition of any number of specific configurations to be added to the tile.
Under Custom Settings, enter the appropriate values. See the following table for a description of each setting and the default values for users of Apigee Edge for Public Cloud.
Setting Description Default for Public Cloud Name for this configuration Choose a name that describes the configuration. Default configuration Apigee Organization The Apigee Edge organization with proxies that will handle calls to your app. Apigee Environment The Apigee Edge environment that with proxies that will handle calls to your app. Dashboard URL The URL to the Apigee Edge management console, the UI where you develop and manage API proxies.
Apigee Management API URL The endpoint URL to the Apigee Edge management API. The Apigee Edge Service Broker uses this URL when making requests to create new Apigee Edge API proxies for managing requests to PCF apps.
Apigee Proxy Domain The domain name that PCF apps use when making calls to your API proxy.
Apigee Proxy Host Template ES6 template literal for generated proxy host. The template that describes how the Apigee Edge host name should be generated.
This represents the hostname that clients use to make calls to your APIs. Change this value if your hostname is not created in the default way – from your Apigee org an environment names. For example, if your APIs use a custom virtual host, you might have just a domain name:
Pivotal Cloud Foundry apps use this host when making calls to your API proxy. The template generates the host name from values specified when binding the PCF app to the service. (Note that without any placeholders, will be used as-is.)
Apigee Proxy Name Template The template that describes how to generate the name of your proxy when you create it from the cf CLI.
Return to the Ops Manager Installation Dashboard and click Apply Changes to install the Apigee Edge Service Broker for PCF tile.
The Apigee Edge service broker is now installed in your PCF deployment. To use the service broker, continue to one of the following topics:
- To learn how to proxy a Cloud Foundry app with Apigee Edge, see Proxying a PCF App with Apigee Edge (“org” plan).
- To learn how to proxy a Cloud Foundry app with Apigee Edge Microgateway, where Microgateway and the app are in separate Cloud Foundry containers, see Proxying a PCF App with Apigee Edge Microgateway (“microgateway” plan) topic to learn how to create and use an Apigee Edge API proxy for PCF apps.
- To learn how to proxy a Cloud Foundry app with Apigee Edge Microgateway, where Microgateway and the app are in the same Cloud Foundry container, see Proxying a PCF App with Apigee Edge Microgateway (“microgateway-coresident” plan) topic to learn how to create and use an Apigee Edge API proxy for PCF apps.