Red Hat OpenShift API Management is a new managed application service designed as an add-on to Red Hat OpenShift Dedicated. The service provides developers with a streamlined experience when developing and delivering microservices applications with an API-first approach.
OpenShift API Management was built on the success of 3scale API Management and designed to let developers easily share, secure, reuse, and discover APIs when developing applications. This article shows you how to install OpenShift API Management as an add-on to your OpenShift Dedicated cluster. As you will see, it takes less than 10 minutes to install, configure, administer, and be up and running with OpenShift API Management. Check the end of the article for the included video demonstration.
Step 1: Get OpenShift Dedicated
You will need an OpenShift Dedicated subscription to provision a cluster to run Red Hat OpenShift API Management.
Start by provisioning your cluster:
- Log in to your account on cloud.redhat.com/openshift.
- Open the Red Hat OpenShift Cluster Manager.
- Create a cluster by selecting Red Hat OpenShift Dedicated.
- Choose your cloud provider.
- Fill in all the cluster configuration details: Cluster names, regions, availability zones, computer nodes, node instance type, CIDR ranges (these are optional, but cannot be modified at a later date), and so on.
- Submit your request and wait for the cluster to be provisioned.
Step 2: Select and configure an identity provider
Once your cluster is ready, you can configure your preferred identity provider (IDP)
To start, select and configure your identity provider (IDP) from the drop-down menu. Options include GitHub, Google, OpenID, LDAP, GitLab, and other providers that support OpenID flows.
After you have configured your IDP, you will need to add at least one user to the dedicated-admins group. Click Add user within the Cluster administrative users section, then enter the username of the new dedicated-admin user.
Access levels vary per organization. Any user that requires full access should be defined as an administrator. As an administrator, you can use 3scale API Management and OpenShift's role-based access control (RBAC) features to limit other users' access.
Step 3: Install OpenShift API Management
The process to install OpenShift API Management is straightforward. From the cluster details page, you can navigate to the Add-ons tab and find the services available to you. Here's the setup:
- Go to the Add-ons tabs on the cluster details page.
- Choose Red Hat OpenShift API Management and hit Install.
- Provide the email address for the account that will receive service-related alerts and notifications.
- Click Install again to allow the Operators to install and configure the service.
After installing the add-on, you can access the service via the Application Launcher menu located in the OpenShift Dedicated console's top-right corner. The Application Launcher provides direct access to the OpenShift API Management and Red Hat single sign-on (SSO) technology service UIs.
Watch the video demonstration
Check out the following video to see the OpenShift API Management installation steps in action:
Using OpenShift API Management
There you go! Getting OpenShift API Management installed and running on your OpenShift Dedicated cluster is as simple as the steps described here. Now you can start using the service. Check out the following resources to get going:
- Familiarize yourself with Red Hat OpenShift API Management.
- Use OpenShift​ API Management to deploy and manage your own Quarkus API.
- Learn more about Red Hat OpenShift and your cluster by following a quickstart from the OpenShift developer perspective.
