Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 44 additions & 14 deletions docs-content/index.html.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ owner: Partners
---

This documentation describes Apigee Edge Installer for Pivotal Cloud Foundry (PCF),
which installs the API management service [Apigee Edge for Private Cloud v4.17.09](http://docs.apigee.com/private-cloud/latest/overview) (Edge) on PCF.
which installs the API management service [Apigee Edge for Private Cloud v4.18.05](http://docs.apigee.com/private-cloud/latest/overview) (Edge) on PCF.

PCF Operators [download](https://network.pivotal.io/) and install the Apigee Edge
Installer for PCF tile to expose the [Apigee Edge](http://docs.apigee.com/api-services/content/what-apigee-edge) API
Expand All @@ -24,8 +24,6 @@ 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.
* Monetization is an add-on to the Management Server and Message Processor and does not require additional servers.

Expand All @@ -45,45 +43,77 @@ The following table provides version and version-support information about Apige
<th>Details</th>
<tr>
<td>Version</td>
<td>v4.17.09</td>
<td>v4.18.05</td>
</tr>
<tr>
<td>Release date</td>
<td>December 4, 2017</td>
<td>September 24, 2018</td>
</tr>
<tr>
<td>Compatible Ops Manager version(s)</td>
<td>v1.10.x, v1.11.x, and 1.12.x</td>
<td>v2.x</td>
</tr>
<tr>
<td>Compatible Elastic Runtime version(s)</td>
<td>v1.9.x, v1.10.x, and 1.12.x</td>
<td>v2.x</td>
</tr>
<tr>
<td>IaaS support</td>
<td>AWS, Azure, GCP, OpenStack, and vSphere</td>
</tr>
</table>

## <a id="new"></a>New Features for Edge v4.17.09
## <a id="new"></a>New Features for Edge v4.18.05


This release of Edge contains the following new features:


* Support for Edge v4.17.09. For more information, see [v4.17.09 - Edge for Private Cloud release notes](https://docs.apigee.com/release-notes/content/41709-edge-private-cloud-release-notes).
* Support for OAuth2 and for the Edge SSO module to support SAML. See [Supporting SAML on Edge for Private Cloud](https://docs.apigee.com/private-cloud/latest/supporting-saml-edge-private-cloud) for more.
* When enabling Monetization, you must now set the following config override: `conf_apix-mint_mint.enable_allow_default_pg=true`. See [Configuring Monetization using Ops Manager](https://docs.apigee.com/private-cloud/content/configuring-monetization-using-ops-manager) for more.
* Support for Ops Manager and Elastic Runtime version 1.11.x and 1.12.x.
* 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.

## <a id="new"></a>Retirements for Edge v4.18.05

In this release, the following components were retired:

* API BaaS
* Monitoring Dashboard (Beta)

## <a id="new"></a>Deprecations for Edge v4.18.05

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

## <a id="new"></a>Bug Fixes for Edge v4.18.05

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)

## <a id="new"></a>Known Issues for Edge v4.18.05

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)

## <a id="reqs"></a>Requirements

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](http://docs.apigee.com/private-cloud/latest/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](https://docs.apigee.com/private-cloud/v4.17.09/installing-edge-using-ops-manager#prerequisites-configureloadbalancers).
* **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](https://docs.apigee.com/private-cloud/v4.18.05/installing-edge-using-ops-manager#prerequisites-configureloadbalancers).

## <a id="compare"></a>Differences between Edge Interactive Install and Apigee Edge Installer for PCF

Expand All @@ -106,7 +136,7 @@ process and differs from interactive installation using the command line in the

* **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](https://docs.apigee.com/private-cloud/v4.17.09/differences-between-operations-manager-and-interactive-edge-installs).
For more information, see [Differences between Operations Manager and interactive Edge installs](https://docs.apigee.com/private-cloud/v4.18.05/differences-between-operations-manager-and-interactive-edge-installs).

## <a id="bosh"></a> Ops Manager, BOSH, and PCF Tiles

Expand Down
14 changes: 6 additions & 8 deletions docs-content/installing.html.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ owner: Partners
---


This topic describes how to install and configure Apigee Edge Installer for Pivotal Cloud Foundry (PCF). Edge Installer for PCF lets PCF developers use [Apigee Edge for Private Cloud v4.17.09](http://docs.apigee.com/private-cloud/latest/overview) (Edge).
This topic describes how to install and configure Apigee Edge Installer for Pivotal Cloud Foundry (PCF). Edge Installer for PCF lets PCF developers use [Apigee Edge for Private Cloud v4.18.05](http://docs.apigee.com/private-cloud/latest/overview) (Edge).


##<a id='overview'></a>Installation Overview
Expand All @@ -23,15 +23,13 @@ For more information, see [Understanding APIs and API proxies](http://docs.apige

During the install process, you can optionally choose to install additional Edge components, including the following:

* [Apigee BaaS](http://docs.apigee.com/api-baas)
* [Edge Monitoring Dashboard](http://docs.apigee.com/private-cloud/latest/apigee-monitoring-dashboard-overview)
* [Developer Services portal](http://docs.apigee.com/developer-services/content/what-developer-portal)
* [Edge SSO](https://docs.apigee.com/private-cloud/latest/supporting-saml-edge-private-cloud)
* [Monetization](http://docs.apigee.com/monetization/content/basics-monetization)

Installing these components may require you to perform additional onboarding or configuration steps.

Apigee BaaS and Developer Services portal both require an SMTP server. If installed, they use the same SMTP server as configured for Edge.
Developer Services portal requires an SMTP server. If installed, it uses the same SMTP server as configured for Edge.

##<a id='install'></a> Install and Configure Apigee Edge Installer for PCF

Expand All @@ -43,13 +41,13 @@ Apigee BaaS and Developer Services portal both require an SMTP server. If instal

1. Click the newly added **Apigee Edge Installer for Pivotal Cloud Foundry** tile.

1. Configure the install as described at [Installing Edge using Ops Manager](https://docs.apigee.com/private-cloud/v4.17.09/installing-edge-using-ops-manager).
1. Configure the install as described at [Installing Edge using Ops Manager](https://docs.apigee.com/private-cloud/v4.18.05/installing-edge-using-ops-manager).

1. Return to the Ops Manager Installation Dashboard and click **Apply Changes** to complete the installation.

1. Test the install as described in [Test the installation](https://docs.apigee.com/private-cloud/v4.17.09/installing-edge-using-ops-manager#testtheinstallation).
1. Test the install as described in [Test the installation](https://docs.apigee.com/private-cloud/v4.18.05/installing-edge-using-ops-manager).


1. After the Edge Installer for PCF installation completes, you must provision Edge and any optional Edge components that you installed.
For more information, see [Provisioning organizations](https://docs.apigee.com/private-cloud/v4.17.09/provisioning-organizations).
1. After the Edge Installer for PCF installation completes, you must provision an Organization in Edge, as well as any optional Edge components that you installed.
For more information, see [Provisioning organizations](https://docs.apigee.com/private-cloud/v4.18.05/onboard-organization).

6 changes: 6 additions & 0 deletions docs-content/release-notes.html.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,12 @@ title: Release Notes for Apigee Edge Installer for PCF
owner: Partners
---

### Version 4.18.05

**Release Date:** September 24, 2018

[4.18.05 Edge Installer for Pivotal Cloud Foundry release notes](https://docs.apigee.com/release-notes/content/41805-edge-installer-pivotal-cloud-foundry-release-notes)

### Version 4.17.09

**Release Date:** December 4, 2017
Expand Down
12 changes: 6 additions & 6 deletions docs-content/updating.html.md.erb
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Updating Apigee Edge Installer for PCF v4.17.05 to v4.17.09
title: Updating Apigee Edge Installer for PCF v4.17.09 to v4.18.05
owner: Partners
---
<style>
Expand All @@ -14,17 +14,17 @@ owner: Partners
</style>


Follow the steps below to update Apigee Edge Installer for Pivotal Cloud Foundry (PCF) v4.17.05 to v4.17.09:
Follow the steps below to update Apigee Edge Installer for Pivotal Cloud Foundry (PCF) v4.17.09 to v4.18.05:


1. Download the Edge Installer for PCF v4.17.09 product file from the [Pivotal Network](https://network.pivotal.io).
1. Download the Edge Installer for PCF v4.18.05 product file from the [Pivotal Network](https://network.pivotal.io).
1. In the Ops Manager, select **Import a Product** to upload the product tile.
1. Select the plus (+) icon to accept the tile. The v4.17.09 tile replaces the existing v4.17.05 tile.
1. Select the plus (+) icon to accept the tile. The v4.18.05 tile replaces the existing v4.17.09 tile.
1. **Only if you have enabled Monetization**:
1. Select **Config Overrides** in the **Settings** tab.
1. Specify the following value under **Apigee Global Config Overrides**: `conf_apix-mint_mint.enable_allow_default_pg=true`
1. Select **Save**.
1. Select **Apply changes** to start the update. When the update completes, you return to the Ops Manager.

For information on the new features available in v4.17.09,
see [4.17.09 - Edge for Private Cloud release notes](https://docs.apigee.com/release-notes/content/41709-edge-private-cloud-release-notes).
For information on the new features available in v4.18.05,
see [4.18.05 - Edge for Private Cloud release notes](https://docs.apigee.com/release/notes/41805-edge-private-cloud-release-notes).
11 changes: 2 additions & 9 deletions docs-content/using.html.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,7 @@ title: Using Apigee Edge on PCF
owner: Partners
---

After you have completed the installation of the Apigee Edge Installer for Pivotal Cloud Foundry (PCF) and [created an organization](https://docs.apigee.com/private-cloud/v4.17.09/provisioning-organizations), you can perform several types of tasks.

## <a id='monitor'></a>Access the Monitoring Dashboard
At install time, you can optionally choose to install the Beta release of the Edge Monitoring Dashboard.
The dashboard helps you understand the health of various components (Routers, Message Processors, ZooKeeper, and Cassandra) as well as HTTP error codes for various orgs and environments in your deployment.
You can also snapshot these details and share them with Apigee if required for resolving support incidents.

If you choose to install the dashboard, see [Accessing the Monitoring Dashboard](https://docs.apigee.com/private-cloud/v4.17.09/accessing-monitoring-dashboard) for more information on using it.
After you have completed the installation of the Apigee Edge Installer for Pivotal Cloud Foundry (PCF) and [created an organization](https://docs.apigee.com/private-cloud/v4.18.05/onboard-organization), you can perform several types of tasks.

## <a id='status'></a>View Edge Status

Expand Down Expand Up @@ -44,4 +37,4 @@ From the **Settings** tab, browse to the section that you want to modify and fil

## <a id='doc'></a>Access the Edge Documentation

For complete information on using and configuring Edge, see [Version 4.17.09](https://docs.apigee.com/private-cloud/content/version-41709).
For complete information on using and configuring Edge, see [Version 4.18.05](https://docs.apigee.com/private-cloud/v4.18.05/how-configure-edge).