This project contains the APIcast operator software. APIcast operator is a piece of software based on Kubernetes operators that provides an easy way to install a 3scale APIcast self-managed solution, providing configurability options at the time of installation.

The functionalities and definitions are provided via Kubernetes custom resources which the operator is able to understand and process.

To get up and running quickly, check our Quickstart guides

Current capabilities state: Full Lifecycle

• Install a 3scale APIcast gateway self-managed solution
  • Using a 3scale Porta endpoint as the APIcast gateway configuration source
  • Providing the APIcast gateway configuration source from a configuration file via a pre-created Kubernetes Secret
• Upgrade from previously installed installed 3scale APIcast gateway self-managed solution
• Tune parameters of an already deployed 3scale APIcast gateway solution

Check our Operator user guide for interacting with the APIcast operator

You can contribute by:

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

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

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

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.