4.19.01 Edge for Private Cloud release notes

This section describes version 4.19.01 of the Edge for Private Cloud Feature Release.

Release summary

The following table summarizes the changes in this release:

New Features

This release includes the following new features:

○ General Availability (GA) release of the Edge UI
○ General Availability (GA) release of Monetization in the Edge UI
apigee-monit adds self-healing and monitoring services
○ Edge UI has new TLS configuration properties
○ You can now create, edit, and delete virtual hosts in the Edge UI
○ OpenAPI v3 support added
○ RedHat Enterprise Linux (RHEL) and CentOS 7.6 are now supported
○ Oracle Linux 7.5 is now supported

For more information about each of these new features, see New features.

Included Releases

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

○ Edge:
   18.06.08
   18.06.06
   18.05.21
   18.05.10
   18.05.09
   18.04.23.00
○ Portal:
   18.11.28.00
   18.10.17.00
   18.10.09.00
   18.07.16.00
Retirements None
Deprecations Apigee Edge for Private Cloud version 4.17.09 is no longer supported (deprecated).

For more information, see Apigee deprecations, retirements, and CPS changes.

Bug Fixes

This release includes the following bug fixes:

○ Zookeeper was not stopped by backup script (122694069)
○ 'No organizations' landing page added (120993451)
○ Deleting custom reports (120682369)
○ Geomap tab in New Edge experience (120681592)
○ Zookeeper JVM options (120624977)
○ Undefined errors occurred on tooltips (80187407)
○ Creating reverse proxies via OpenAPI (79949124)
○ Resetting passwords not sending links (77515655)
○ Incorrect headers for reset password links (72799769)
○ Using WSDLs to create API Proxies (69550284)

For more information about each of these fixes, see Bug fixes.

Known Issues

This release includes the following known issues:

○ Metadata file format for apigee-sso install (135616498)
apigee-monit not supported on Amazon Linux 1 (122370980)
○ Message Processor backup not backing up the correct set of files (121095148)
○ Session tokens not invalidated (115278838)
○ Cassandra operations not working when JMX auth is enabled (113342838)
HEAD requests to Node.js targets hang (79993247)
○ Hostnames not resolving (79757554)
○ DataAccessExceptions in multi data center configurations (76087166)
○ MessageLogging policy including extra information in the log message (68722102)
○ Resetting system admin password fails (65737520)

For more information about each of these known issues, including workarounds, see Known issues.

Upgrade paths

The following table shows the upgrade paths for this release:

From 4.18.05 Directly upgrade from 4.18.05 → 4.19.01
From 4.18.01 Directly upgrade from 4.18.01 → 4.19.01
From 4.17.09 Directly upgrade from 4.17.09 → 4.19.01
From 4.17.05 Upgrade from 4.17.05 → 4.18.01, then upgrade from 4.18.01 → 4.19.01
From 4.17.01 Upgrade from 4.17.01 → 4.18.01, then upgrade from 4.18.01 → 4.19.01
From 4.16.09 Upgrade from 4.16.09 → 4.18.01, then upgrade from 4.18.01 → 4.19.01
From 4.16.05 Upgrade from 4.16.05 → 4.18.01, then upgrade from 4.18.01 → 4.19.01
From 4.16.01 Upgrade from 4.16.01 → 4.18.01, then upgrade from 4.18.01 → 4.19.01
From 4.15.0x Upgrade from 4.15.0x → 4.16.01, then upgrade from Upgrade from 4.16.01 → 4.18.01, then upgrade from 4.18.01 → 4.19.01

New features

This section lists new features in this release. Additionally, this release includes all features in the Edge UI, Edge Management, and Portal releases listed in Included Releases.

In addition to the following enhancements, this release also contains multiple usability, performance, security, and stability enhancements.

General Availability (GA) release of the Edge UI

The Apigee Edge UI is our latest management UI service. Previously, it was in Beta. With Apigee Edge for Private Cloud v4.19.01, the Edge UI is part of the general release.

To use the Edge UI, you must enable SAML and then install the Edge UI on its own node.

For more information, see The Edge UI for Private Cloud.

General Availability (GA) release of Monetization in the Edge UI

The GA release of Monetization in the New Edge experience UI is now available.

You can now manage all monetization tasks for Apigee Edge for Private Cloud in the New Edge experience UI, including the following:

With this announcement, monetization variance reports have been officially deprecated. See Apigee deprecations.

apigee-monit adds self-healing and monitoring services

Apigee Edge for Private Cloud now includes apigee-monit, a tool based on the open source monit utility. apigee-monit periodically polls Edge services; if a service is unavailable, then apigee-monit attempts to restart it.

For information on installing, configuring, and using apigee-monit, see Self healing with apigee-monit.

New TLS configuration properties

The Edge UI supports new TLS configuration properties that you can use to set the following:

  • Default TLS protocol
  • List of supported TLS protocols
  • Supported TLS algorithms
  • Supported TLS ciphers

For more information, see Setting optional TLS properties.

Create, edit, and delete virtual hosts in the Edge UI

Self service functionality has been expanded so that you can now create, edit, and delete virtual hosts in a browser (Edge UI only).

For more information, see Create a virtual host using a browser.

OpenAPI v3 support added

This release has added support for creating a proxy via OpenAPI version 3 (Edge UI only).

Supported software

This release includes the following changes to supported software:

Support Added No Longer Supported

This release adds support for the following platforms:

  • Red Hat Enterprise Linux (RHEL) 7.6
  • CentOS 7.6
  • Oracle Linux 7.6

The following platforms are no longer supported with this release:

  • RHEL/CentOS/Oracle version 7.3
  • RHEL/CentOS version 6.8
  • Oracle Linux 6.7

For a complete list of supported platforms, see Supported software and supported versions.

Bug fixes

This section lists the Private Cloud bugs that were fixed in this release. Additionally, this release includes all bug fixes in the Edge UI, Edge Management, and Portal releases shown in Included Releases.

Issue ID Description
122694069

Zookeeper was not stopped by backup script

The Zookeeper process was not being stopped by the backup script before this fix.
120993451

'No organizations' landing page added

Developers who log in with a user that has no associated organizations are no longer sent to a page that doesn't exist. A new landing page has been added for these users.
120682369

Deleting custom reports

Users could not delete custom reports in the New Edge experience.
120681592

Geomap tab in New Edge experience

When users navigated to the Geomap tab in the New Edge experience, the New Edge experience was throwing an error.
120624977

Zookeeper JVM options

Setting JVM options by using Code with Config for Zookeeper was not working.
80187407

Undefined errors occurred on tooltips

When a chart had only one time series, the tooltips were throwing undefined errors.
79949124

Creating reverse proxies via OpenAPI

The Use OpenAPI button when creating proxies was not working.
77515655

Resetting passwords not sending links

Users were not getting emails when requesting a link to reset their passwords.
72799769

Incorrect headers for reset password links

Even after a user set the trustxforwarded property to true, the resulting request headers were not using HTTPS.
69550284

Using WSDLs to create API Proxies

API Proxy generation was failing when using WSDLs.

Known issues

The following table lists known issues in this release:

Issue ID Description
135616498

Metadata file format for apigee-sso install

When installing apigee-sso and using a metadata.xml file instead of a URL, if the metadata.xml file does not include a new line (CRLF) at the end of the file, the metadata.xml file is not read entirely.

Workaround:

To work around this issue, you can do one of the following:

  • Add a CRLF to the end of the metadata.xml file

    OR

  • Use a URL-based location for the metadata
122370980

apigee-monit not supported on Amazon Linux 1

Workaround:

None.
121095148

Message Processor backup not backing up the correct set of files

Workaround:

Run the backup a second time and it should back up the correct set of files.

115278838

Session tokens not invalidated

Session tokens are not invalidated on the server when the user clicks on the Apigee Edge Logout button.

Workaround:

Use the New Edge experience with SAML.

113342838

Cassandra operations not working when JMX auth is enabled

Workaround:

Add your username and password whenever you invoke the nodetool command.

79993247

HEAD requests to Node.js targets hang

HEAD requests to a Node.js target can hang, leaving connections pending.

Workaround:

To work around this issue, define a handler for HEAD requests to explicitly return an empty response.

79757554

Hostnames not resolving

After installing or upgrading Edge for Private Cloud, hostnames might not resolve to their addresses.

Workaround:

To resolve this issue, restart the Edge UI component:

/opt/apigee/apigee-service/bin/apigee-service edge-ui restart
76087166

DataAccessException in multiple data center configurations

In multiple data center configurations, if one datastore becomes unavailable, then you might see the following error:

DataAccessException: Error while accessing datastore;
Please retry later

The result is that Management Server may not start because it is trying to connect to Cassandra nodes in both dc-1 and dc-2. The DataAccessExceptions occurs if a Cassandra node is down. This might also result in API traffic disruption, where Message Processors report DataAccessExceptions while trying to retrieve KVMs.

Note that the expected state is for the Management Server not to connect to datastore components across regions.

Workaround

The workaround is to deregister the following Cassandra node types in the unavailable data center and then re-register them after the Cassandra nodes are available again:

  • kms-datastore
  • dc-datastore
  • keyvaluemap-datastore

To deregister and reregister these Cassandra node types:

  1. Get the UUIDs of the Cassandra nodes by using the following curl command:
    curl -u ADMIN_EMAIL:ADMIN_PW \
      "http://MS_IP:MS_PORT/v1/servers?region=REGION&pod=GATEWAY_POD \
      &type=CASSANDRA_NODE_TYPE"

    Where:

    • ADMIN_EMAIL and ADMIN_PW are the credentials of your Apigee account.
    • MS_IP and MS_PORT are the Management Server's IP address and port number.
    • REGION is the name of the data center in which the Management Server is located.
    • GATEWAY_POD is the pod name, which is by default "gateway". You might have renamed it to something else, though, so check your implementation.
    • CASSANDRA_NODE_TYPE is one of kms-datastore, dc-datastore, and keyvaluemap-datastore.

    For example:

    curl -u nickdanger@google.com:myP@$$w0rD
      "http://192.168.0.1:8080/v1/servers?region=dc-1&pod=gateway&type=dc-datastore"

    The response uses the following format:

    {
      "internalIP" : "POD_IP_ADDRESS",
      "isUp" : [true|false],
      "pod" : "GATEWAY_POD",
      "reachable" : [true|false],
      "region" : "dc-1",
      "tags" : {
        "property" : [ ]
      },
      "type" : [ "kms-datastore", "dc-datastore", "keyvaluemap-datastore" ],
        "uUID" : "POD_UUID"
    }

    For example:

    {
      "internalIP" : "192.168.1.11",
      "isUp" : false,
      "pod" : "gateway",
      "reachable" : false,
      "region" : "dc-1",
      "tags" : {
        "property" : [ ]
      },
      "type" : "dc-datastore",
      "uUID" : "13cee956-d3a7-4577-8f0f-1694564179e4"
    }

    Note the values of the uUID field in the response. You will use these to deregister the nodes.

  2. Repeat step one for each Cassandra node type: kms-datastore, dc-datastore, and keyvaluemap-datastore. Be sure to take note of the UUIDs that are returned.
  3. Deregister the nodes using the following command:
    curl -u ADMIN_EMAIL:ADMIN_PW "http://MS_IP:MS_PORT/v1/servers/UUID" -X DELETE

    Where UUID is the UUID returned in the previous command's response.

  4. Repeat step 3 for each UUID you collected in steps 1 and 2.
  5. Re-register the nodes using the following command:
    curl -u ADMIN_EMAIL:ADMIN_PW "http://MS_IP:MS_PORT/v1/servers -d \
      "Type=kms-datastore&Type=dc-datastore&Type=keyvaluemap-datastore& \
      Type=counter-datastore&Type=cache-datastore&InternalIP=POD_IP_ADDRESS& \
      region=REGION&pod=GATEWAY_POD" -H \
      'content-type: application/x-www-form-urlencoded' -X POST

Note that these operations register and deregister nodes from Zookeeper and do not have any impact on the Cassandra cluster. For more information about these commands, see Update datastore registrations.

68722102

MessageLogging policy including extra information in the log message

The FormatMessage element of the MessageLogging policy controls the format of the logged message. When FormatMessage=false, the logged message is not supposed to include any Apigee-generated information. However, even if you set FormatMessage=false, the log message still includes the following information:

  • The priority score
  • The timestamp

Workaround:

None.
65737520

Resetting system admin password fails

Resetting the system admin password for the Management Server that contain special characters will fail.

Workaround:

Define the password in a data file that you then pass to the /users endpoint in the Management API. For more information, see Resetting system admin password.

Next step

To get started with Edge for Private Cloud 4.19.01, use the following links:

New installations:
New installation overview
Existing installations:
Upgrade paths