feat(config) add "kic" configuration for reporting (Kong#5765)

Travis Raines · web-flow · commit 828a898b3211 · 2020-04-16T12:01:00.000+02:00
* feat(config) add "kic" setting

Add a "kic" setting to kong.conf. This is a boolean indicating whether
the instance is managed by the Kong Ingress Controller. It is not
documented and not included in kong.conf.default, as users should not
set it directly. Kubernetes tooling will set it automatically if
appropriate.

* feat(reports) send KIC usage

Add ingress controller usage setting to anonymous reports.
diff --git a/kong/conf_loader.lua b/kong/conf_loader.lua
@@ -397,6 +397,7 @@ local CONF_INFERENCES = {
   cluster_control_plane = { typ = "string", },
   cluster_cert = { typ = "string" },
   cluster_cert_key = { typ = "string" },
+  kic = { typ = "boolean" },
 }
 
 
diff --git a/kong/reports.lua b/kong/reports.lua
@@ -336,6 +336,7 @@ local function configure_ping(kong_conf)
 
   add_immutable_value("database", kong_conf.database)
   add_immutable_value("role", kong_conf.role)
+  add_immutable_value("kic", kong_conf.kic)
   add_immutable_value("_admin", #kong_conf.admin_listeners > 0 and 1 or 0)
   add_immutable_value("_proxy", #kong_conf.proxy_listeners > 0 and 1 or 0)
   add_immutable_value("_stream", #kong_conf.stream_listeners > 0 and 1 or 0)
diff --git a/kong/templates/kong_defaults.lua b/kong/templates/kong_defaults.lua
@@ -120,4 +120,5 @@ lua_package_path = ./?.lua;./?/init.lua;
 lua_package_cpath = NONE
 
 role = traditional
+kic = off
 ]]
diff --git a/spec/01-unit/11-reports_spec.lua b/spec/01-unit/11-reports_spec.lua
@@ -170,6 +170,32 @@ describe("reports", function()
       end)
     end)
 
+    describe("sends 'kic'", function()
+      it("default (off)", function()
+        local conf = assert(conf_loader(nil))
+        reports.configure_ping(conf)
+
+        local thread = helpers.tcp_server(8189)
+        reports.send_ping("127.0.0.1", 8189)
+
+        local _, res = assert(thread:join())
+        assert._matches("kic=false", res, nil, true)
+      end)
+
+      it("enabled", function()
+        local conf = assert(conf_loader(nil, {
+          kic = "on",
+        }))
+        reports.configure_ping(conf)
+
+        local thread = helpers.tcp_server(8189)
+        reports.send_ping("127.0.0.1", 8189)
+
+        local _, res = assert(thread:join())
+        assert.matches("kic=true", res, nil, true)
+      end)
+    end)
+
     describe("sends '_admin' for 'admin_listen'", function()
       it("off", function()
         local conf = assert(conf_loader(nil, {

Original file line number	Diff line number	Diff line change
`@@ -397,6 +397,7 @@ local CONF_INFERENCES = {`
`397`	`397`	`cluster_control_plane = { typ = "string", },`
`398`	`398`	`cluster_cert = { typ = "string" },`
`399`	`399`	`cluster_cert_key = { typ = "string" },`
	`400`	`+ kic = { typ = "boolean" },`
`400`	`401`	`}`
`401`	`402`
`402`	`403`