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.

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

feat(core): dedicated config processing #11784

Merged
merged 1 commit into from
Oct 18, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 4 additions & 0 deletions changelog/unreleased/kong/dedicated_config_processing.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
message: |
rename `privileged_agent` to `dedicated_config_processing. Enable `dedicated_config_processing` by default
type: feature
scope: Core
11 changes: 10 additions & 1 deletion kong.conf.default
Original file line number Diff line number Diff line change
Expand Up @@ -182,6 +182,15 @@
# cache (i.e. when the configured
# `mem_cache_size`) is full.

#dedicated_config_processing = on # Enables or disables a special worker
# process for configuration processing. This process
# increases memory usage a little bit while
# allowing to reduce latencies by moving some
# background tasks, such as CP/DP connection
# handling, to an additional worker process specific
# to handling these background tasks.
# Currently this has effect only on data planes.

#pluginserver_names = # Comma-separated list of names for pluginserver
# processes. The actual names are used for
# log messages and to relate the actual settings.
Expand Down Expand Up @@ -746,7 +755,7 @@
# the pattern defined by `openssl ciphers`.
# This value is ignored if `ssl_cipher_suite`
# is not `custom`.
# If you use DHE ciphers, you must also
# If you use DHE ciphers, you must also
# configure the `ssl_dhparam` parameter.

#ssl_protocols = TLSv1.1 TLSv1.2 TLSv1.3
Expand Down
2 changes: 1 addition & 1 deletion kong/clustering/utils.lua
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ end


function _M.is_dp_worker_process()
if kong.configuration.privileged_agent then
if kong.configuration.dedicated_config_processing then
return process_type() == "privileged agent"
end

Expand Down
13 changes: 12 additions & 1 deletion kong/conf_loader/init.lua
Original file line number Diff line number Diff line change
Expand Up @@ -434,7 +434,18 @@ local CONF_PARSERS = {
dns_not_found_ttl = { typ = "number" },
dns_error_ttl = { typ = "number" },
dns_no_sync = { typ = "boolean" },
privileged_agent = { typ = "boolean" },
privileged_worker = {
typ = "boolean",
deprecated = {
replacement = "dedicated_config_processing",
alias = function(conf)
if conf.dedicated_config_processing == nil and
conf.privileged_worker ~= nil then
conf.dedicated_config_processing = conf.privileged_worker
end
end,
}},
dedicated_config_processing = { typ = "boolean" },
worker_consistency = { enum = { "strict", "eventual" },
-- deprecating values for enums
deprecated = {
Expand Down
4 changes: 2 additions & 2 deletions kong/init.lua
Original file line number Diff line number Diff line change
Expand Up @@ -470,7 +470,7 @@ local function execute_collected_plugins_iterator(plugins_iterator, phase, ctx)
span:finish()
end
end

if is_timing_enabled then
req_dyn_hook_run_hooks(ctx, "timing", "after:plugin_iterator")
end
Expand Down Expand Up @@ -743,7 +743,7 @@ function Kong.init()

require("resty.kong.var").patch_metatable()

if config.privileged_agent and is_data_plane(config) then
if config.dedicated_config_processing and is_data_plane(config) then
-- TODO: figure out if there is better value than 2048
local ok, err = process.enable_privileged_agent(2048)
if not ok then
Expand Down
4 changes: 2 additions & 2 deletions kong/templates/kong_defaults.lua
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ dns_not_found_ttl = 30
dns_error_ttl = 1
dns_no_sync = off

privileged_agent = off
dedicated_config_processing = on
worker_consistency = eventual
worker_state_update_frequency = 5

Expand Down Expand Up @@ -203,5 +203,5 @@ wasm_filters_path = NONE
wasm_dynamic_module = NONE

request_debug = on
request_debug_token =
request_debug_token =
]]
44 changes: 44 additions & 0 deletions spec/01-unit/03-conf_loader_spec.lua
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,8 @@ describe("Configuration loader", function()
assert.same({}, conf.admin_gui_ssl_cert_key)
assert.same({}, conf.status_ssl_cert)
assert.same({}, conf.status_ssl_cert_key)
assert.same(nil, conf.privileged_agent)
assert.same(true, conf.dedicated_config_processing)
assert.same(false, conf.allow_debug_header)
assert.is_nil(getmetatable(conf))
end)
Expand Down Expand Up @@ -2013,6 +2015,48 @@ describe("Configuration loader", function()
assert.equal(nil, err)
end)

it("privileged_agent -> dedicated_config_processing", function()
local conf, err = assert(conf_loader(nil, {
privileged_agent = "on",
}))
assert.same(nil, conf.privileged_agent)
assert.same(true, conf.dedicated_config_processing)
assert.equal(nil, err)

-- no clobber
conf, err = assert(conf_loader(nil, {
privileged_agent = "on",
dedicated_config_processing = "on",
}))
assert.same(true, conf.dedicated_config_processing)
assert.same(nil, conf.privileged_agent)
assert.equal(nil, err)

conf, err = assert(conf_loader(nil, {
privileged_agent = "off",
dedicated_config_processing = "on",
}))
assert.same(true, conf.dedicated_config_processing)
assert.same(nil, conf.privileged_agent)
assert.equal(nil, err)

conf, err = assert(conf_loader(nil, {
privileged_agent = "on",
dedicated_config_processing = "off",
}))
assert.same(false, conf.dedicated_config_processing)
assert.same(nil, conf.privileged_agent)
assert.equal(nil, err)

conf, err = assert(conf_loader(nil, {
privileged_agent = "off",
dedicated_config_processing = "off",
}))
assert.same(false, conf.dedicated_config_processing)
assert.same(nil, conf.privileged_agent)
assert.equal(nil, err)
end)

it("opentelemetry_tracing", function()
local conf, err = assert(conf_loader(nil, {
opentelemetry_tracing = "request,router",
Expand Down
2 changes: 2 additions & 0 deletions spec/kong_tests.conf
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ anonymous_reports = off

worker_consistency = strict

dedicated_config_processing = on

dns_hostsfile = spec/fixtures/hosts

nginx_main_worker_processes = 1
Expand Down