Skip to content
Kong Logo | Kong Docs Logo
search
  • We're Hiring!
  • Docs
    • Kong Gateway
    • Kong Konnect
    • Kong Mesh
    • Plugin Hub
    • decK
    • Kubernetes Ingress Controller
    • Insomnia
    • Kuma

    • Docs contribution guidelines
  • Plugin Hub
  • Support
  • Community
  • Kong Academy
Get a Demo Start Free Trial
  • Kong Gateway
  • Kong Konnect
  • Kong Mesh
  • Plugin Hub
  • decK
  • Kubernetes Ingress Controller
  • Insomnia
  • Kuma

  • Docs contribution guidelines
  • 3.3.x (latest)
  • 3.2.x
  • 3.1.x
  • 3.0.x
  • 2.8.x
  • 2.7.x
  • 2.6.x
  • Older Enterprise versions (2.1-2.5)
  • Older OSS versions (2.1-2.5)
  • Archive (pre-2.1)

github-edit-pageEdit this page

report-issueReport an issue

enterprise-switcher-iconSwitch to OSS

On this pageOn this page
  • Prerequisites
  • Create namespace
  • Create license secret
  • Deploy
  • Next steps
Kong Gateway
2.8.x
  • Home
  • Kong Gateway
  • Install And Run
  • Install on Kubernetes
You are browsing documentation for an outdated version. See the latest documentation here.

Install on Kubernetes

This page explains how to install Kong Gateway with Kubernetes Ingress Controller in DB-less mode. To install with a database, see the documentation on installing with Helm.

This page also includes the equivalent commands for OpenShift.

In DB-less mode on Kubernetes, the config is stored in etcd, the Kubernetes native data store. For more information, see Kubernetes Deployment Options.

The Kong Gateway software is governed by the Kong Software License Agreement. Kong Gateway (OSS) is licensed under an Apache 2.0 license.

Prerequisites

  • A Kubernetes cluster, v1.19 or later
  • kubectl v1.19 or later
  • (Enterprise only) A license.json file from Kong

Create namespace

Create the namespace for Kong Gateway with Kubernetes Ingress Controller. For example:

## on Kubernetes native
kubectl create namespace kong
## on OpenShift
oc new-project kong

Create license secret

  1. Save your license file temporarily with the filename license (no file extension).

  2. Run:

    ## on Kubernetes native
    kubectl create secret generic kong-enterprise-license --from-file=<absolute-path-to>/license -n kong
    
    ## on OpenShift
    oc create secret generic kong-enterprise-license --from-file=./license -n kong
    

Deploy

  1. Run one of the following:

    ## Kong Gateway on Kubernetes native
    kubectl apply -f https://raw.githubusercontent.com/Kong/kubernetes-ingress-controller/v2.9.3/deploy/single/all-in-one-dbless-k4k8s-enterprise.yaml
    
    ## Kong Gateway on OpenShift
    oc create -f https://raw.githubusercontent.com/Kong/kubernetes-ingress-controller/v2.9.3/deploy/single/all-in-one-dbless-k4k8s-enterprise.yaml
    
    ## Kong Gateway (OSS) on Kubernetes native
    kubectl apply -f https://raw.githubusercontent.com/Kong/kubernetes-ingress-controller/v2.9.3/deploy/single/all-in-one-dbless.yaml
    

    This might take a few minutes.

  2. Check the install status:

    kubectl get pods -n kong
    

    or:

    oc get pods -n kong
    
  3. To make HTTP requests, you need the IP address of the load balancer. Get the loadBalancer address and store it in a local PROXY_IP environment variable:

    Note: Some cluster providers only provide a DNS name for load balancers. In this case, specify .hostname instead of .ip.

    export PROXY_IP=$(kubectl get -o jsonpath="{.status.loadBalancer.ingress[0].ip}" service -n kong kong-proxy)
    
  4. Verify that the value of $PROXY_IP matches the value of the external host:

    echo $PROXY_IP
    

    This should match the EXTERNAL_IP value of the kong-proxy service returned by the Kubernetes API:

    kubectl get service kong-proxy -n kong
    

    or:

    oc get service kong-proxy -n kong
    
  5. Invoke a test request:

     curl $PROXY_IP
    

    This should return the following response from Gateway:

     {"message":"no Route matched with those values"}
    

Next steps

See the Kong Ingress Controller docs for how-to guides, reference guides, and more.

Thank you for your feedback.
Was this page useful?
  • Kong
    THE CLOUD CONNECTIVITY COMPANY

    Kong powers reliable digital connections across APIs, hybrid and multi-cloud environments.

    • Company
    • Customers
    • Events
    • Investors
    • Careers Hiring!
    • Partners
    • Press
    • Contact
  • Products
    • Kong Konnect
    • Kong Gateway
    • Kong Mesh
    • Get Started
    • Pricing
  • Resources
    • eBooks
    • Webinars
    • Briefs
    • Blog
    • API Gateway
    • Microservices
  • Open Source
    • Install Kong Gateway
    • Kong Community
    • Kubernetes Ingress
    • Kuma
    • Insomnia
  • Solutions
    • Decentralize
    • Secure & Govern
    • Create a Dev Platform
    • API Gateway
    • Kubernetes
    • Service Mesh
Star
  • Terms•Privacy
© Kong Inc. 2023