Kong can easily be provisioned to Kubernetes cluster by either using the Helm chart or the manifest files provided in the repo

Following are the steps to install Kong using the manifest files:

  1. Initial setup

    Download or clone the following repo:

    $ git clone [email protected]:Kong/kong-dist-kubernetes.git
    $ cd kong-dist-kubernetes

    If you want to run Kubernetes locally, please follow the README and use the manifest files provided in minikube directory.

    Skip to step 3 if you have already provisioned a cluster and registered it with Kubernetes.

    Note: Included manifest files in repo only support Kong v0.11.x, for 0.10.x please use the tag 1.0.0.

  2. Deploy a GKE cluster

    You need gcloud and kubectl command-line tools installed and set up to run deployment commands. Also make sure your Google Cloud account has STATIC_ADDRESSES available for the external access of Kong services.

    Using the cluster.yaml file from this repo, deploy a GKE cluster. Provide the following information before deploying:

    1. Desired cluster name
    2. Zone in which to run the cluster
    3. A basicauth username and password for authenticating the access to the cluster
    $ gcloud deployment-manager deployments \ 
        create cluster --config cluster.yaml

    By now, you have provisioned a Kubernetes managed cluster.

  3. Deploy a Kong supported database

    Before deploying Kong, you need to provision a Cassandra or PostgreSQL pod.

    For Cassandra, use the cassandra.yaml file from this repo to deploy a Cassandra Service and a StatefulSet in the cluster:

    $ kubectl create -f cassandra.yaml

    Note: Please update the cassandra.yaml file for the cloud you are working with.

    For PostgreSQL, use the postgres.yaml file from the kong-dist-kubernetes repo to deploy a PostgreSQL Service and a ReplicationController in the cluster:

    $ kubectl create -f postgres.yaml
  4. Prepare database

    Kong Enterprise Edition trial users should complete the steps in the Additional steps for Kong EE Trial users section below before proceeding.

    Using the kong_migration_<postgres|cassandra>.yaml file from this repo, run the migration job, jump to step 5 if Kong migrations are up–to–date:

    $ kubectl create -f kong_migration_<postgres|cassandra>.yaml

    Once job completes, you can remove the pod by running following command:

    $ kubectl delete -f kong_migration_<postgres|cassandra>.yaml
  5. Deploy Kong

    Using the kong_<postgres|cassandra>.yaml file from this repo, deploy Kong admin, proxy services, and a Deployment controller to the cluster:

    $ kubectl create -f kong_<postgres|cassandra>.yaml
  6. Verify your deployments

    You can now see the resources that have been deployed using kubectl:

    $ kubectl get all

    Once the EXTERNAL_IP is available for Kong Proxy and Admin services, you can test Kong by making the following requests:

    $ curl <kong-admin-ip-address>:8001
    $ curl https://<admin-ssl-ip-address>:8444
    $ curl <kong-proxy-ip-address>:8000
    $ curl https://<kong-proxy-ssl-ip-address>:8443
  7. Using Kong

    Quickly learn how to use Kong with the 5-minute Quickstart.

Additional steps for Kong EE Trial users

  1. Publishing an image to a container registry

    Because Kong Enterprise Edition images are not available on the public Docker container registry, you must publish them to a private repository for use with Kubernetes. While any private repository will work, this example uses the Google Cloud Platform Container Registry, which automatically integrates with the Google Cloud Platform examples in the other steps.

    In the steps below, replace <image ID> with ID associated with your loaded image in docker images output. Replace <project ID> with your Google Cloud Platform project ID.

    $ docker load -i /tmp/kong-docker-enterprise-edition.tar.gz
    $ docker images
    $ docker tag <image ID> gcr.io/<project ID>/kong-ee
    $ gcloud docker -- push gcr.io/demo-cs-lab/kong-ee:latest
  2. Adding your license data

    Edit kong_trial_postgres.yaml and kong_trial_migration_postgres.yaml to replace YOUR_LICENSE_HERE with your license string. The end result should look like

    value: '{"license":{"signature":"alongstringofcharacters","payload":{"customer":"Test Company","license_creation_date":"2018-03-06","product_subscription":"Kong Only","admin_seats":"5","support_plan":"Premier","license_expiration_date":"2018-06-04","license_key":"anotherstringofcharacters"},"version":1}}'
  3. Using your image

    Edit kong_trial_postgres.yaml and kong_trial_migration_postgres.yaml and replace image: kong with image: gcr.io/<project ID>/kong-ee, using the same project ID as above.

  4. Deploy Kong

    Continue from step 4 in the main set of instructions using the kong_trial_* YAML files. Note that you'll be able to access the Admin GUI at <kong-admin-ip-address>:8002 or https://<kong-ssl-admin-ip-address>:8445.

Get Updates!

Follow Up:

Get future release notes emailed to you.

Having Trouble? We're Here to Help!

Keep up with the latest features