3scale-operator

module
v0.6.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 5, 2020 License: Apache-2.0

README

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.

Directories

Path Synopsis
cmd
pkg
apis/apps
Package apps contains apps API versions.
Package apps contains apps API versions.
apis/apps/v1alpha1
Package v1alpha1 contains API Schema definitions for the apps v1alpha1 API group +k8s:deepcopy-gen=package,register +groupName=apps.3scale.net Package v1alpha1 contains API Schema definitions for the apps v1alpha1 API group +k8s:deepcopy-gen=package,register +groupName=apps.3scale.net
Package v1alpha1 contains API Schema definitions for the apps v1alpha1 API group +k8s:deepcopy-gen=package,register +groupName=apps.3scale.net Package v1alpha1 contains API Schema definitions for the apps v1alpha1 API group +k8s:deepcopy-gen=package,register +groupName=apps.3scale.net
apis/capabilities
Package capabilities contains capabilities API versions.
Package capabilities contains capabilities API versions.
apis/capabilities/v1alpha1
Package v1alpha1 contains API Schema definitions for the capabilities v1alpha1 API group +k8s:deepcopy-gen=package,register +groupName=capabilities.3scale.net Package v1alpha1 contains API Schema definitions for the capabilities v1alpha1 API group +k8s:deepcopy-gen=package,register +groupName=capabilities.3scale.net
Package v1alpha1 contains API Schema definitions for the capabilities v1alpha1 API group +k8s:deepcopy-gen=package,register +groupName=capabilities.3scale.net Package v1alpha1 contains API Schema definitions for the capabilities v1alpha1 API group +k8s:deepcopy-gen=package,register +groupName=capabilities.3scale.net
apis/capabilities/v1beta1
Package v1beta1 contains API Schema definitions for the capabilities v1beta1 API group +k8s:deepcopy-gen=package,register +groupName=capabilities.3scale.net Package v1beta1 contains API Schema definitions for the capabilities v1beta1 API group +k8s:deepcopy-gen=package,register +groupName=capabilities.3scale.net
Package v1beta1 contains API Schema definitions for the capabilities v1beta1 API group +k8s:deepcopy-gen=package,register +groupName=capabilities.3scale.net Package v1beta1 contains API Schema definitions for the capabilities v1beta1 API group +k8s:deepcopy-gen=package,register +groupName=capabilities.3scale.net
assets
Package assets Code generated by go-bindata.
Package assets Code generated by go-bindata.
test
e2e

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL