Release Notes for Red Hat OpenShift API Management

Guide
  • Red Hat OpenShift API Management 1
  • Updated 26 December 2023
  • Published 08 December 2020

Release Notes for Red Hat OpenShift API Management

Guide
Red Hat OpenShift API Management 1
  • Updated 26 December 2023
  • Published 08 December 2020

Available as an add-on to OpenShift Dedicated, Red Hat OpenShift API Management is based on the Red Hat 3scale API Management platform and also includes an implementation of Red Hat Single Sign-On. This document provides high-level coverage of the components in Red Hat OpenShift API Management and documents known issues in this release.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. We are beginning with these four terms: master, slave, blacklist, and whitelist. Due to the enormity of this endeavor, these changes will be gradually implemented over upcoming releases. For more details on making our language more inclusive, see our CTO Chris Wright’s message.

Component versions

This release includes capabilities from:

The documentation for the products above was developed for customers who are installing and configuring these products on-premises on OpenShift Container Platform. Red Hat OpenShift API Management is a service that is hosted and managed by Red Hat and references to installation and configuration procedures in that documentation are not relevant for Red Hat OpenShift API Management customers.

New features

Support for Red Hat OpenShift Service on AWS

  • Red Hat OpenShift API Management is now available as an add-on to the Red Hat OpenShift Service on AWS, which is a fully-managed OpenShift service jointly managed and supported by both Red Hat and Amazon Web Services (AWS). For more information about adding Red Hat OpenShift API Management to your Red Hat OpenShift Service on AWS, see Adding OpenShift API Management to your Red Hat OpenShift Service on AWS cluster.

Billing support added for monetizing APIs

  • Red Hat OpenShift API Management has achieved Payment Card Industry Data Security Standard (PCI DSS) Compliance Certification. You can now monetize subscriptions to your APIs by defining payment gateways. For more information, see Credit card gateways for payments.

Dynamic daily rate limit quota configuration in the OpenShift Cluster Manager user interface

  • Modify the daily rate limit quota to optimize resource consumption in Red Hat OpenShift API Management. You can change the active daily rate limit selected during installation, in the OpenShift Cluster Manager. You can not select a daily rate limit quota that exceeds the SKU specified and assigned during the purchase of the OpenShift API Management service. For more information about resource consumption in OpenShift API Management, see the service defintion.

Known issues

Usernames are limited to 40 characters

  • Red Hat OpenShift API Management and Red Hat 3scale API Management have a 40 character limit for usernames for IDP configuration.

Users cannot share an email address

  • Multiple users can not use the same email address for IDP configuration in Red Hat 3scale API Management and Red Hat Single Sign-On.

The Red Hat 3scale API Management Invite feature is unsupported in Red Hat OpenShift API Management at this time

  • All users can access the 3scale Admin Portal through the Red Hat OpenShift API Management service. Although the Admin Portal appears to have the capability to invite new users, this feature is not supported in Red Hat OpenShift API Management. To add users to the Admin Portal, you must add them through the identity provider that you configured for your OpenShift Dedicated cluster. For more information, see Configuring identity providers.

The Red Hat OpenShift API Management add-on displays an installed status before the OpenShift API Management is fully installed and ready to use in the cluster

  • The Red Hat OpenShift API Management operator adds OpenShift API Management to your cluster. The OpenShift API Management operator includes sub-operators that must be installed to successfully complete installation. Currently, the add-on prematurely displays it has successfully installed the Red Hat OpenShift API Management operator before installation is complete. To verify installation is complete, click View console on the Red Hat OpenShift API Management option in OpenShift Cluster Manager to view the OpenShift API Management operator details and check the operator status in the console.

Red Hat OpenShift API Management users may receive alerts in the OpenShift Dedicated console and OpenShift Cluster Manager

  • Thanos alerts may be displayed in the OpenShift user interface after Red Hat OpenShift API Management is added to an Red Hat OpenShift Dedicated or Red Hat OpenShift Service on AWS cluster. Some of the alerts are related to the webhook pods for the MARIN3R operator, when the Thanos query for the MARIN3R operator webhook pods checks the wrong namespace. The Thanos related alerts can be ignored and will not cause any disruption to your Red Hat OpenShift API Management service.