Added Kong in Docker, added development docs

Author: nasrulhazim

.config/POSTGRES_PASSWORD

@@ -0,0 +1 @@
+password

.config/kong.yaml

@@ -0,0 +1,3 @@
+# a very minimal declarative config file
+_format_version: "2.1"
+_transform: true

.config/kong/.gitignore

@@ -0,0 +1,2 @@
+*
+!.gitignore

.gitignore

@@ -29,5 +29,4 @@ phpunit.xml
 phpstan.neon
 psalm.xml
 testbench.yaml
-/docs
 /coverage

bin/configure-kong

@@ -0,0 +1,48 @@
+#!/bin/bash
+
+echo " 🚀 Export Default Configuration"
+curl -s localhost:8001 | jq '.configuration' > .config/kong/configuration-default.json
+
+echo " 🚀 Set Rate Limit Globbaly to 60 requests per minute."
+curl -X POST http://localhost:8001/plugins \
+  --data name=rate-limiting \
+  --data config.minute=60 \
+  --data config.policy=local | jq '.' > .config/kong/admin-api-rate-limit-global.json
+
+echo " 🚀 Set Default Proxy Cache to 30 seconds"
+curl -X POST http://localhost:8001/plugins \
+  --data "name=proxy-cache" \
+  --data "config.request_method=GET" \
+  --data "config.response_code=200" \
+  --data "config.content_type=application/json; charset=utf-8" \
+  --data "config.cache_ttl=30" \
+  --data "config.strategy=memory" | jq '.' > .config/kong/admin-api-proxy-cache-global.json
+
+echo " 🚀 Create Admin API Service"
+curl --request POST \
+  --url http://localhost:8001/services \
+  --data name=admin-api-service \
+  --data url='http://localhost:8001' | jq '.' > .config/kong/admin-api-service.json
+
+echo " 🚀 Create Admin API Route"
+curl --request POST \
+  --url http://localhost:8001/services/admin-api-service/routes \
+  --data 'paths[]=/admin-api' \
+  --data name=admin-api-route | jq '.' > .config/kong/admin-api-route.json
+
+echo " 🚀 Enable Key Auth on Admin API Service"
+curl --request POST \
+  --url http://localhost:8001/services/admin-api-service/plugins \
+  --header 'Content-Type: application/json' \
+  --header 'accept: application/json' \
+  --data '{"name":"key-auth","config":{"key_names":["api-key"],"key_in_query":false}}' | jq '.' > .config/kong/admin-api-key.json
+
+echo " 🚀 Create Admin API Consumer"
+curl --request POST \
+  --url http://localhost:8001/consumers \
+  --header 'Content-Type: application/json' \
+  --header 'accept: application/json' \
+  --data '{"username":"apim","custom_id":"apim"}' | jq '.' > .config/kong/consumer-apim.json
+
+echo " 🚀 Create APIM API Key"
+curl -X POST http://localhost:8001/consumers/apim/key-auth | jq '.' > .config/kong/admin-api-consumer-key.json

docker-compose.yml

@@ -0,0 +1,79 @@
+version: '3.9'
+
+x-kong-config: &kong-env
+  KONG_DATABASE: postgres
+  KONG_PG_DATABASE: ${KONG_PG_DATABASE:-kong}
+  KONG_PG_HOST: kong-database
+  KONG_PG_USER: ${POSTGRES_USER:-kong}
+  KONG_PG_PASSWORD_FILE: /run/secrets/kong_postgres_password
+
+services:
+  kong-migrations:
+    image: kong/kong-gateway:3.6.1.8
+    command: kong migrations bootstrap
+    depends_on:
+      - kong-database
+    environment:
+      <<: *kong-env
+    secrets:
+      - kong_postgres_password
+    networks:
+      - kong-net
+    restart: on-failure
+
+  kong-migrations-up:
+    image: kong/kong-gateway:3.6.1.8
+    command: kong migrations up && kong migrations finish
+    depends_on:
+      - kong-database
+    environment:
+      <<: *kong-env
+    secrets:
+      - kong_postgres_password
+    networks:
+      - kong-net
+    restart: on-failure
+
+  kong-gateway:
+    image: kong/kong-gateway:3.6.1.8
+    user: "${KONG_USER:-kong}"
+    networks:
+      - kong-net
+    environment:
+      <<: *kong-env
+      KONG_PROXY_ACCESS_LOG: /dev/stdout
+      KONG_ADMIN_ACCESS_LOG: /dev/stdout
+      KONG_PROXY_ERROR_LOG: /dev/stderr
+      KONG_ADMIN_ERROR_LOG: /dev/stderr
+      KONG_ADMIN_LISTEN: 0.0.0.0:${KONG_ADMIN_PORT:-8001}
+      KONG_PROXY_LISTEN: 0.0.0.0:${KONG_PROXY_PORT:-8000}
+    secrets:
+      - kong_postgres_password
+    ports:
+      - '${KONG_PROXY_PORT:-8000}:8000'
+      - '${KONG_ADMIN_PORT:-8001}:8001'
+    depends_on:
+      - kong-database
+    healthcheck:
+      test: ["CMD", "kong", "health"]
+      interval: 10s
+      timeout: 10s
+      retries: 10
+    restart: on-failure:5
+
+  kong-database:
+    image: postgres:13
+    environment:
+      - POSTGRES_DB=${KONG_PG_DATABASE:-kong}
+      - POSTGRES_USER=${POSTGRES_USER:-kong}
+      - POSTGRES_PASSWORD=${POSTGRES_PASSWORD:-password}
+    networks:
+      - kong-net
+
+networks:
+  kong-net:
+    external: true
+
+secrets:
+  kong_postgres_password:
+    file: .config/POSTGRES_PASSWORD

docs/development.md

@@ -0,0 +1,11 @@
+# Development
+
+TL;DR, run the following to setup package development environment:
+
+```bash
+composer install
+docker-compose up -d
+. ./bin/configure-kong
+```
+
+Kong Admin API key are located in `.config/kong/admin-api-consumer-key.json` file.