Apigee Edge Installer for PCF

This documentation describes Apigee Edge Installer for Pivotal Cloud Foundry (PCF), which installs the API management service Apigee Edge for Private Cloud v4.18.05.01 (Edge) on PCF.

PCF Operators download and install the Apigee Edge Installer for PCF tile to expose the Apigee Edge API management platform in the Marketplace. Developers can then use Edge by creating instances of the service and binding them to their apps from Apps Manager or the Cloud Foundry Command Line Interface (cf CLI).


Edge manages API complexity and risk in a multi- and hybrid-cloud world by ensuring security, visibility, and performance across the entire API landscape. For more information, see What is Edge.

Edge for Private Cloud lets customers run Edge on-premises. A deployment environment for Edge for Private Cloud typically consists of at least nine separate servers, and more commonly 13 or more. In addition, you can install optional Edge components that require more servers:

  • The Developer Services portal requires an additional server.
  • Monetization is an add-on to the Management Server and Message Processor and does not require additional servers.

You can install Edge and its optional additional components in two ways:

  • Interactive installation from the command line requires you to predefine and preconfigure each server individually, then install Edge components on each server in a specific order.
  • The Apigee Edge Installer for PCF tile in Ops Manager presents a graphical web interface that installs and manages pre-configured products and components in a uniform way across multiple IaaSes: AWS, Azure, GCP, OpenStack, and vSphere.

The Differences between Edge Interactive Install and Apigee Edge Installer for PCF section below compares these two installation methods in greater detail.

Product Snapshot

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

Element Details
Version v18.05.01
Release date November 9, 2018
Compatible Ops Manager version(s) v2.0.x, v2.1.x, and v2.2.x
Compatible Pivotal Application Service version(s) v2.0.x, v2.1.x, and v2.2.x
IaaS support AWS, Azure, GCP, OpenStack, and vSphere

New Features for Edge v18.05.01

This release of Edge contains the following new features:

  • JWT Policies are now Generally Available (GA).
  • RedHat Enterprise Linux 6.9 is now supported.
  • Oracle Linux 6.9 is now supported.
  • CentOS 6.9 is now supported.
  • New Edge experience installation configuration changes.
  • Router retry options can now be set at the virtual host level.

Retirements for Edge v18.05.01

In this release, the following components were retired:

  • API BaaS
  • Monitoring Dashboard (Beta)

Deprecations for Edge v18.05.01

In this release, the following components were deprecated:

  • Apigee secure stores (vaults) replaced by KVMs
  • Adding paths on the API proxy Performance tab
  • SMTPSSL property for the Developer Services portal

Bug Fixes for Edge v18.05.01

In this release, the following bugs were fixed:

  • Prevent user’s email address from being changed (65550638)
  • Security vulnerability in jackson-databind (69711616)
  • Memory leak in Message Processors (71612599)

Known Issues for Edge v18.05.01

In this release, the following issues were detected:

  • Hostnames not resolving (79757554)
  • Permission error message appears when stopping apigee-postgresql (72379834)
  • Create reverse proxy via Open API option is displayed (79949124)


Apigee Edge Installer for PCF has the following requirements:

  • VMs: Virtual machines (VMs) for Edge must meet system requirements for memory, CPU, and disk space as defined in Installation Requirements.

  • Load Balancers: Configure load balancers to control access to Edge servers. The load balancer defines the domain name and port of the Edge access point, optionally enables TLS, and forwards requests to the appropriate port on an Edge component. For more information, see Configure load balancers.

Differences between Edge Interactive Install and Apigee Edge Installer for PCF

Apigee Edge Installer for PCF streamlines the Edge for Private Cloud installation process and differs from interactive installation using the command line in the following ways:

  • No config files needed. You use Ops Manager to specify installation and configuration information, and do not have to create separate config files.

  • Enable Monetization only after installing Edge. You must install Edge first, and then enable Monetization and apply that change to the Edge installation. You cannot enable Monetization at the same time that you install Edge.

  • Enable Edge SSO only after installing Edge. Install Edge first and then ensure that Edge is working correctly before enabling Edge SSO to support SAML. You cannot enable Edge SSO at the same time that you install Edge.

  • No need to enable Cassandra authentication. The Cassandra servers created during the install are not publicly accessible and therefore do not require you to enable authentication.

  • The two Postgres servers are configured as master/standby servers. You must use Postgres master/standby configuration in this release.

  • Do not have to open specific ports on the servers. In an interactive Edge installation, you have to ensure that the necessary ports are open on each server as described in Edge port requirements.

  • Multiple data centers not supported. The release supports the installation of a single data center only.

  • You can only specify the number of servers for the Router and Message Processor components. This release configures Edge to create two Router servers and two Message Processor servers by default. However, you can increase or decrease those numbers at install time or later.

For more information, see Differences between Operations Manager and interactive Edge installs.

Ops Manager, BOSH, and PCF Tiles

Behind the Ops Manager interface, the open-source tool BOSH handles deploying, running, and managing distributed software systems on all PCF-supported cloud infrastructures. Ops Manager provides a uniform graphical, forms-based interface that hides the complexity of generating the cloud-specific deployment manifests and configurations that BOSH requires.

Ops Manager supports graphical configuration, deployment, and management of any software product packaged in PCF Tile structure.


Please contact Apigee Support for any bugs, feature requests, or questions.

You can also tap into the knowledge and experience of Apigee customers and employees by posting a new question to the Apigee Community.


Each installation of Edge requires a unique license file that you obtain from Apigee. If license file is valid, the management server validates the expiry and allowed Message Processor (MP) count.

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