Skip to content

Openshift operator to install a 3scale API Management solution

License

Notifications You must be signed in to change notification settings

3scale/3scale-operator

Repository files navigation

3scale-operator

CircleCI License GitHub release codecov

Overview

The 3scale Operator creates and maintains the Red Hat 3scale API Management on OpenShift in various deployment configurations. 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.

Quickstart

To get up and running quickly, check our Quickstart guides.

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.

User Guide

Contributing

You can contribute by:

  • Raising any issues you find using 3scale Operator
  • Fixing issues by opening Pull Requests
  • Submitting a patch or opening a PR
  • Improving documentation
  • Talking about 3scale Operator

All bugs, tasks or enhancements are tracked as GitHub issues.

The Development guide describes how to build the 3scale Operator and how to test your changes before submitting a patch or opening a PR.

Licensing

This software is licensed under the Apache 2.0 license.

See the LICENSE and NOTICE files that should have been provided along with this software for details.