Install and configure the Apigee service broker

This topic describes how to install and configure the Apigee service broker, which provides access to your Apigee Edge organization as a service from Cloud Foundry applications.

  1. Download the product tile from the Pivotal Network. (This tile is currently in beta. Contact Apigee for access.)
  2. In the PCF Ops Manager, under Available Products, click Import a Product.

    Find out more about Ops Manager.

  3. In the browse dialog, locate the .pivotal file you downloaded, then click Open.

    It may take a moment for the import to finish. After it has finished, an Apigee link should appear under Available Products.

  4. Under Available Products, next to the Apigee product version number, click Add.

    After adding has finished, an Apigee tile should appear in the Installation Dashboard.

  5. Click the Apigee tile to view settings for Apigee.
  6. Under Settings, click Apigee Edge Tile.
  7. Under Custom Properties for Apigee Edge, enter your own values for the following fields:

    Setting Description Default (for Edge 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. cf-${route}
  8. After you've entered values from your Apigee Edge instance, click Save.
  9. If you like, use the other pages on the Settings tab to customize Pivotal Cloud Foundry configuration for the Apigee Service Broker.
  10. Once you have made all of the settings changes you want, click the Installation Dashboard link at the top of the page to return to the dashboard.
  11. On the Dashboard, click Apply Changes.

It might take some time for Ops Manager to finish applying your changes.

The Apigee Edge service broker is now installed in your PCF deployment. To use the service broker, continue to one of the following topics:

Send feedback about...

Apigee Docs