4.17.05 - Edge for Private Cloud release notes

You're viewing Apigee Edge documentation.
Go to the Apigee X documentation. info

Since the previous Edge for Private Cloud Feature Release, the following releases have occurred and are included in this Feature Release:

See About release numbering to understand how you can figure out whether a specific cloud release is included in your version of Edge for Private Cloud.

Release overview

This release includes a number notable features that help you better control and secure your APIs, including:

• Shared flows support zero-downtime deployment.
• Deleting monetization data for an organization now supported.
• Additional new features described below.

On the deprecation front, vaults have been deprecated.

The remainder of this topic contains details on all the new features, updates, and bug fixes contained in the release.

Deprecations and retirements

The following features were deprecated or retired in this release. See the Edge deprecation policy for more information.

Retired: Adding paths on the API proxy Performance tab

Up to this release, you could navigate to an API proxy in the management UI, go to the Performance tab, and create different paths for a chart-based comparison on the proxy's Performance tab and in the Business Transactions dashboard. This feature is now retired and is no longer available in the UI. For an alternative to this functionality, see the following Apigee Community article: https://community.apigee.com/articles/23936/alternative-to-business-transactions-api.html. (EDGEUI-902)

Retired: buildInfo URL for the Developer Services portal

In previous versions of the portal, to determine your portal version you opened the following URL in a browser:

http://yourportal.com/buildInfo

In 4.17.05 this link was removed. To determine the version, open the Reports > Status report menu entry in Drupal. The portal version appears in the table in the row named Install profile.

Deprecation of Apigee secure store (vaults)

The Apigee secure store, also known as "vaults," is being deprecated and will be retired a year from the deprecation announcement date shown on the Deprecations and retirements page. Vaults, which provide encrypted storage of key/value pairs, are created with the management API and accessed at runtime with functions in the apigee-access Node.js module.

Instead of using the secure store, use encrypted key value maps (KVMs), as described in Working with key value maps. Encrypted KVMs are just as secure as vaults and provide more options for creation and retrieval. (MGMT-3848)

New features and updates

Following are the new features and enhancements in this release. In addition to the following enhancements, this release also contains multiple usability, performance, security, and stability enhancements.

Private Cloud

Added new required SMTP configuration parameter to installation

You must now use the SMTPMAILFROM parameter in the Edge installation configuration file. This parameter specifies the email address used when Edge sends automated emails, such as when a user requests to reset a password. See Install Edge components on a node for more.

(EDGEUI-1020)

Can now set the timeout used by the Edge UI for Edge API management calls

You can now specify the API timeout duration used by the Edge UI to control how long the UI waits for an API management call to return. The following properties define the timeout:

• conf_apigee_apigee.feature.apitimeout sets the time, in seconds, that the UI waits for a call to the backend to return, regardless of any activity on it. If the call is not completed in that time, the UI throws a timeout error. The default value is 180 seconds (3 minutes).
• conf_apigee_play.ws.timeout.idle sets how long the UI waits, in milliseconds, for activity on the server. It can be set to the same value as conf_apigee_apigee_apitimeout or to a lesser value. Setting it to a larger value has no effect. The default is 180000 milliseconds (3 minutes).
• conf_apigee_play.ws.timeout.connection sets how long the UI waits for a connection to be established. It can be set to the same value as conf_apigee_apigee_apitimeout or to a lesser value. Setting it to a larger value has no effect. The default is 120000 milliseconds (2 minutes).

See Set the timeout used by the Edge UI for Edge API management calls for more.

(EDGEUI-816)

Added Message Processor retry timeout to Routers

Added a timeout so that Routers stop retrying a request to Message Processors and returns an error message.

See Configuring the Router to retry connections to a Message Processor for more.

(APIRT-2912)

Added procedure to change the default system administrator

Documentation is now included to change the default system administrator.

See Managing Users, Roles, and Permissions for more.

(DOS-4895)

Added documentation on separating Edge install tasks between root and non-root user

New documentation describes the steps to separate Edge install tasks between root and non-root user.

See Edge Installation Overview for more.

(DOS-4573)

Added property to set the hostname for links in generated emails

Edge automatically sends emails in response to certain events, such as when a user is added to an organization. Many of these emails contain a link. For example, when a new user is added to an organization, the Edge UI sends the user an email containing a login URL in the form:

https://domain/login

The domain is determined automatically by Edge and is typically correct for the organization. However, there is a chance that when the Edge UI is behind a load balancer that the automatically generated domain name is incorrect. If so, you can use the conf_apigee_apigee.emails.hosturl property to explicitly set the domain name portion of the generated URL.

See Setting the hostname for links in generated emails for more.

(EDGEUI-1044)

Setting the base URL displayed by the Edge UI for an API proxy

The Edge UI displays the URL of an API proxy based on settings in the virtual host corresponding to where the proxy is deployed. This display can include the Router port number of the virtual host.

In most cases, the URL displayed in the Edge UI is the correct URL for making external requests to the proxy. However, for some configurations, the displayed URL is not correct. For example, any one of the following configurations can cause the displayed URL displayed to not correspond to the actual URL used to make external requests to the proxy:

• SSL termination occurs at a load balancer
• Port mapping occurs between a load balancer and Apigee routers
• A load balancer configured with path rewriting

Edge for Private Cloud 4.17.05 and later support an attribute on the virtual host called <BaseUrl> that lets you override the URL displayed by the Edge UI. Here's an example showing the virtual host object with the new <BaseURL> attribute. In this example, the value "http://myCo.com" appears in the Edge UI:

<VirtualHost name="myVHost">
   <HostAliases>
     <HostAlias>DNS_name_or_IP:9005</HostAlias> 
   </HostAliases> 
   <BaseUrl>http://myCo.com</BaseUrl>     
   <Interfaces/>
   <Port>9005</Port> 
</VirtualHost>

If <BaseUrl> is not set, the default, then the default URL rendered by the Edge UI will appear as: "http://DNS_name_or_IP:9005/", whereas actual host alias setup is "http://myCo.com".

You can also set the base URL when creating an organization by using the VHOST_BASEURL property with the apigee-provision utility.

See Configuring TLS access to an API for the Private Cloud for more.

(EDGEUI-5008)

Added documentation on enabling debug logging

Documentation has been added to describe how to enable/disable debugg logging for Edge components.

See Enabling debug logging for more.

(APIRT-4018)

New installer and command syntax for the apigee-analytics-collector utility

All Edge for Private Cloud customers are required to submit to Apigee statistics about API proxy traffic using the Beta release of the apigee-analytics-collector command-line utility. This utility sends the API call volume report back to Apigee.

This release of Edge contains new installation instructions and command syntax for the apigee-analytics-collector utility. In this release, you now use apigee-service to install the apigee-analytics-collector utility, instead of npm, and invoke the apigee-analytics-collector utility through apigee-service instead of as a stand-alone command.

See Uploading API Traffic Data to Apigee - Beta Release for more.

New default installation directory after Developer Services portal update of Nginx/Postgres from a new 4.17.01 installation

After updating a new installation of 4.17.01 that uses Nginx/Postgres, the root directory changed from:

/opt/apigee/apigee-drupal

to:

/opt/apigee/apigee-drupal/wwwroot

API Services

Stricter input validation for entities

Stricter input validation has been enforced across all entities of Apigee Edge organization. The allowed characters are usually alphabets (all cases), numbers, underscore.

Entities affected include:

• Organizations
• Environments
• API proxies
• API proxy revisions
• Policy names in the API proxy
• Debug trace mask config IDs
• Resource names (Java callout, xsl, all resources)
• Keystores
• CRLstores
• Resource references
• Target servers

(MGMT-3840)

Shared flows zero-downtime deployment

When you want to deploy shared flows and ensure that little or no incoming traffic is rejected during deployment, you can now use a zero-downtime deployment management API. The process is almost identical to zero-downtime deployment for API proxies using the management API. The only difference is the management API resource.

The following call deploys the shared flow revision indicated in the URI, then undeploys the previously deployed revision (the override=true query parameter enables this):

curl -X POST -H "Content-type:application/x-www-form-urlencoded" \
https://api.enterprise.apigee.com/v1/o/{org_name}/environments/{env-name}/sharedflows/{shared_flow_name}/revisions/{revision_number}/deployments?"override=true" \
-u email:password

(MGMT-3485)

Monetization

Deleting monetization data for an organization

You may wish to delete monetization data for your organization in the following scenarios:

• Delete your organization. In this case, you must delete the monetization data before you can delete the organization.
• Clear monetization data from a test organization that you would like to reuse. In this case, you must synchronize the Apigee Edge data after you delete the monetization data.

For more information, see Delete monetization data from your organization. (DEVRT-2581)

Added API for enabling monetization for an organization

You can now use an API to enable monetization for an organization.

See Enable monetization for an organization for more.

(DEVRT-2383)

Bugs fixed

The following bugs are fixed in this release. This list is primarily for users checking to see if their support tickets have been fixed. It's not designed to provide detailed information for all users.

Private Cloud 4.17.05

Cloud 17.04.12 (UI)

Cloud 17.04.05 (UI)

Cloud 17.03.29 (UI)

Cloud 17.03.15.01 (UI)

Cloud 17.03.15 (UI)

Cloud 17.03.13.02 (monetization)

Cloud 17.03.13.01 (monetization)

Cloud 17.03.13 (API Management)

Cloud 17.03.1 (UI)

Cloud 17.02.15 (UI)

Cloud 17.02.13 (API runtime)

Cloud 17.02.13 (API management)

Cloud 17.01.18 (UI)

Cloud 17.01.16 (API management)

Cloud 17.01.16 (monetization)