https://github.com/Kong/kong-operator

Kong Operator for Kubernetes and OpenShift
https://github.com/Kong/kong-operator

Last synced: 14 days ago
JSON representation

Kong Operator for Kubernetes and OpenShift

• Host: GitHub
• URL: https://github.com/Kong/kong-operator
• Owner: Kong
• License: apache-2.0
• Archived: true
• Created: 2019-03-28T19:40:10.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2023-05-13T03:33:04.000Z (over 1 year ago)
• Last Synced: 2024-08-01T17:37:37.563Z (3 months ago)
• Language: Mustache
• Homepage: https://konghq.com
• Size: 379 KB
• Stars: 58
• Watchers: 11
• Forks: 27
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Codeowners: CODEOWNERS
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# Kong Operator

[![][kong-logo]][kong-url]

![Test status badge](https://github.com/Kong/kong-operator/workflows/Test/badge.svg)

[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/Kong/kong-operator/blob/main/LICENSE)

[![Twitter](https://img.shields.io/twitter/follow/thekonginc.svg?style=social&label=Follow)](https://twitter.com/intent/follow?screen_name=thekonginc)

---

# Deprecation Notice

**Use of this operator for new Kong installations is discouraged in favor of the [kubectl](https://docs.konghq.com/gateway/2.7.x/install-and-run/kubernetes/) and [Helm](https://docs.konghq.com/gateway/2.7.x/install-and-run/helm/) installation methods. This operator is being deprecated in favor of a replacement based on Golang (instead of Helm). During the version `v0.x.x` lifecycle of this tool we decided that Helm did not suite our needs for a robust feature-rich operator. Security updates for this repository will be continued for the time being; but new features and other requests will not be prioritized. You can track the progress of the successor operator [here](https://incubator.konghq.com/p/gateway-operator/) and we highly encourage feature requests and discussions on the [new operator repository](https://github.com/Kong/gateway-operator-docs) to let us know your use cases and needs.**

---

**Kong Operator** is a Kubernetes [operator](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/) which manages [Kong Ingress Controller](https://github.com/Kong/kubernetes-ingress-controller/) instances.

With Kong Operator running in your cluster, you can spin up multiple instances of Kong, each of them configured by a `Kong` custom resource ([example][kong-cr-example]). See the [Quick Start][section-quick-start] section below to get up and running.

## Supported Kubernetes versions

* Kubernetes v1.15+

    * Try it out: Kong Operator runs on [microk8s][microk8s] but requires `dns` and `rbac` microk8s addons.

    * Note: Kong Ingress Controller v0.9 does not support the `spec.ingressClassName` field introduced in Kubernetes v1.18. Instead, use the (deprecated in v1.18) `kubernetes.io/ingress.class` annotation.

* OKD v4.3+

## Quick Start

1. Deploy kong-operator:

    1. Navigate to the [Kong operator at OperatorHub][operatorhub-kong].

    1. Click "Install".

    1. Follow the instructions described in the pop-up in order.

1. Deploy a Kong Ingress Controller with `example-ingress-class` Ingress class (see [_Configuration_ section][section-configuration] for available options):

    ```

    kubectl create -f - <