Release Notes

Red Hat 3scale API Management 2.4

For Use with Red Hat 3scale API Management 2.4

Red Hat Customer Content Services

Legal Notice

Abstract

Release Notes for Red Hat 3scale API Management 2.4.

Chapter 1. Red Hat 3scale API Management 2.4 On-Premise Release Notes

1.1. Changes and New Features

1.1.1. Major Changes

Introducing Service Discovery to allow API providers to add APIs for management by “discovering” corresponding services in the underlying OpenShift cluster (Content from issues.jboss.org is not included.JIRA #1363).
Updates to user experience and user interface in line with other Red Hat’s products (Content from issues.jboss.org is not included.JIRA #1361).
First officially supported Command Line Interface (CLI) to copy services within the same or different 3scale instances, both on-premises and SaaS (Content from issues.jboss.org is not included.JIRA #1362).
New APIcast IP check policy to accept or deny requests based on IPs (Content from issues.jboss.org is not included.JIRA #1353).

1.1.2. Minor Changes

When a tenant is deleted from the Admin Portal, instead of being deleted directly, it is postponed for deletion. The developer will lose access to the provider’s APIs, but it will not actually be removed from the system until 15 days later.
APIcast API gateway:
- Additional metrics for Prometheus monitoring (Content from issues.jboss.org is not included.JIRA #1383).
  - Number of errors of the Lua library that manages the metrics
  - APIcast errors
  - Number of HTTP connections.
  - Capacity of the dictionaries shared between workers
  - Free space of the dictionaries shared between workers
  - Response status codes from 3scale back end
- Enhanced Headers policy with delete operation (Content from issues.jboss.org is not included.JIRA #1354).
- Return retry-after quota when the request is denied by the backend because it is being rate limited. It contains the number of seconds the caller needs to wait until the limit expires (Content from issues.jboss.org is not included.JIRA #1380).
Deployment. Changes in existing templates:
- Unified shared configurations via ConfigMaps.
- Moved existing sensitive information into Secrets.
- Made all existing databases configurable externally.
Removed system-resque pod. Now system-sidekiq pod is handling everything that was handled by system-resque previously. (Content from issues.jboss.org is not included.JIRA #1695).

1.2. Resolved Issues

When the ‘Service Settings’ view cannot be accessed, the system handles the error properly by displaying relevant information (Content from issues.jboss.org is not included.JIRA #878).
Enhanced perfomance of the wildcard-router feature when dealing with unsecured routes (Resolved in OpenShift Container Platform 3.9.32).
Not supported payment gateways have been removed from the Admin Portal (Content from issues.jboss.org is not included.JIRA #1063).
Improved performance of APIcast to load configuration and start when there are many services.
Refined permission management to avoid having members without permissions to see and modify applications under API services (Content from issues.jboss.org is not included.JIRA #1116).
Kept effective email notification options for master users (Content from issues.jboss.org is not included.JIRA #826 and Content from issues.jboss.org is not included.JIRA #873).
3scale Auth Caching policy: Allow returns the first transaction as 200 (OK) for new keys (Content from issues.jboss.org is not included.JIRA #1396).
You can see only the relevant information in Account Summary for master accounts (Content from issues.jboss.org is not included.JIRA #974).
Developer portal links effectively to Quickstart (Content from issues.jboss.org is not included.JIRA #1212).
On update request, Developer Portal is now properly updated when working with this endpoint: /admin/api/authentication_providers/{id} (Content from issues.jboss.org is not included.JIRA #1207).
When using HTTPS proxy, nil is not added to the request path anymore (Content from issues.jboss.org is not included.JIRA #1506).
Now, you can download a .CSV file about API Usage with Explorer 11 (Content from issues.jboss.org is not included.JIRA #1318).
Improved readability of descriptions in [Your API] > Integration > Configuration (Content from issues.jboss.org is not included.JIRA #946).
Memcached is now able to verify that a user is non-roots for containers on Openshift (Content from issues.jboss.org is not included.JIRA #665).
Now, master is not visible in its own list of tenants (Content from issues.jboss.org is not included.JIRA #990).
The signup page from the Developer Portal loads when spam protection is enabled (Content from issues.jboss.org is not included.JIRA #908).
With Signup Express endpoint, now setting name as an additional field does not override the org_name value (Content from issues.jboss.org is not included.JIRA #875).
Upgraded management of APIcast environment names: sandbox has been replaced by the correct name staging. (Content from issues.jboss.org is not included.JIRA #1429).

1.3. Documentation

1.4. Technology Preview Features

HA and Eval openshift templates (Content from issues.jboss.org is not included.JIRA #1168)
The “Conditional policy” that only executes a policy chain if a certain condition is met. There is no user interface available for this policy; it must be configured via JSON.

1.5. Known Issues

Dashboard stream and email notifications are not filtered according to the admin member permissions (Content from issues.jboss.org is not included.JIRA #629).
Invoices not correctly generated in POSTPAID mode when subscribing on the last day of the month (Content from issues.jboss.org is not included.JIRA #534).
Backend-listener fails to reconnect to backend-redis (Content from issues.jboss.org is not included.JIRA #608).
The master account application is visible, but the master account is not (Content from issues.jboss.org is not included.JIRA #1474).
Service deletion might randomly prevent a service to be re-added and discovered in 3scale (Content from issues.jboss.org is not included.JIRA #1194).
- Workaround: Recreate the OpenShift service with another name. The application itself does not need to be redeployed.
Redis High Availability (HA) via Sentinel functionality with the backend for System components is currently not supported through connections with system-redis or backend-redis (Content from issues.jboss.org is not included.JIRA #1132).

1.6. Deprecation and Replacement Notices

1.6.1. Deprecated in 3scale 2.4

End User Plans are deprecated in this release. Actual removal of this feature will be in March 2019. This feature will be replaced by the ability to define rate limits for end users using the APIcast policy for edge limiting. For more details, see Edge Limiting Policy
Latest transactions are deprecated in this release and will be removed in a future version. With the changes in 3scale user interface, references to the page with a live feed of the transactions reported from your APIs have been removed from the Admin Portal. As a temporary option to view the transactions, you can type the URL: [Your_admin_domain]/apiconfig/transactions.

1.6.2. Replaced in 3scale 2.4

Native OAuth 2.0 implementation (Authorization Code flow) for API traffic authentication has been removed in this release. This feature is replaced by the OpenID Connect integration with Red Hat Single Sign-On which includes support for multiple OAuth 2.0 flows. For more details, see OpenID Connect Integration.

Legal Notice

The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at Content from creativecommons.org is not included.http://creativecommons.org/licenses/by-sa/3.0/. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version.

Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.

Red Hat, Red Hat Enterprise Linux, the Shadowman logo, the Red Hat logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.

Linux® is the registered trademark of Linus Torvalds in the United States and other countries.

Java® is a registered trademark of Oracle and/or its affiliates.

XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.

MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.

Node.js® is an official trademark of Joyent. Red Hat is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.

The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation's permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.

All other trademarks are the property of their respective owners.