minikube

Kong can easily be provisioned to Minikube cluster using the following steps:

1. Install VirtualBox

   Kubernetes needs a VM within which to run. VirtualBox is one of the hypervisors that Minikube supports and works across OS X, Linux, and Windows.

2. Install minikube

   Minikube is a tool that makes it easy to run Kubernetes locally. Minikube runs a single-node Kubernetes cluster inside a VM on your laptop for users looking to try out Kubernetes or develop with it day-to-day.

3. Deploy Kubernetes via Minikube

   You need minikube and kubectl command-line tools installed and set up to run deployment commands.

   Using the minikube command, deploy a Kubernetes cluster.

   $ minikube start

   By now, you have provisioned a Kubernetes managed cluster locally.

4. 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

5. Prepare database

   Using the kong_migration_<postgres|cassandra>.yaml file from this repo, run the migration job, jump to step 5 if Kong backing databse is 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

6. Deploy Kong

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

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

7. Verify your deployments

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

   $ kubectl get all

   Once the Kong services are started, you can test Kong by making the following requests:

   $ curl $(minikube service --url kong-admin)
   $ curl $(minikube service --url kong-proxy|head -n1)

   It may take up to 3 minutes for all services to come up.

8. Using Kong

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

Important Note

When deploying into a Kubernetes cluster with Deployment Manager, it is important to be aware that deleting ReplicationController Kubernetes objects does not delete its underlying pods, and it is your responisibility to manage the destruction of these resources when deleting or updating a ReplicationController in your configuration.