Kong in Docker

This is the official Docker image for Kong.

Supported tags and respective Dockerfile links

• 0.2.0-2 - (Dockerfile)
• 0.2.1 - (Dockerfile)
• 0.3.0 - (Dockerfile)
• 0.3.1 - (Dockerfile)
• 0.3.2 - (Dockerfile)
• 0.4.0 - (Dockerfile)
• 0.4.1 - (Dockerfile)
• 0.4.2 - (Dockerfile)
• 0.5.0 - (Dockerfile)
• 0.5.1 - (Dockerfile)
• 0.5.2 - (Dockerfile)
• 0.5.3 - (Dockerfile)
• 0.5.4 - (Dockerfile)
• 0.6.0 - (Dockerfile)
• 0.6.1 - (Dockerfile)
• 0.7.0 - (Dockerfile)
• latest - (Dockerfile)

What is Kong?

Kong was built to secure, manage and extend Microservices & APIs. If you're building for web, mobile or IoT (Internet of Things) you will likely end up needing to implement common functionality on top of your actual software. Kong can help by acting as a gateway for any HTTP resource while providing logging, authentication and other functionality through plugins.

Powered by NGINX and Cassandra with a focus on high performance and reliability, Kong runs in production at Mashape where it has handled billions of API requests for over ten thousand APIs.

Kong's documentation can be found at getkong.org/docs.

How to use this image

First, Kong requires a running Cassandra cluster before it starts. You can either use the mashape/cassandra image, provision a test instance on kongdb.org or use a cluster of your own.

1. Link Kong to a Cassandra container

Start a Cassandra container by doing so:

$ docker run -d -p 9042:9042 --name cassandra cassandra:2.2.4

Once Cassandra is running, we can start a Kong container and link it to the Cassandra container:

$ docker run -d --name kong \
    --link cassandra:cassandra \
    -p 8000:8000 \
    -p 8443:8443 \
    -p 8001:8001 \
    -p 7946:7946 \
    -p 7946:7946/udp \
    --security-opt seccomp:unconfined \
    mashape/kong

If everything went well, and if you created your container with the default ports, Kong should be listening on your host's 8000 (proxy) and 8001 (admin api) ports.

You can now read the docs at getkong.org/docs to learn more about Kong.

2. Use Kong with a custom configuration (and Cassandra cluster)

This container stores the Kong configuration file in a Data Volume. You can store this file on your host (name it kong.yml and place it in a directory) and mount it as a volume by doing so:

$ docker run -d \
    -v /path/to/your/kong/configuration/directory/:/etc/kong/ \
    -p 8000:8000 \
    -p 8443:8443 \
    -p 8001:8001 \
    -p 7946:7946 \
    -p 7946:7946/udp \
    --security-opt seccomp:unconfined \
    --name kong \
    mashape/kong

When attached this way you can edit your configuration file from your host machine and restart your container. You can also make the container point to a different Cassandra instance, so no need to link it to a Cassandra container.

Reload Kong in a running container

If you change your custom configuration, you can reload Kong (without downtime) by issuing:

$ docker exec -it kong kong reload

This will run the kong reload command in your container.

User Feedback

Issues

If you have any problems with or questions about this image, please contact us through a GitHub issue.

Contributing

You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.

Before you start to code, we recommend discussing your plans through a GitHub issue, especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.