kubernetes-ingress-controller

module
v2.12.4 Latest Latest
Warning

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

Go to latest
Published: Apr 30, 2024 License: Apache-2.0

README

Build Status Go Reference Codecov License Twitter

Kong Ingress Controller for Kubernetes (KIC)

Use Kong for Kubernetes Ingress. Configure plugins, health checking, load balancing, and more in Kong for Kubernetes Services, all using Custom Resource Definitions (CRDs) and Kubernetes-native tooling.

Features | Get started | Documentation | main branch builds | Seeking help

Features

  • Ingress routing Use Ingress resources to configure Kong.
  • Enhanced API management using plugins Use a wide array of plugins to monitor, transform and protect your traffic.
  • Native gRPC support Proxy gRPC traffic and gain visibility into it using Kong's plugins.
  • Health checking and Load-balancing Load balance requests across your pods and supports active & passive health-checks.
  • Request/response transformations Use plugins to modify your requests/responses on the fly.
  • Authentication Protect your services using authentication methods of your choice.
  • Declarative configuration for Kong Configure all of Kong using CRDs in Kubernetes and manage Kong declaratively.
  • Gateway Discovery Monitors your Kong Gateways and pushes configuration to all replicas.

Get started

You can use Minikube or Kind on your local machine or use a hosted Kubernetes service like GKE.

Setting up Kong for Kubernetes is as simple as:

# using YAMLs
$ kubectl apply -f https://raw.githubusercontent.com/Kong/kubernetes-ingress-controller/latest/deploy/single/all-in-one-dbless.yaml

# or using Helm
$ helm repo add kong https://charts.konghq.com
$ helm repo update

# Helm 3
$ helm install kong/kong --generate-name --set ingressController.installCRDs=false

Once installed, please follow the Getting Started guide to start using Ingress in your Kubernetes cluster.

Note: Kong Enterprise users, please follow along with our enterprise guide to setup the enterprise version.

Container images

Release images

Release builds of Kong Ingress Controller can be found on Docker Hub in kong/kubernetes-ingress-controller repository.

At the moment we're providing images for:

  • Linux amd64
  • Linux arm64
main branch builds

Nightly pre-release builds of the main branch are available from the kong/nightly-ingress-controller repository hosted on Docker Hub:

main contains unreleased new features for upcoming minor and major releases:

docker pull kong/nightly-ingress-controller:nightly

Documentation

All documentation for the Kong Ingress Controller is present in the kong/docs.konghq.com repository. Pull Requests are welcome for additions and corrections.

Guides and Tutorials

Please browse through the guides to get started and to learn specific ingress controller operations.

Contributing

We ❤️ pull requests and we’re continually working hard to make it as easy as possible for developers to contribute. Before beginning development with the Kong Ingress Controller, please familiarize yourself with the following developer resources:

Seeking help

Please search through the FAQs, posts on the discussions page or the Kong Nation Forums as it's likely that another user has run into the same problem. If you don't find an answer, please feel free to post a question.

If you've found a bug, please open an issue.

For a feature request, please open an issue using the feature request template.

You can also talk to the developers behind Kong in the #kong channel on the Kubernetes Slack server.

Community meetings

You can join monthly meetups hosted by Kong to ask questions, provide feedback, or just to listen and hang out. See the Online Meetups Page to sign up and receive meeting invites and Zoom links.

Preview and Experimental Features

At any time the KIC may include features or options that are considered experimental and are not enabled by default, nor available in the Kong Documentation Site.

To try out new features that are behind feature gates, please see the preview features in FEATURE_GATES.md and documentation for these preview features can be found in FEATURE_PREVIEW_DOCUMENTATION.md.

Directories

Path Synopsis
hack
cleanup
This script cleans up orphaned GKE clusters and Konnect runtime groups that were created by the e2e tests (caued by e.g.
This script cleans up orphaned GKE clusters and Konnect runtime groups that were created by the e2e tests (caued by e.g.
internal
admission/validation/consumers/credentials
Package credentials includes validators for the credentials provided for KongConsumers.
Package credentials includes validators for the credentials provided for KongConsumers.
cmd
cmd/rootcmd
Package rootcmd implements the cobra.Command that manages the controller manager lifecycle.
Package rootcmd implements the cobra.Command that manages the controller manager lifecycle.
controllers/configuration
Package configuration contains Kubernetes controllers responsible for configuration.konghq.com grouped API types.
Package configuration contains Kubernetes controllers responsible for configuration.konghq.com grouped API types.
dataplane
Package dataplane provides functionality for communicating with and providing configuration to backend dataplane APIs.
Package dataplane provides functionality for communicating with and providing configuration to backend dataplane APIs.
manager
Package manager implements the controller manager for all controllers
Package manager implements the controller manager for all controllers
manager/metadata
Package metadata includes metadata variables for logging and reporting.
Package metadata includes metadata variables for logging and reporting.
pkg
apis/configuration/v1
Package v1 contains API Schema definitions for the konghq.com v1 API group.
Package v1 contains API Schema definitions for the konghq.com v1 API group.
apis/configuration/v1alpha1
Package v1alpha1 contains API Schema definitions for the configuration.konghq.com v1alpha1 API group.
Package v1alpha1 contains API Schema definitions for the configuration.konghq.com v1alpha1 API group.
apis/configuration/v1beta1
Package v1beta1 contains API Schema definitions for the configuration.konghq.com v1beta1 API group.
Package v1beta1 contains API Schema definitions for the configuration.konghq.com v1beta1 API group.
clientset
This package has the automatically generated clientset.
This package has the automatically generated clientset.
clientset/fake
This package has the automatically generated fake clientset.
This package has the automatically generated fake clientset.
clientset/scheme
This package contains the scheme of the automatically generated clientset.
This package contains the scheme of the automatically generated clientset.
clientset/typed/configuration/v1
This package has the automatically generated typed clients.
This package has the automatically generated typed clients.
clientset/typed/configuration/v1/fake
Package fake has the automatically generated clients.
Package fake has the automatically generated clients.
clientset/typed/configuration/v1alpha1
This package has the automatically generated typed clients.
This package has the automatically generated typed clients.
clientset/typed/configuration/v1alpha1/fake
Package fake has the automatically generated clients.
Package fake has the automatically generated clients.
clientset/typed/configuration/v1beta1
This package has the automatically generated typed clients.
This package has the automatically generated typed clients.
clientset/typed/configuration/v1beta1/fake
Package fake has the automatically generated clients.
Package fake has the automatically generated clients.
scripts
e2e

Jump to

Keyboard shortcuts

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