Readme file
3scale API Management makes it easy to manage your APIs.
Share, secure, distribute, control, and monetize your APIs on an infrastructure platform built for performance, customer control, and future growth.
The 3scale Operator creates and maintains the Red Hat 3scale API Management on OpenShift in various deployment configurations.
3scale Operator Features
Current capabilities state: Full Lifecycle
- Stable
- Installer: A way to install a 3scale API Management solution, providing configurability options at the time of installation
- Upgrade: Upgrade from previously installed 3scale API Management solution
- Reconciliation: Tunable CRD parameters after 3scale API Management solution has been installed
- Tech Preview
- Application Capabilities via Operator: Allow interacting with underlying 3scale API Management solution. Expose objects like tenant, product, backend as Custom Resource objects.
3scale Documentation
Before you begin
To deploying a 3scale instance, you need access with administrator privileges to an OpenShift Container Platform (OCP) 4.1 cluster.
Note: Deploy the 3scale operator and custom resource definitions (CRDs) in a separate newly created, empty project. If you deploy them in an existing project containing infrastructure, it could alter or delete existing elements.
Required resources
System requirements for installing 3scale on OpenShift
Installing the software
Deploying 3scale using the operator
Upgrading to a new version
Check the Upgrade Guide corresponding to the target 3scale version in the documentation.
Uninstalling the software
- Click Operators > OperatorHub. The installed Operators page is displayed.
- Enter 3scale into the Filter by name to find the Operator and click on it.
- On the Operator Details page, select Uninstall Operator from the Actions drop-down menu to remove it from a specific namespace.