Kong 1.0 (#25)

* Migrate to Kong 1.0

* Database seed for Kong 1.0 Admin API proxy

* Update Kong config to set DB & listener values correctly (match sample from buildpack)

* Update database seed for Kong 1.0 Admin API proxy (rc3)

* Specify Heroku stack

* Import updated spec helpers from upstream Kong

* Revise plugin tests to follow Kong 1.0 test style

* Avoid Cassandra confusion during local testing

* Use Heroku CI in-dyno database

* Update spec helpers with source from Kong 1.0

* Update kong & busted bins with source from Kong 1.0

* Update tests conf to include custom plugins

* Updating integration tests for Kong 1.0

* 📚 update docs for Kong 1.0.0

* Update pre-release buildpack branch to master

Author: mars

.profile.local

@@ -1,3 +1,4 @@
 export PATH="~/.luarocks/bin:${PATH:-}"
 export LUA_PATH="./lib/?.lua;./lib/?/init.lua;;"
 export LUA_CPATH="./lib/?.so;;"
+export KONG_TEST_DATABASE=postgres

ADMIN.md

@@ -45,19 +45,19 @@ curl http://localhost:8001/services/ -i -X POST \
 curl http://localhost:8001/plugins/ -i -X POST \
   --data 'name=request-size-limiting' \
   --data "config.allowed_payload_size=8" \
-  --data "service_id=$SERVICE_ID"
+  --data "service.id=$SERVICE_ID"
 curl http://localhost:8001/plugins/ -i -X POST \
   --data 'name=rate-limiting' \
   --data "config.minute=5" \
-  --data "service_id=$SERVICE_ID"
+  --data "service.id=$SERVICE_ID"
 curl http://localhost:8001/plugins/ -i -X POST \
   --data 'name=key-auth' \
   --data "config.hide_credentials=true" \
-  --data "service_id=$SERVICE_ID"
+  --data "service.id=$SERVICE_ID"
 curl http://localhost:8001/plugins/ -i -X POST \
   --data 'name=acl' \
   --data "config.whitelist=kong-admin" \
-  --data "service_id=$SERVICE_ID"
+  --data "service.id=$SERVICE_ID"
 curl http://localhost:8001/routes/ -i -X POST \
   --data 'paths[]=/kong-admin' \
   --data 'protocols[]=https' \

README.md

@@ -1,8 +1,6 @@
 Kong as a Heroku app
 ====================
-Deploy [Kong 0.14](https://konghq.com/kong-community-edition/) clusters to Heroku Common Runtime and Private Spaces using the [Kong buildpack](https://github.com/heroku/heroku-buildpack-kong).
-
-🥚 Try the [Kong 1.0 release candidate](https://github.com/heroku/heroku-kong/tree/kong-1.0) with the `kong-1.0` branch.
+Deploy [Kong 1.0](https://konghq.com/blog/kong-1-0-ga/) clusters to Heroku Common Runtime and Private Spaces using the [Kong buildpack](https://github.com/heroku/heroku-buildpack-kong/).
 
 ⏫ **Upgrading from an earlier version?** See [Upgrade Guide](#user-content-upgrade-guide).
 
@@ -143,9 +141,13 @@ See these examples of [Using Terraform with Heroku](https://devcenter.heroku.com
 
 #### The buildpack
 
-[Buildpack v6.0.0](https://github.com/heroku/heroku-buildpack-kong/releases) supports rapid deployments using a 
+[Buildpack v6.0.0](https://github.com/heroku/heroku-buildpack-kong/releases) supports rapid deployments using a
 pre-compiled Kong binary. A pre-existing, customized app may require changes continue functioning, if the app explicitly uses the `/app/.heroku` directory prefix.
 
+[Buildpack v7.0.0-rc\*](https://github.com/heroku/heroku-buildpack-kong/releases) supports Kong 1.0 release candidates. The "rc" releases only support upgrading from Kong 0.14, not earlier versions or other release candidates.
+
+[Buildpack v7.0.0](https://github.com/heroku/heroku-buildpack-kong/releases) supports Kong 1.0.
+
 ▶️ See [UPGRADING the buildpack](https://github.com/heroku/heroku-buildpack-kong/blob/master/UPGRADING.md).
 
 #### Kong
@@ -161,6 +163,8 @@ Then, take into account these facts about how this Kong on Heroku app works:
    1. [perform the upgrade](https://github.com/Kong/kong/blob/master/UPGRADE.md)
    1. allow release process to run
    1. finally restart to the original formation size `heroku ps:scale web=$PREVIOUS_SIZE`
+* once Kong 1.0 is successfully deployed, execute: `
+heroku run "kong migrations finish --conf /app/config/kong.conf"`
 
 🏥 Please [open an issue](https://github.com/heroku/heroku-kong/issues), if you encounter problems or have feedback about this process.
 
@@ -397,7 +401,7 @@ heroku info
 
 1. Ensure [requirements](#user-content-requirements) are met
 1. Create the Postgres user & databases:
-    
+
     ```bash
     createuser --pwprompt kong
     # set the password "kong"
@@ -413,7 +417,7 @@ heroku info
 bin/start
 ```
 
-* Logs in `/usr/local/var/kong/logs/` 
+* Logs in `/usr/local/var/kong/logs/`
 * Prefix is `/usr/local/var/kong` for commands like:
   * `kong health -p /usr/local/var/kong`
   * `kong stop -p /usr/local/var/kong`

app.json

@@ -12,6 +12,7 @@
   "website": "https://getkong.org/",
   "repository": "https://github.com/heroku/heroku-kong.git",
   "success_url": "https://github.com/heroku/heroku-kong/blob/master/README.md#user-content-usage",
+  "stack": "heroku-18",
   "buildpacks": [{
     "url": "https://github.com/heroku/heroku-buildpack-kong.git"
   }],
@@ -23,5 +24,10 @@
       "description": "A secret key for accessing Kong's Admin API via public proxy at /kong-admin",
       "generator": "secret"
     }
+  },
+  "environments": {
+    "test": {
+      "addons": ["heroku-postgresql:in-dyno"]
+    }
   }
 }

bin/busted

@@ -59,7 +59,7 @@ if not os.getenv("KONG_BUSTED_RESPAWNED") then
   os.exit(rc)
 end
 
-require "luarocks.loader"
+pcall(require, "luarocks.loader")
 
 require("kong.globalpatches")({
   cli = true,

bin/kong

@@ -1,7 +1,7 @@
 #!/usr/bin/env resty
 
-require "luarocks.loader"
+pcall(require, "luarocks.loader")
 
-package.path = "?/init.lua;"..package.path
+package.path = (os.getenv("KONG_LUA_PATH_OVERRIDE") or "") .. "./?.lua;./?/init.lua;" .. package.path
 
-require("kong.cmd")(arg)
+require("kong.cmd.init")(arg)

bin/prerelease

@@ -21,5 +21,5 @@ if [ -n "$admin_key" ]
 then
   echo "Setting Admin API key to value of KONG_HEROKU_ADMIN_KEY"
   # This `id` matches the "kong-admin" keyauth_credentials record contained in "config/pg-heroku-admin.dump"
-  psql "$DATABASE_URL" -c "UPDATE keyauth_credentials SET key='${admin_key}' WHERE id='ac8af1d3-377a-41ae-9fd5-dbf98c599c5c';"
+  psql "$DATABASE_URL" -c "UPDATE keyauth_credentials SET key='${admin_key}' WHERE id='8e4b1774-0b0f-463f-bab1-6468d1fdc5c3';"
 fi

config/kong.conf.etlua

@@ -97,7 +97,9 @@ plugins = bundled,hello-world-header,ndfd-xml-as-json
 # NGINX
 #------------------------------------------------------------------------------
 
-proxy_listen = 0.0.0.0:<%= proxy_port %>
+# Heroku Kong expects listeners to be set via environment variables
+# such as `KONG_PROXY_LISTEN`
+proxy_listen = <%= proxy_listen %>
                                  # Address and port on which Kong will accept
                                  # HTTP requests.
                                  # This is the public-facing entrypoint of
@@ -106,17 +108,18 @@ proxy_listen = 0.0.0.0:<%= proxy_port %>
 # Note: See http://nginx.org/en/docs/http/ngx_http_core_module.html#listen for
 # a description of the accepted formats for this and other *_listen values.
 
-proxy_listen_ssl = 0.0.0.0:<%= proxy_ssl_port %>
+#proxy_listen_ssl = <%= proxy_listen_ssl %>
                                  # Address and port on which Kong will accept
                                  # HTTPS requests if `ssl` is enabled.
 
-admin_listen = 0.0.0.0:<%= admin_api_port %>
+admin_listen = <%= admin_listen %>
                                  # Address and port on which Kong will expose
                                  # an entrypoint to the Admin API.
                                  # This API lets you configure and manage Kong,
                                  # and should be kept private and secured.
 
-#admin_listen_ssl = 0.0.0.0:8444 # Address and port on which Kong will accept
+#admin_listen_ssl = <%= admin_listen_ssl %>
+                                 # Address and port on which Kong will accept
                                  # HTTPS requests to the admin API, if
                                  # `admin_ssl` is enabled.
 
@@ -331,11 +334,14 @@ database = postgres              # Determines which of PostgreSQL or Cassandra
                                  # Accepted values are `postgres` and
                                  # `cassandra`.
 
-pg_host = <%= pg_host %>         
-pg_port = <%= pg_port %>         
-pg_user = <%= pg_user %>         
-pg_password = <%= pg_password %> 
-pg_database = <%= pg_dbname %>   
+# Heroku Kong expects listeners to be set via environment variables
+# such as `KONG_PG_HOST` which is generated by config/kong-12f.lua script
+# from Heroku Postgres' `DATABASE_URL` value.
+pg_host = <%= pg_host %>
+pg_port = <%= pg_port %>
+pg_user = <%= pg_user %>
+pg_password = <%= pg_password %>
+pg_database = <%= pg_database %>  
 
 pg_ssl = on                      # Toggles client-server TLS connections
                                  # between Kong and PostgreSQL.