Install Docker: sudo apt install docker-ce; Keep in mind that other Linux distributions (CentOS, Debian, or Fedora) have different installations steps. If you don't use Ubuntu, see Docker's official documentation. MacOS X Installation. Here are the procedures to install Docker on macOS: Download Docker for Mac and double-click the.dmg file. If you have the Google Cloud SDK installed on your machine, you can quickly install Skaffold as a bundled component. Make sure your gcloud installation and the components are up to date: gcloud components update. Then, install Skaffold: gcloud components install skaffold.
Details about how to use Kong in Docker can be found on the DockerHub repository hosting the image: kong. We also have a Docker Compose template with built-in orchestration and scalability.
With a Database
Macos Docker Install Brew
Here is a quick example showing how to connect a Kong container to a Cassandra or PostgreSQL container.
Create a Docker network
You will need to create a custom network to allow the containers to discover and communicate with each other. In this example
kong-net
is the network name, you can use any name.Start your database
If you wish to use a Cassandra container:
If you wish to use a PostgreSQL container:
Prepare your database
Run the migrations with an ephemeral Kong container:
In the above example, both Cassandra and PostgreSQL are configured, but you should update the
KONG_DATABASE
environment variable with eithercassandra
orpostgres
.Note for Kong < 0.15: with Kong versions below 0.15 (up to 0.14), use the
up
sub-command instead ofbootstrap
. Also note that with Kong < 0.15, migrations should never be run concurrently; only one Kong node should be performing migrations at a time. This limitation is lifted for Kong 0.15, 1.0, and above.Start Kong
When the migrations have run and your database is ready, start a Kong container that will connect to your database container, just like the ephemeral migrations container:
Use Kong
Kong is running:
Quickly learn how to use Kong with the 5-minute Quickstart.
DB-less mode
The steps involved in starting Kong in DB-less mode are the following:
Mac Docker Install Ubuntu
Create a Docker network
This is the same as in the Pg/Cassandra guide. We're also using
kong-net
as the network name and it can also be changed to something else.This step is not strictly needed for running Kong in DB-less mode, but it is a good precaution in case you want to add other things in the future (like a rate-limiting plugin backed up by a Redis cluster).
Create a Docker volume
For the purposes of this guide, a Docker Volume is a folder inside the host machine which can be mapped into a folder in the container. Volumes have a name. In this case we're going to name ours
kong-vol
You should be able to inspect the volume now:
The result should be similar to this:
Notice the
MountPoint
entry. We will need that path in the next step.Prepare your declarative configuration file
The syntax and properties are described on the Declarative Configuration Format guide.
Add whatever core entities (Services, Routes, Plugins, Consumers, etc) you need there.
On this guide we'll assume you named it
kong.yml
.Save it inside the
MountPoint
path mentioned in the previous step. In the case of this guide, that would be/var/lib/docker/volumes/kong-vol/_data/kong.yml
Start Kong in DB-less mode
Although it's possible to start the Kong container with just
KONG_DATABASE=off
, it is usuallydesirable to also include the declarative configuration file as a parameter via theKONG_DECLARATIVE_CONFIG
variable name. In order to do this, we need to make the file'visible' from within the container. We achieve this with the-v
flag, which mapsthekong-vol
volume to the/usr/local/kong/declarative
folder in the container.Use Kong
Kong should be running and it should contain some of the entities added in kong.yml:
For example, get a list of services:
Macos Docker Installer
Follow Up: