|
|
@@ -1,12 +1,10 @@
|
|
|
# What is Kong?
|
|
|
|
|
|
-Kong is a scalable, open source API Layer (also known as an API Gateway, or API Middleware). Kong was originally built by [Kong Inc.](https://konghq.com) (formerly known as Mashape) to secure, manage and extend over 15,000 Microservices for its API Marketplace, which generates billions of requests per month.
|
|
|
+Kong is a scalable, open source API Platform (also known as an API Gateway, or API Middleware, or Service Mesh for Microservices). Kong was originally built by [Kong Inc.](https://konghq.com) (formerly known as Mashape) to secure, manage and extend over 15,000 Microservices for its API Marketplace, which generates billions of requests per month.
|
|
|
|
|
|
-Backed by the battle-tested NGINX with a focus on high performance, Kong was made available as an open-source platform in 2015. Under active development, Kong is now used in production at hundreds of organizations from startups, to large enterprises and government departments including: The New York Times, Expedia, Healthcare.gov, The Guardian, Condè Nast, The University of Auckland, Ferrari, and Giphy.
|
|
|
+Under active development, Kong is now used in production at hundreds of organizations from startups, to large enterprises and governments including: The New York Times, Expedia, Healthcare.gov, The Guardian, Condè Nast, The University of Auckland, Ferrari, Rakuten, Cisco, SkyScanner, Yahoo! Japan, Giphy and so on.
|
|
|
|
|
|
-Kong's documentation can be found at [getkong.org/docs](http://getkong.org/docs).
|
|
|
-
|
|
|
-%%LOGO%%
|
|
|
+Kong's official documentation can be found at [docs.konghq.com](https://docs.konghq.com/).
|
|
|
|
|
|
# How to use this image
|
|
|
|
|
|
@@ -35,7 +33,7 @@ docker run -d --name kong-database \
|
|
|
-p 5432:5432 \
|
|
|
-e "POSTGRES_USER=kong" \
|
|
|
-e "POSTGRES_DB=kong" \
|
|
|
- postgres:9.5
|
|
|
+ postgres:9.6
|
|
|
```
|
|
|
|
|
|
## 2. Prepare your database
|
|
|
@@ -62,14 +60,13 @@ Once the database has been started and prepared, we can start a Kong container a
|
|
|
```shell
|
|
|
$ docker run -d --name kong \
|
|
|
--link kong-database:kong-database \
|
|
|
- -e "KONG_DATABASE=cassandra" \
|
|
|
+ -e "KONG_DATABASE=postgres" \
|
|
|
-e "KONG_CASSANDRA_CONTACT_POINTS=kong-database" \
|
|
|
-e "KONG_PROXY_ACCESS_LOG=/dev/stdout" \
|
|
|
-e "KONG_ADMIN_ACCESS_LOG=/dev/stdout" \
|
|
|
-e "KONG_PROXY_ERROR_LOG=/dev/stderr" \
|
|
|
-e "KONG_ADMIN_ERROR_LOG=/dev/stderr" \
|
|
|
- -e "KONG_ADMIN_LISTEN=0.0.0.0:8001" \
|
|
|
- -e "KONG_ADMIN_LISTEN_SSL=0.0.0.0:8444" \
|
|
|
+ -e "KONG_ADMIN_LISTEN=0.0.0.0:8001, 0.0.0.0:8444 ssl" \
|
|
|
-p 8000:8000 \
|
|
|
-p 8443:8443 \
|
|
|
-p 8001:8001 \
|
|
|
@@ -77,13 +74,13 @@ $ docker run -d --name kong \
|
|
|
%%IMAGE%%
|
|
|
```
|
|
|
|
|
|
-If everything went well, and if you created your container with the default ports, Kong should be listening on your host's `8000` ([Proxy](http://getkong.org/docs/latest/configuration/#proxy_port)), `8443` ([Proxy SSL](http://getkong.org/docs/latest/configuration/#proxy_listen_ssl)), `8001` ([Admin API](http://getkong.org/docs/latest/configuration/#admin_listen)) and `8444` ([Admin API SSL](http://getkong.org/docs/latest/configuration/#admin_listen_ssl)) ports.
|
|
|
+If everything went well, and if you created your container with the default ports, Kong should be listening on your host's `8000` ([Proxy](https://docs.konghq.com/latest/configuration/#proxy_port)), `8443` ([Proxy SSL](https://docs.konghq.com/latest/configuration/#proxy_listen_ssl)), `8001` ([Admin API](https://docs.konghq.com/latest/configuration/#admin_listen)) and `8444` ([Admin API SSL](https://docs.konghq.com/latest/configuration/#admin_listen_ssl)) ports.
|
|
|
|
|
|
-You can now read the docs at [getkong.org/docs](http://getkong.org/docs) to learn more about Kong.
|
|
|
+You can now read the docs at [docs.konghq.com](https://docs.konghq.com/) to learn more about Kong.
|
|
|
|
|
|
## 3. Use Kong with a custom configuration (and a custom Cassandra/PostgreSQL cluster)
|
|
|
|
|
|
-You can override any property of the [Kong configuration file](http://getkong.org/docs/latest/configuration/) with environment variables. Just prepend any Kong configuration property with the `KONG_` prefix, for example:
|
|
|
+You can override any property of the [Kong configuration file](https://docs.konghq.com/latest/configuration/) with environment variables. Just prepend any Kong configuration property with the `KONG_` prefix, for example:
|
|
|
|
|
|
```shell
|
|
|
$ docker run -d --name kong \
|
|
|
@@ -92,8 +89,7 @@ $ docker run -d --name kong \
|
|
|
-e "KONG_LOG_LEVEL=info" \
|
|
|
-e "KONG_CUSTOM_PLUGINS=helloworld" \
|
|
|
-e "KONG_PG_HOST=1.1.1.1" \
|
|
|
- -e "KONG_ADMIN_LISTEN=0.0.0.0:8001" \
|
|
|
- -e "KONG_ADMIN_LISTEN_SSL=0.0.0.0:8444" \
|
|
|
+ -e "KONG_ADMIN_LISTEN=0.0.0.0:8001, 0.0.0.0:8444 ssl" \
|
|
|
-p 8000:8000 \
|
|
|
-p 8443:8443 \
|
|
|
-p 8001:8001 \
|
|
|
@@ -109,4 +105,15 @@ If you change your custom configuration, you can reload Kong (without downtime)
|
|
|
$ docker exec -it kong kong reload
|
|
|
```
|
|
|
|
|
|
-This will run the [`kong reload`](http://getkong.org/docs/latest/cli/#reload) command in your container.
|
|
|
+This will run the [`kong reload`](https://docs.konghq.com/latest/cli/#reload) command in your container.
|
|
|
+
|
|
|
+# Kubernetes Ingress
|
|
|
+
|
|
|
+Among the many deployment options [available](https://konghq.com/install), Kong also offers a [Kubernetes Ingress Controller](https://github.com/Kong/kubernetes-ingress-controller) ready to use in your K8S environment.
|
|
|
+
|
|
|
+# Service Mesh
|
|
|
+
|
|
|
+Since version 1.x you can run Kong in a Service Mesh deployment as a platform-agnostic sidecar proxy (including Kubernetes, but also on any other platform supported by Kong). To get started and learn more you can read the docs at:
|
|
|
+
|
|
|
+- [Streams and Service Mesh](https://docs.konghq.com/latest/streams-and-service-mesh/)
|
|
|
+- [Kubernetes and Service Mesh](https://github.com/Kong/kong-mesh-dist-kubernetes)
|
thefosk
