README
¶
3scale-operator
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
- Check our Operator user guide for interacting with the 3scale operator.
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.
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
apis
|
|
|
apps/v1alpha1
Package v1alpha1 contains API Schema definitions for the apps v1alpha1 API group +kubebuilder:object:generate=true +groupName=apps.3scale.net
|
Package v1alpha1 contains API Schema definitions for the apps v1alpha1 API group +kubebuilder:object:generate=true +groupName=apps.3scale.net |
|
capabilities/v1alpha1
Package v1alpha1 contains API Schema definitions for the capabilities v1alpha1 API group +kubebuilder:object:generate=true +groupName=capabilities.3scale.net
|
Package v1alpha1 contains API Schema definitions for the capabilities v1alpha1 API group +kubebuilder:object:generate=true +groupName=capabilities.3scale.net |
|
capabilities/v1beta1
Package v1beta1 contains API Schema definitions for the capabilities v1beta1 API group +kubebuilder:object:generate=true +groupName=capabilities.3scale.net
|
Package v1beta1 contains API Schema definitions for the capabilities v1beta1 API group +kubebuilder:object:generate=true +groupName=capabilities.3scale.net |
|
controllers
|
|
|
pkg
|
|
|
assets
Package assets generated by go-bindata.// sources: assets/monitoring/apicast-grafana-dashboard-1.json.tpl assets/monitoring/apicast-grafana-dashboard-2.json.tpl assets/monitoring/backend-grafana-dashboard-1.json.tpl assets/monitoring/kubernetes-resources-by-namespace-grafana-dashboard-1.json.tpl assets/monitoring/kubernetes-resources-by-pod-grafana-dashboard-1.json.tpl assets/monitoring/system-grafana-dashboard-1.json.tpl assets/monitoring/zync-grafana-dashboard-1.json.tpl
|
Package assets generated by go-bindata.// sources: assets/monitoring/apicast-grafana-dashboard-1.json.tpl assets/monitoring/apicast-grafana-dashboard-2.json.tpl assets/monitoring/backend-grafana-dashboard-1.json.tpl assets/monitoring/kubernetes-resources-by-namespace-grafana-dashboard-1.json.tpl assets/monitoring/kubernetes-resources-by-pod-grafana-dashboard-1.json.tpl assets/monitoring/system-grafana-dashboard-1.json.tpl assets/monitoring/zync-grafana-dashboard-1.json.tpl |