Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor(clustering/compat): using array to store compatible checker functions #10152

Merged
merged 11 commits into from
Apr 6, 2023
Merged

refactor(clustering/compat): using array to store compatible checker functions #10152

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
cbeaeb8
compatible_checkers
chronolaw Jan 21, 2023
4d1ff67
log_warn_message
chronolaw Mar 8, 2023
63d697e
style fix
chronolaw Mar 8, 2023
6e6bf68
style lint
chronolaw Mar 8, 2023
05ec679
minor style clean
chronolaw Mar 14, 2023
58f88bc
clean `update_at` code
chronolaw Mar 16, 2023
ac67ef3
code clean
chronolaw Mar 16, 2023
ee53094
code clean
chronolaw Mar 16, 2023
083b4a8
add logic from #10501
chronolaw Mar 16, 2023
817c312
refact log message
chronolaw Apr 6, 2023
84f60e4
fix lint
chronolaw Apr 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions kong-3.2.1-0.rockspec
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,7 @@ build = {
["kong.clustering.compat"] = "kong/clustering/compat/init.lua",
["kong.clustering.compat.version"] = "kong/clustering/compat/version.lua",
["kong.clustering.compat.removed_fields"] = "kong/clustering/compat/removed_fields.lua",
["kong.clustering.compat.checkers"] = "kong/clustering/compat/checkers.lua",
["kong.clustering.config_helper"] = "kong/clustering/config_helper.lua",
["kong.clustering.tls"] = "kong/clustering/tls.lua",

Expand Down
177 changes: 177 additions & 0 deletions kong/clustering/compat/checkers.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,177 @@
local ipairs = ipairs


local log_warn_message
do
local ngx_log = ngx.log
local ngx_WARN = ngx.WARN
local fmt = string.format

local KONG_VERSION = require("kong.meta").version

local _log_prefix = "[clustering] "

log_warn_message = function(hint, action, dp_version, log_suffix)
local msg = fmt("Kong Gateway v%s %s " ..
"which is incompatible with dataplane version %s " ..
"and will %s.",
KONG_VERSION, hint, dp_version, action)
ngx_log(ngx_WARN, _log_prefix, msg, log_suffix)
end
end


local compatible_checkers = {
{ 3003000000, --[[ 3.3.0.0 ]]
function(config_table, dp_version, log_suffix)
-- remove updated_at field for core entities ca_certificates, certificates, consumers,
-- targets, upstreams, plugins, workspaces, clustering_data_planes and snis
local entity_names = {
"ca_certificates", "certificates", "consumers", "targets", "upstreams",
"plugins", "workspaces", "clustering_data_planes", "snis",
}

local has_update
local updated_entities = {}

for _, name in ipairs(entity_names) do
for _, config_entity in ipairs(config_table[name] or {}) do
if config_entity["updated_at"] then

config_entity["updated_at"] = nil

has_update = true

if not updated_entities[name] then
log_warn_message("contains configuration '" .. name .. ".updated_at'",
"be removed",
dp_version,
log_suffix)

updated_entities[name] = true
end
end
end
end

return has_update
end
},

{ 3002000000, --[[ 3.2.0.0 ]]
function(config_table, dp_version, log_suffix)
local config_services = config_table["services"]
if not config_services then
return nil
end

local has_update
for _, t in ipairs(config_services) do
if t["protocol"] == "tls" then
if t["client_certificate"] or t["tls_verify"] or
t["tls_verify_depth"] or t["ca_certificates"]
then

t["client_certificate"] = nil
t["tls_verify"] = nil
t["tls_verify_depth"] = nil
t["ca_certificates"] = nil

has_update = true
end
end
end

if has_update then
log_warn_message("tls protocol service contains configuration 'service.client_certificate'" ..
"or 'service.tls_verify' or 'service.tls_verify_depth' or 'service.ca_certificates'",
"be removed",
dp_version,
log_suffix)
end

return has_update
end
},

{ 3002000000, --[[ 3.2.0.0 ]]
function(config_table, dp_version, log_suffix)
local config_upstreams = config_table["upstreams"]
if not config_upstreams then
return nil
end

local has_update
for _, t in ipairs(config_upstreams) do
if t["algorithm"] == "latency" then
t["algorithm"] = "round-robin"
has_update = true
end
end

if has_update then
log_warn_message("configuration 'upstream.algorithm' contains 'latency' option",
"fall back to 'round-robin'",
dp_version,
log_suffix)
end

return has_update
end
},

{ 3002000000, --[[ 3.2.0.0 ]]
function(config_table, dp_version, log_suffix)
local config_plugins = config_table["plugins"]
if not config_plugins then
return nil
end

local has_update
for _, plugin in ipairs(config_plugins) do
if plugin["instance_name"] ~= nil then
plugin["instance_name"] = nil
has_update = true
end
end

if has_update then
log_warn_message("contains configuration 'plugin.instance_name'",
"be removed",
dp_version,
log_suffix)
end

return has_update
end
},

{ 3001000000, --[[ 3.1.0.0 ]]
function(config_table, dp_version, log_suffix)
local config_upstreams = config_table["upstreams"]
if not config_upstreams then
return nil
end

local has_update
for _, t in ipairs(config_upstreams) do
if t["use_srv_name"] ~= nil then
t["use_srv_name"] = nil
has_update = true
end
end

if has_update then
log_warn_message("contains configuration 'upstream.use_srv_name'",
"be removed",
dp_version,
log_suffix)
end

return has_update
end
},
}


return compatible_checkers
91 changes: 6 additions & 85 deletions kong/clustering/compat/init.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ local extract_major_minor = version.extract_major_minor
local _log_prefix = "[clustering] "

local REMOVED_FIELDS = require("kong.clustering.compat.removed_fields")
local COMPATIBILITY_CHECKERS = require("kong.clustering.compat.checkers")
local CLUSTERING_SYNC_STATUS = constants.CLUSTERING_SYNC_STATUS
local KONG_VERSION = meta.version

Expand Down Expand Up @@ -360,91 +361,11 @@ function _M.update_compatible_payload(payload, dp_version, log_suffix)
end
end

if dp_version_num < 3003000000 --[[ 3.3.0.0 ]] then
-- remove updated_at field for core entities ca_certificates, certificates, consumers,
-- targets, upstreams, plugins, workspaces, clustering_data_planes and snis
local entity_names = {'ca_certificates', 'certificates', 'consumers', 'targets', 'upstreams',
'plugins', 'workspaces', 'clustering_data_planes', 'snis'}

for _, name in ipairs(entity_names) do
for _, config_entity in ipairs(config_table[name] or {}) do
if config_entity["updated_at"] ~= nil then
ngx_log(ngx_WARN, _log_prefix, "Kong Gateway v" .. KONG_VERSION ..
" contains configuration '" .. name .. ".updated_at'",
" which is incompatible with dataplane version " .. dp_version .. " and will",
" be removed.", log_suffix)
config_entity["updated_at"] = nil
has_update = true
end
end
end
end

if dp_version_num < 3002000000 --[[ 3.2.0.0 ]] then
local config_plugins = config_table["plugins"]
if config_plugins then
for _, plugin in ipairs(config_plugins) do
if plugin["instance_name"] ~= nil then
ngx_log(ngx_WARN, _log_prefix, "Kong Gateway v" .. KONG_VERSION ..
" contains configuration 'plugin.instance_name'",
" which is incompatible with dataplane version " .. dp_version .. " and will",
" be removed.", log_suffix)
plugin["instance_name"] = nil
has_update = true
end
end
end

local config_services = config_table["services"]
if config_services then
for _, t in ipairs(config_services) do
if t["protocol"] == "tls" then
if t["client_certificate"] or t["tls_verify"]
or t["tls_verify_depth"] or t["ca_certificates"] then
ngx_log(ngx_WARN, _log_prefix, "Kong Gateway v" .. KONG_VERSION ..
" tls protocol service contains configuration 'service.client_certificate'",
" or 'service.tls_verify' or 'service.tls_verify_depth' or 'service.ca_certificates'",
" which is incompatible with dataplane version " .. dp_version .. " and will",
" be removed.", log_suffix)
t["client_certificate"] = nil
t["tls_verify"] = nil
t["tls_verify_depth"] = nil
t["ca_certificates"] = nil
has_update = true
end
end
end
end

local config_upstreams = config_table["upstreams"]
if config_upstreams then
for _, t in ipairs(config_upstreams) do
if t["algorithm"] == "latency" then
ngx_log(ngx_WARN, _log_prefix, "Kong Gateway v" .. KONG_VERSION ..
" configuration 'upstream.algorithm' contain 'latency' option",
" which is incompatible with dataplane version " .. dp_version .. " and will",
" be fall back to 'round-robin'.", log_suffix)
t["algorithm"] = "round-robin"
has_update = true
end
end
end
end


if dp_version_num < 3001000000 --[[ 3.1.0.0 ]] then
local config_upstream = config_table["upstreams"]
if config_upstream then
for _, t in ipairs(config_upstream) do
if t["use_srv_name"] ~= nil then
ngx_log(ngx_WARN, _log_prefix, "Kong Gateway v" .. KONG_VERSION ..
" contains configuration 'upstream.use_srv_name'",
" which is incompatible with dataplane version " .. dp_version .. " and will",
" be removed.", log_suffix)
t["use_srv_name"] = nil
has_update = true
end
end
for _, checker in ipairs(COMPATIBILITY_CHECKERS) do
local ver = checker[1]
local fn = checker[2]
if dp_version_num < ver and fn(config_table, dp_version, log_suffix) then
has_update = true
end
end

Expand Down