Release Notes for Red Hat 3scale API Management 2.8 On-premises

Red Hat 3scale API Management 2.8

Document intended for use with Red Hat 3scale API Management 2.8

Red Hat Customer Content Services

Abstract

This document informs users about the latest and Technology Preview features, as well as resolved issues, associated documentation, and known issues in Red Hat 3scale API Management 2.8

Preface

This document is intended for use with Red Hat 3scale API Management 2.8 and related patch releases.

Chapter 1. Red Hat 3scale API Management 2.8.2 - Patch release

This document is intended for use with Red Hat 3scale API Management 2.8.2 On-premises.

1.1. Resolved issues

  • With certain special characters to map API product endpoints to the corresponding backends via mapping rules, the generated URL address was not correct. Now, 3scale accurately parses the mapping to generate URL addresses (JIRA #5125).

Chapter 2. Red Hat 3scale API Management 2.8.1 - Patch release

This document is intended for use with Red Hat 3scale API Management 2.8.1 On-premises.

2.1. Resolved issues

  • 3scale upgrade from 2.7 to 2.8 runs successfully on a template-based deployment with an Oracle Database (JIRA #4767).
  • APIcast operator now creates Ingress objects (JIRA #4785).
  • Now, the Routing policy only matches paths that start with the routing path of the backend (JIRA #4736).

Chapter 3. Red Hat 3scale API Management 2.8

This document is intended for use with Red Hat 3scale API Management 2.8 On-premises.

3.1. New features

3.1.1. Major features

  • Introducing support for OpenAPI Specification (OAS) 3.0, with the following advantages:

    • Use OAS 3.0 specifications to generate ActiveDocs interactive API documentation (JIRA #770).
    • The import command in 3scale toolbox now supports OAS 3.0 (JIRA# 2995).
  • 3scale toobox is now compatible with the APIs as a Product model introduced in 3scale 2.7 for separating internal APIs (backends) from customer-facing APIs (products) (JIRA #3502).
  • New APIcast self-managed operator for deploying the gateway using operators (JIRA #3997).
  • APIcast gateway support for HTTP2 and gRPC connections (JIRA #3271).
  • WebSocket protocol connections to backend APIs are now supported (JIRA #4019).

3.1.2. Minor features

  • Improved the functionality of audit logs by tracking application key changes (JIRA #3733).
  • Now you can deploy 3scale using storage compatible options with S3 API for system (JIRA #3868).
  • Operator exposes release version in the metrics endpoint (JIRA #4047).
  • Logging policy extended to add support to log JWT payloads (JIRA #4326).
  • Now you can search logs by request, due to the addition of request_id (JIRA #4262).
  • Captcha element in the password reset form as a measure to boost security (JIRA #1135).

  • Enhancements in 3scale toolbox command line interface (CLI):

    • You can customize the secret token used to authenticate the backend API when importing OpenAPI specifications (JIRA #3764).
    • New capability to provide parseable outputs such as JSON or YAML (JIRA #2348).
    • Now it is possible to filter ActiveDocs by service identifiers in the list command (JIRA #2967).
    • You can add the --prefix-matching option to the import openapi command (JIRA #3742).
  • Now, the events performed by making calls to internal 3scale APIs also trigger webhooks. This only applies for API calls utilizing user access tokens, not with provider keys. Prior to this change, only actions in the user interface triggered webhooks (JIRA #4703).

3.2. Technology Preview features

  • High Availability (HA) and Evaluation (Eval) OpenShift templates (JIRA #1168).
  • Provisioning of 3scale services and configurations via the operator: 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).

3.3. Resolved issues

  • Application show view is rendered correctly when a 404 Not Found message is returned (JIRA #942).
  • Reviewed error messages for the capture and assign liquid variables (JIRA #1911).
  • Included validation to limit the number of characters of proxy domains (JIRA #2932).
  • When you change the OIDC Authorization Flow in 3scale, Zync now updates the Red Hat Single Sign-On (RH-SSO) clients of 3scale applications (JIRA #3025).
  • The copy command now copies the selected OIDC Flow (JIRA #3031).
  • Now you can see the full hint message for private URLs with HTTP scheme (JIRA #3269).
  • Corrected error message when creating a new API using an invalid system_name (JIRA #3394).
  • Escaped characters in the URI are now honored (JIRA #3468).
  • Fields are now shown in JWT Claim Check policy (JIRA #3509).
  • Improved performance of the authorization when the OIDC configuration cannot be initialized (JIRA #3809).
  • Settings for external databases are deployed correctly (JIRA #3861).
  • After reordering policies, now you can see the Update Policy Chain button enabled (JIRA #3941).
  • Liquid value matches correctly when JWT_CLAIM contains special chars (JIRA #3968).
  • Flash message at top of the page is now visible (JIRA #4028).
  • Changes you make for OIDC Authorization Flow settings in the Admin Portal are now saved (JIRA #4162).
  • Enhanced performance of the URL Rewriting policy (JIRA #4301).
  • The JSON file containing proxy configuration now includes the querystring_parameters field (JIRA #4385).

3.4. Known issues

  • 3scale upgrade from 2.7 to 2.8 fails on a template-based deployment with an Oracle Database (JIRA #4767).
  • Developer Portal: the password reset email is not sent (JIRA #4777).
  • APIcast operator cannot create Ingress objects (JIRA #4785).
  • Host header is not configured if HTTP_PROXY is set (JIRA #4178).
  • ProxyRule removes trailing slashes (JIRA #3872).

3.5. Documentation

Supported configurations

Security updates

Upgrade guides

  • Check the procedures to upgrade your 3scale installation from 2.7 to 2.8, for the following deployments:

  • A post-upgrade step for provisioning APIs in the Developer Portal has been added. For more information, see the Preface in the Migrating 3scale guide.

Known issues in documentation

  • Pending document about how to deploy APIcast self-managed using operator (JIRA #4094).

3.6. Changes in 3scale

This section lists the removed features and future changes for 3scale 2.8.

3.6.1. Removed features

  • Following the deprecation announced in 3scale 2.7, compatibility with OpenAPI Specification (OAS) 1.2 is no longer supported. OAS 2.0 and OAS 3.0 are the supported API specifications for ActiveDocs, the interactive documentation feature.
  • As announced in 3scale 2.7, the integration settings for legacy and unsupported code plugins have been completely removed from the Admin Portal.

3.6.2. Future changes

  • 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.

Legal Notice

Copyright © 2022 Red Hat, Inc.
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 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.