gravitee-kubernetes-operator

README

= Gravitee.io Kubernetes Operator

image:https://img.shields.io/badge/License-Apache%202.0-blue.svg["License", link="https://github.com/gravitee-io/gravitee-kubernetes-operator/blob/master/LICENSE.txt"]
image:https://circleci.com/gh/gravitee-io/gravitee-kubernetes-operator/tree/alpha.svg?style=svg[link="https://app.circleci.com/pipelines/github/gravitee-io/gravitee-kubernetes-operator?branch=alpha"]
image:https://goreportcard.com/badge/github.com/gravitee-io/gravitee-kubernetes-operator["Go Report Card", link="https://goreportcard.com/report/github.com/gravitee-io/gravitee-kubernetes-operator"]

++++
<picture>
  <source media="(prefers-color-scheme: dark)" srcset=".assets/gravitee-logo-dark.svg">
  <source media="(prefers-color-scheme: light)" srcset=".assets/gravitee-logo-light.svg">
  <img alt="Gravitee.io" width="400">
</picture>
++++

== Introduction

You can use the Gravitee Kubernetes Operator (GKO) to define, deploy, and publish APIs to your API Portal and API Gateway through Custom Resource Definitions (CRDs).

== User documentation

You can find detailed information about the Gravitee Kubernetes Operator in the following sections of the Gravitee user documentation:

  * link:https://documentation.gravitee.io/gravitee-kubernetes-operator-gko[Overview^]
  * link:https://documentation.gravitee.io/gravitee-kubernetes-operator-gko/overview/example-architecture[Architecture^]
  * link:https://documentation.gravitee.io/gravitee-kubernetes-operator-gko/getting-started/quickstart-guide[Quick Start^]
  * https://documentation.gravitee.io/gravitee-kubernetes-operator-gko/getting-started/installation[Installation and deployment^]

The GKO API reference documentation is available https://github.com/gravitee-io/gravitee-kubernetes-operator/blob/master/docs/api/reference.md[here^].

== Contributing

Details about how you can contribute to this repository are available in our contributing link:https://github.com/gravitee-io/gravitee-kubernetes-operator/blob/master/CONTRIBUTING.adoc[guide].