Edge Installer for Pivotal Cloud Foundry

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

PCF Operators download and install the 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).


Apigee 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 Apigee Edge.

Edge for Private Cloud lets customers run Apigee 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:

  • Apigee BaaS requires an additional six or more servers.
  • The Edge Monitoring Dashboard requires an additional server.
  • The Developer Services portal requires an additional server.

You can install Edge for Private Cloud 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 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 Edge Installer Advantages and Limitations section below compares these two installation methods in greater detail.

Product Snapshot

Edge Installer for PCF Details:
Version: 4.16.09
Release Date: February 6, 2017
Compatible Ops Manager Version(s): v1.8.x
Compatible Elastic Runtime Version(s): 1.8.x
vSphere support? YES
OpenStack support? YES
AWS support? YES


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. See Configure load balancers for details.

Differences between Edge Interactive Install and Edge Installer for PCF

Edge Installer for PCF streamlines the Edge for Private Cloud installation process and differs from interactive installation via 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.

  • 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.

See Differences between Operations Manager and interactive Edge installs for more.

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.

Was this helpful?
What can we do to improve?
View the source for this page in GitHub