Red Hat 3scale API Management Supported Configurations
General support for 3scale running on OpenShift
Support for 3scale API Management on OpenShift is defined in this knowledge article: Support of Red Hat Middleware products and components on Red Hat OpenShift. Please also reference the Red Hat OpenShift Container Platform Life Cycle Policy for details about the life cycle of each OpenShift release version.
3scale API Management Hosted
3scale API Management Hosted with APIcast API Gateway self-managed is being tested and supported with the latest two versions of APIcast API Gateway made available as part of the latest 3scale releases. Bug fixes and Security fixes will be provided on the latest release of APIcast, and only security fixes will be provided on the previous release.
3scale APIcast API Gateway is supported with deployment on OpenShift or as a container with the following configuration:
| Infrastructure component | Version |
|---|---|
| APIcast Gateway | 3.12, 3.13 (3scale-amp2/apicast-gateway-rhel8) |
| Red Hat OpenShift Container Platform (OCP)* | 4.8, 4.9, 4.10, 4.11, 4.12, 4.13 |
| Red Hat OpenShift Dedicated (OSD), Red Hat OpenShift Service on AWS (ROSA), Microsoft Azure Red Hat OpenShift (ARO) | 4.10. 4.11 |
| Red Hat Enterprise Linux + Podman | 8.x/9.x (RHEL) + 4.2.0/4.1.1 (Podman) |
* Red Hat OpenShift Kubernetes Engine which offers a subset of the features of OpenShift Container Platform is supported.
3scale APIcast API Gateway has been tested and it's supported with the following versions of Redis:
| Product | Version |
|---|---|
| Redis | 6.2 |
3scale API Management Hosted has been tested and it's supported with the following versions of Red Hat Single Sign-On:
| Product | Version |
|---|---|
| Red Hat Single Sign-On | 7.5*, 7.6 |
* Support for 3scale’s integration with Red Hat Single Sign On v.7.5 is deprecated and will be discontinued in future releases.
3scale API Management Hosted has been tested and it's supported with the following browsers:
| Browser | Version |
|---|---|
| Google Chrome | 107 |
| Firefox | 105 |
| Microsoft Edge | 107 |
3scale API Management Hosted has been tested and it's supported with the following payment gateways:
| Payment gateway |
|---|
| Braintree |
| Stripe |
Interactive documentation feature (ActiveDocs) of 3scale API Management Hosted supports the following API specifications:
| API Specification | Version |
|---|---|
| OpenAPI Specification (OAS) | 3.0 |
| OpenAPI Specification (OAS) | 2.0 (formerly known as Swagger 2.0) |
3scale Toolbox has been tested and it's supported with deployment as a container with the following configuration:
| Platform | Toolbox version |
|---|---|
| Red Hat Enterprise Linux 8 and 9 | 0.20.0 (3scale-amp2/toolbox-rhel7) |
3scale API Management 2.13
3scale API Management is being tested and supported using the following configurations. As per Middleware Life Cycle policy, bug fixes and Security fixes will be provided on the current version of 3scale API Management, and only security fixes will be provided also on the previous release.
3scale API Management 2.13 is supported on the following versions of OpenShift:
| OpenShift product | Version | Chipset Architecture |
|---|---|---|
| Red Hat OpenShift Container Platform (OCP) | 4.8, 4.9, 4.10, 4.11, 4.121, 4.132 | x86_64, ppc64le3,s390x4 |
| Red Hat OpenShift Dedicated (OSD), Red Hat OpenShift Service on AWS (ROSA)5, Microsoft Azure Red Hat OpenShift (ARO) | 4.10, 4.11 | N/A |
For extended information about support for Red Hat Middleware products and components on Red Hat OpenShift see this page.
1. Support for Red Hat OpenShift Container Platform 4.12 was introduced in 3scale 2.13.1.
2. Support for Red Hat OpenShift Container Platform 4.13 was introduced in 3scale 2.13.3.
3. IBM Power supports Red Hat 3scale API Management on OpenShift Container Platform 4.9, 4.10 and 4.11 only; see additional notes.
4. IBM Z and LinuxONE supports Red Hat 3scale API Management on OpenShift Container Platform 4.10 and 4.11 only; see additional notes.
5. Red Hat 3scale API Management is not compatible with the AWS Security Token Service (STS). Use IAM credential access if using a ROSA cluster with STS. STS support will be included in future releases.
3scale API Management 2.13 has been tested and it's supported with the following versions of Red Hat Single Sign-On:
| Product | Version |
|---|---|
| Red Hat Single Sign-On | 7.5*, 7.6 |
* Support for 3scale’s integration with Red Hat Single Sign On v.7.5 is deprecated and will be discontinued in future releases.
3scale API Management 2.13 has been tested and it's supported with the following browsers:
| Browser | Version |
|---|---|
| Google Chrome | 107 |
| Firefox | 105 |
| Microsoft Edge | 107 |
3scale API Management 2.13 has been tested and it’s supported with the following databases:
| Database | Version |
|---|---|
| MySQL | 8.0 |
| Redis | 6.2 |
| Oracle DB* | 19 |
| PostgreSQL | 13 |
* In line with Oracle's recommendations, we advise using a CDB architecture. Non-CDB configurations may be unsupported in future releases.
3scale API Management 2.13 System component has been tested and it’s supported with the following file storage configurations:
| File storage |
|---|
| Persistent Volume Claims (PVC) with RWX access mode* |
| Amazon Simple Storage Service (S3) compatible storages |
* NFS is not suitable storage for production environments except when used for the system-storage volume.
3scale API Management 2.13 has been tested and it’s supported with the following payment gateways:
| Payment gateway |
|---|
| Braintree |
| Stripe |
Interactive documentation feature (ActiveDocs) of 3scale API Management 2.13 supports the following API specifications:
| API Specification | Version |
|---|---|
| OpenAPI Specification (OAS) | 3.0 |
| OpenAPI Specification (OAS) | 2.0 (formerly known as Swagger 2.0) |
3scale APIcast API Gateway is supported with deployment on OpenShift or as a container with the following configuration:
| Infrastructure component | Version |
|---|---|
| APIcast Gateway | 3.12, 3.13 (3scale-amp2/apicast-gateway-rhel8) |
| Red Hat OpenShift Container Platform (OCP)1 | 4.8, 4.9, 4.10, 4.11, 4.122, 4.133 |
| Red Hat Enterprise Linux + Podman | 8.x/9.x (RHEL) + 4.2.0/4.1.1 (Podman) |
1. Red Hat OpenShift Kubernetes Engine which offers a subset of the features of OpenShift Container Platform is supported.
2. Support for Red Hat OpenShift Container Platform 4.12 was introduced in 3scale 2.13.1.
3. Support for Red Hat OpenShift Container Platform 4.13 was introduced in 3scale 2.13.3.
3scale Toolbox has been tested and it's supported with deployment as a container with the following configuration:
| Platform | Toolbox version |
|---|---|
| Red Hat Enterprise Linux 8 and 9 | 0.20.0 (3scale-amp2/toolbox-rhel7) |
Support for IBM Power, IBM Z and LinuxONE
IBM Power (ppc64le) supports Red Hat 3scale API Management on Red Hat OpenShift Container Platform 4.9, 4.10 and 4.11 only.
IBM Z and LinuxONE (s390x) supports Red Hat 3scale API management on Red HatOpenShift Container Platform 4.10 and 4.11 only.
These features are not supported for IBM Power, IBM Z and LinuxONE:
- Self-managed APIcast on Podman on top of RHEL 8/9
- Redis HA
- S3 API compatible file storage - Minio
- Deployment in disconnected (air-gapped) OCP environment
These features are not supported for IBM Z and LinuxONE:
- MYSQL 8 external
- PostgreSQL 13.x external
- Oracle DB
3scale API Management 2.x
Redis, MySQL, Memcached, and Sphinx support
3scale API Management 2.x is reliant on the Redis, MySQL, Memcached, Sphinx, and PostgreSQL community versions and as such, Red Hat's support for Redis, MySQL, Memcached, Sphinx, and PostgreSQL is limited to its intended use as documented in the quickstarts and templates. We will offer a commercially reasonable effort to support Redis, MySQL, Memcached, Sphinx, and PostgreSQL, however, we may not be able to provide or influence timely patches.
Previous 3scale versions
- 3scale 2.12 supported configurations
- 3scale 2.11 supported configurations
- 3scale 2.10 supported configurations
- 3scale 2.9 supported configurations
- 3scale 2.8 supported configurations
- 3scale 2.7 supported configurations
- 3scale 2.6 supported configurations
- 3scale 2.5 supported configurations
- 3scale 2.4 supported configurations
- 3scale 2.3 supported configurations
- 3scale 2.2 supported configurations
- 3scale 2.1 supported configurations
- 3scale 2.0 supported configurations
2 Comments
For Oracle 19c it says that "Non-CDB configurations may be unsupported in future releases".
What is this referring to exactly? unsupported by future releases of 3scale? or unsupported by future releases of Oracle?
Both. Oracle deprecated the non-CDB architecture in version 12c, release 1 (12.1). Starting, with Oracle Database 21c, non-CDB architecture is finally unsupported. For now, 3scale aligns with Oracle and keeps supporting it for Oracle DB 19c configurations, but we may decide to drop support for non-CDB in future releases.