Merge pull request Kong#31 from Mashape/0.8.0

0.8.0

Author: subnetmarco

Dockerfile

@@ -1,7 +1,7 @@
 FROM centos:7
 MAINTAINER Marco Palladino, marco@mashape.com
 
-ENV KONG_VERSION 0.7.0
+ENV KONG_VERSION 0.8.0
 
 RUN yum install -y epel-release
 RUN yum install -y https://github.com/Mashape/kong/releases/download/$KONG_VERSION/kong-$KONG_VERSION.el7.noarch.rpm && \
@@ -11,6 +11,12 @@ VOLUME ["/etc/kong/"]
 
 COPY config.docker/kong.yml /etc/kong/kong.yml
 
+# Set the database to use
+RUN if [ -z "$DATABASE" ]; then \
+ DATABASE="cassandra"; \
+fi; \
+echo -e 'database: "'$DATABASE'"' >> /etc/kong/kong.yml;
+
 CMD kong start
 
 EXPOSE 8000 8443 8001 7946

README.md

@@ -20,7 +20,8 @@ This is the official Docker image for [Kong][kong-site-url].
 - `0.6.0` - *([Dockerfile](https://github.com/Mashape/docker-kong/blob/0.6.0/Dockerfile))*
 - `0.6.1` - *([Dockerfile](https://github.com/Mashape/docker-kong/blob/0.6.1/Dockerfile))*
 - `0.7.0` - *([Dockerfile](https://github.com/Mashape/docker-kong/blob/0.7.0/Dockerfile))*
-- `latest` - *([Dockerfile](https://github.com/Mashape/docker-kong/blob/0.7.0/Dockerfile))*
+- `0.8.0` - *([Dockerfile](https://github.com/Mashape/docker-kong/blob/0.8.0/Dockerfile))*
+- `latest` - *([Dockerfile](https://github.com/Mashape/docker-kong/blob/0.8.0/Dockerfile))*
 
 # What is Kong?
 
@@ -32,21 +33,42 @@ Kong's documentation can be found at [getkong.org/docs][kong-docs-url].
 
 # How to use this image
 
-First, Kong requires a running Cassandra cluster before it starts. You can either use the [mashape/cassandra](https://github.com/Mashape/docker-cassandra) image, provision a test instance on [kongdb.org](http://kongdb.org) or use a cluster of your own.
+First, Kong requires a running Cassandra or PostgreSQL cluster before it starts. You can either use the official Cassandra/PostgreSQL containers, or use your own.
 
-## 1. Link Kong to a Cassandra container
+## 1. Link Kong to either a Cassandra or PostgreSQL container
 
-Start a Cassandra container by doing so:
+It's up to you to decide which datastore between Cassandra or PostgreSQL you want to use, since Kong supports both.
+
+### Cassandra
+
+Start a Cassandra container by executing:
 
 ```shell
-$ docker run -d -p 9042:9042 --name cassandra cassandra:2.2.4
+$ docker run -d --name kong-database \
+ -p 9042:9042 \
+ cassandra:2.2
 ```
 
-Once Cassandra is running, we can start a Kong container and link it to the Cassandra container:
+### Postgres
+
+Start a PostgreSQL container by executing:
+
+```shell
+docker run -d --name kong-database \
+ -p 5432:5432 \
+ -e "POSTGRES_USER=kong" \
+ -e "POSTGRES_DB=kong" \
+ postgres:9.4
+```
+
+### Start Kong
+
+Once the database is running, we can start a Kong container and link it to the database container, and configuring the `DATABASE` environment variable with either `cassandra` or `postgres` depending on which database you decided to use:
 
 ```shell
 $ docker run -d --name kong \
- --link cassandra:cassandra \
+ -e "DATABASE=cassandra" \ # or "DATABASE=postgres"
+ --link kong-database:kong-database \
  -p 8000:8000 \
  -p 8443:8443 \
  -p 8001:8001 \
@@ -56,11 +78,13 @@ $ docker run -d --name kong \
  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][kong-docs-proxy-port]) and `8001` ([admin api][kong-docs-admin-api-port]) ports.
+**Note:** If Docker complains that `--security-opt` is an invalid option, just remove it and re-execute the command (it was introduced in Docker 1.3).
+
+If everything went well, and if you created your container with the default ports, Kong should be listening on your host's `8000` ([proxy][kong-docs-proxy-port]), `8443` ([proxy SSL][kong-docs-proxy-ssl-port]) and `8001` ([admin api][kong-docs-admin-api-port]) ports. Port `7946` ([cluster][kong-docs-cluster-port]) is being used only by other Kong nodes.
 
 You can now read the docs at [getkong.org/docs][kong-docs-url] to learn more about Kong.
 
-## 2. Use Kong with a custom configuration (and Cassandra cluster)
+## 2. Use Kong with a custom configuration (and a custom Cassandra/PostgreSQL cluster)
 
 This container stores the [Kong configuration file](http://getkong.org/docs/latest/configuration/) in a [Data Volume][docker-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:
 
@@ -77,7 +101,7 @@ $ docker run -d \
  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.
+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/PostgreSQL instance, so no need to link it to a Cassandra/PostgreSQL container.
 
 ## Reload Kong in a running container
 
@@ -104,7 +128,9 @@ Before you start to code, we recommend discussing your plans through a [GitHub i
 [kong-site-url]: http://getkong.org
 [kong-docs-url]: http://getkong.org/docs
 [kong-docs-proxy-port]: http://getkong.org/docs/latest/configuration/#proxy_port
+[kong-docs-proxy-ssl-port]: http://getkong.org/docs/latest/configuration/#proxy_listen_ssl
 [kong-docs-admin-api-port]: http://getkong.org/docs/latest/configuration/#admin_api_port
+[kong-docs-cluster-port]: http://getkong.org/docs/latest/configuration/#cluster_listen
 [kong-docs-reload]: http://getkong.org/docs/latest/cli/#reload
 
 [github-new-issue]: https://github.com/Mashape/docker-kong/issues/new

config.docker/kong.yml

@@ -1,7 +1,11 @@
-database: cassandra
+postgres:
+ host: "kong-database"
+ port: 5432
+ database: kong
+ user: kong
 cassandra:
  contact_points:
- - "cassandra:9042"
+ - "kong-database:9042"
 nginx: |
  {{user}}
  worker_processes auto;