Release Notes for Red Hat 3scale API Management 2.9 On-premises
Document intended for use with Red Hat 3scale API Management 2.9
This document is intended for use with Red Hat 3scale API Management 2.9 and related patch releases.
Chapter 1. Red Hat 3scale API Management 2.9.1 - Patch release
This document is intended for use with Red Hat 3scale API Management 2.9.1 On-premises.
1.1. New features
1.2. Resolved issues
- The imported API is fully visible in the Admin Portal when using the Service Account authentication option for Service Discovery (JIRA #5089).
- The autocomplete feature from OpenAPI Specification (OAS) 3.0 works accurately without depending on the format (JIRA #5516).
- The request URI is now included when tracing transactions through APIcast (JIRA #5669).
- After suspending a tenant, the Suspend button is not visible (JIRA #5738).
- When combined with the Batcher Policy, the Auth Caching Policy (in Allow mode) is now authorizing new requests when the backend-listener is down (JIRA #5753).
1.3. Known issues
- Check the latest information about 3scale 2.9.1 supported configurations at the Red Hat 3scale API Management Supported Configurations website.
- Check the procedures to install and configure 3scale in the Installing 3scale guide.
If you are planning to configure your 3scale template-based installation with Oracle Database, refer to the Section 1.5, “Changes in 3scale” section for more details about the supported Oracle Database versions, and the following documentation:
Check the procedures to upgrade your 3scale installation from 2.8 to 2.9.1, for the following deployments:
- If your 3scale template-based installation runs with Oracle Database, refer to the Support for Oracle Databases section for more details about the supported Oracle Database versions.
1.5. Changes in 3scale
This section lists the changes for 3scale 2.9.1
1.5.1. Support for Oracle Databases
The following are details about Red Hat 3scale API Management support for Oracle Databases in template-based deployments with OpenShift 3.11:
- 3scale 2.9.1 provides support for both Oracle 12c and 19c.
- You can upgrade your 3scale installation from 2.9 to 2.9.1 while having Oracle 12c.
- In 3scale 2.10, support for Oracle 12c will be replaced with Oracle 19c. If you are using 3scale with Oracle DB, consider upgrading the database version to Oracle 19c. This setting ensures that your 3scale installation is under a supported configuration.
Chapter 2. Red Hat 3scale API Management 2.9
This document is intended for use with Red Hat 3scale API Management 2.9 On-premises.
2.1. New features
2.1.1. Major features
Introducing new APIcast policies:
- Upstream Mutual TLS: You can establish mutual TLS connections between APIcast and upstream APIs based on the certificates set in the configuration (JIRA #672). For more details, see Upstream Mutual TLS.
- Custom Metrics: You can add a new metric to the post action, so the user can report metric upstream headers, status code or any other relevant information (JIRA #5098). For more information, see Custom metrics.
Configuration of content caching in 3scale APIcast gateway, allowing you to set the
Cache-Controlheaders (JIRA #487). For more details, see APICAST_CACHE_MAX_TIME and APICAST_CACHE_STATUS_CODES.
- Enhancements to ActiveDocs features for deeper integration with OpenAPI Specification (OAS) 3.0 (JIRA #4212). For more details, refer to Configuring OAS.
- Now you can operate with 3scale on-premises without reaching the public Internet (JIRA #4006). For more information, see Installing and configuring the 3scale operator using the OLM.
- Option to configure the list of currencies for billing (JIRA #3076). For more details, refer to YAML configuration for currencies.
- Analytics data for usage statistics of APIs used as backends (JIRA #3159). For more information, refer to Checking analytics for backends.
2.1.2. Minor features
- Support for the latest draft of RFC for HTTP rate limiting headers (JIRA #3795).
- Configuration of the URL Rewrite policy rules based on HTTP methods (JIRA #5259).
- Triggering of webhooks based on Admin API actions (JIRA #4703).
- API endpoint to delete the pricing rules of a metric or an application plan (JIRA #4771).
- 3scale toolbox command to export all services taken from the latest proxy configuration for a given environment (JIRA #669).
- Standardized approach to report errors in 3scale toolbox to ensure consistency and lack of ambiguity (JIRA #2349).
importcommand for application plans in 3scale toolbox (JIRA #3874).
- Customization of the storage class for every PersistentVolumeClaim (JIRA #4651).
- Prometheus metrics for APICast: status and content_caching (JIRA #5417 and JIRA #5439).
2.2. Technology Preview features
- High Availability (HA) and Evaluation (Eval) OpenShift templates (JIRA #1168).
- 3scale operator for capabilities: It allows using custom resources to define 3scale tenants, APIs, plans, limits, metrics and other definitions to set them into a 3scale installation (JIRA #1798).
- Using the 3scale operator, monitor resources with Prometheus and Grafana (JIRA #4639 and JIRA #4641).
- Metering labels for 3scale pods so you can get pre-defined reports from the metering operator, and see usage data (JIRA #5765).
- Backup and Restore functionality via the 3scale operator (JIRA #4746).
2.3. Resolved issues
- Included validation to prevent the configuration of negative values trial periods (JIRA #1758).
- Zync now refers to the HTTP scheme and port number of the Public Base URL (JIRA #3545).
- SSO Integrations is now highlighted in the vertical navigation (JIRA #3548).
- Improved performance with many backends or products (JIRA #3592).
- Added validation to avoid the generation of proxy configs for products that do not have any backend (JIRA #3626).
- Improved performance when APIcast uses a large body to perform a call with Forward proxy (JIRA #3863).
- Host header is now set if HTTP_PROXY is configured (JIRA #4178).
- When using the OpenID connect authentication method, the Example curl for testing is now hidden (JIRA #4384).
- An Admin user in member role now has access to backend usages (JIRA #4489).
- Accurate error message when entering many characters in proxy domains (JIRA #4658).
- Path based routing now matches arguments (JIRA #5149).
- IP Check policy now strips the port (JIRA #5258).
2.4. Known issues
- ProxyRule removes trailing slashes (JIRA #3872).
- The position of a mapping rule defined in a YAML file is ignored (JIRA #5747).
- Wrong metadata in some packages (JIRA #5682).
- RESOLVED in 3scale 2.9.1: The Suspend button is visible when the tenant is already suspended (JIRA #5738).
RESOLVED in 3scale 2.9.1: When using the ServiceAccount authentication option for Service Discovery, the imported API is not visible in the Admin Portal (JIRA #5089). To work around this issue, you have these options:
- Rename the project and/or service in OpenShift, so the final APIcast URL does not contain labels with more than 63 chars.
Modify the URL templates in
sandbox_proxy.ymlso the risk of having long URL labels is mitigated.
- Check the latest information about 3scale 2.9 supported configurations at the Red Hat 3scale API Management Supported Configurations website.
- Check the latest information about 3scale 2.9 security updates in the Red Hat Product Advisories portal.
- If your 3scale template-based installation runs with Oracle Database, refer to the Section 2.6.1, “Future changes” section for more details about the supported Oracle Database versions.
Check the procedures to upgrade your 3scale installation from 2.8 to 2.9, for the following deployments:
2.6. Changes in 3scale
This section lists the future changes for 3scale 2.9
2.6.1. Future changes
- In 3scale 2.9.1, support for Oracle 12c will be replaced with Oracle 19c. If you are using 3scale with Oracle DB, keep 3scale 2.8 until 2.9.1 is released, and then upgrade the database version to Oracle 19c. This setting ensures that your 3scale installation is under a supported configuration.
In 3scale 2.9.1, there are changes in the announcement of the support for Oracle 12c. For more details, refer to Support for Oracle Databases in the 2.9.1 release notes.
- Currently, when Proxy Update is used, it creates a new APIcast configuration version for the Staging environment with the updated settings. This will not be the case in future releases; users will need to use the new Proxy Config Promote endpoint for this purpose.
- Support for Redis 3.2 will be removed in future versions.