Skip to content
2023 API Summit Hackathon: Experiment with AI for APIs (August 28 - September 27) Learn More →
Kong Logo | Kong Docs Logo
search
  • We're Hiring!
  • Docs
    • Kong Gateway
      Lightweight, fast, and flexible cloud-native API gateway
      Kong Konnect
      Single platform for SaaS end-to-end connectivity
      Kong Mesh
      Enterprise service mesh based on Kuma and Envoy
      decK
      Helps manage Kong’s configuration in a declarative fashion
      Kong Ingress Controller
      Works inside a Kubernetes cluster and configures Kong to proxy traffic
      Kong Gateway Operator
      Manage your Kong deployments on Kubernetes using YAML Manifests
      Insomnia
      Collaborative API development platform
      Kuma
      Open-source distributed control plane with a bundled Envoy Proxy integration
  • API Specs
  • Plugin Hub
    • Explore the Plugin Hub
      View all plugins View all plugins View all plugins arrow image
    • Functionality View all View all arrow image
      View all plugins
      Authentication's icon
      Authentication
      Protect your services with an authentication layer
      Security's icon
      Security
      Protect your services with additional security layer
      Traffic Control's icon
      Traffic Control
      Manage, throttle and restrict inbound and outbound API traffic
      Serverless's icon
      Serverless
      Invoke serverless functions in combination with other plugins
      Analytics & Monitoring's icon
      Analytics & Monitoring
      Visualize, inspect and monitor APIs and microservices traffic
      Transformations's icon
      Transformations
      Transform request and responses on the fly on Kong
      Logging's icon
      Logging
      Log request and response data using the best transport for your infrastructure
  • Support
  • Community
  • Kong Academy
Get a Demo Start Free Trial
Kong Gateway
3.1.x
  • Home icon
  • Kong Gateway
  • Install
  • Kubernetes
  • Install on Kubernetes
github-edit-pageEdit this page
report-issueReport an issue
  • Kong Gateway
  • Kong Konnect
  • Kong Mesh
  • Plugin Hub
  • decK
  • Kong Ingress Controller
  • Kong Gateway Operator
  • Insomnia
  • Kuma

  • Docs contribution guidelines
  • 3.4.x (latest)
  • 3.3.x
  • 3.2.x
  • 3.1.x
  • 3.0.x
  • 2.8.x
  • 2.7.x
  • 2.6.x
  • Archive (pre-2.6)
enterprise-switcher-icon Switch to OSS
On this pageOn this page
  • Prerequisites
  • Create namespace
  • Create license secret
  • Deploy
  • Next steps
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 Kong 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 Kong Ingress Controller. For example:

Kubernetes
OpenShift
kubectl create namespace kong
oc new-project kong

Create license secret

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

  2. Run:

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

Deploy

  1. Run one of the following:
Kubernetes
Kubernetes (OSS)
OpenShift
kubectl apply -f https://raw.githubusercontent.com/Kong/kubernetes-ingress-controller/v2.11.0/deploy/single/all-in-one-dbless-k4k8s-enterprise.yaml
kubectl apply -f https://raw.githubusercontent.com/Kong/kubernetes-ingress-controller/v2.11.0/deploy/single/all-in-one-dbless.yaml
oc create -f https://raw.githubusercontent.com/Kong/kubernetes-ingress-controller/v2.11.0/deploy/single/all-in-one-dbless-k4k8s-enterprise.yaml
This might take a few minutes.
  1. Check the install status:
Kubernetes
OpenShift
kubectl get pods -n kong
oc get pods -n kong
  1. 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)
    

    If you’re testing locally and have not deployed a loadbalancer, you can port forward the kong-proxy service to test:

    kubectl port-forward -n kong svc/kong-proxy 8000:80
    

    Then in a different terminal window:

    export PROXY_IP=localhost:8000
    
  2. 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:

Kubernetes
OpenShift
kubectl get service kong-proxy -n kong
oc get service kong-proxy -n kong
  1. 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?
Too much on your plate? close cta icon
More features, less infrastructure with Kong Konnect. 1M requests per month for free.
Try it for Free
  • 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