feat: kubernetes discovery readiness check#12852
Merged
nic-6443 merged 17 commits intoapache:masterfrom Jan 28, 2026
Merged
Conversation
…hcheck # Conflicts: # apisix/discovery/kubernetes/init.lua
dosubot
Bot
added
size:L
Baoyuantop
reviewed
Jan 4, 2026
| if not endpoint_dict then | ||
| core.log.error("failed to get lua_shared_dict:", get_endpoint_dict_name(id), | ||
| ", please check your APISIX version") | ||
| return false, "failed to get lua_shared_dict: ", get_endpoint_dict_name(id), |
Contributor
There was a problem hiding this comment.
Please use .. for string concatenation.
|
|
||
|
|
||
| local function post_list(handle) | ||
| handle.endpoint_dict:safe_set("discovery_ready",true) |
Contributor
There was a problem hiding this comment.
safe_set lacks error handling
| end | ||
| end | ||
| end | ||
| return true; |
Contributor
There was a problem hiding this comment.
Please do not use semicolons.
| ngx.exit(200) | ||
| local http = require("resty.http") | ||
| local healthcheck_uri = "http://127.0.0.1:7085" .. "/status/ready" | ||
| for i = 1, 4 do |
Contributor
There was a problem hiding this comment.
Add a comment explaining the rationale for selecting the number of retries.
Contributor
Author
There was a problem hiding this comment.
APISIX takes time to load data from the Kubernetes API server. In scenarios with small amounts of data, it may complete in less than 1 second. The maximum wait time I set, 5 seconds, is solely to account for network fluctuations.
Baoyuantop
added
the
wait for update
Baoyuantop
added
awaiting review
and removed
wait for update
nic-6443
previously approved these changes
Jan 26, 2026
AlinsRan
reviewed
Jan 26, 2026
|
|
||
|
|
||
| local function post_list(handle) | ||
| local _, err = handle.endpoint_dict:safe_set("discovery_ready",true) |
Contributor
There was a problem hiding this comment.
Suggested change
| local _, err = handle.endpoint_dict:safe_set("discovery_ready",true) | |
| local _, err = handle.endpoint_dict:safe_set("discovery_ready", true) |
AlinsRan
previously approved these changes
Jan 26, 2026
nic-chen
previously approved these changes
Jan 26, 2026
Contributor
Author
|
550e240 Please help review the code again. |
nic-6443
previously approved these changes
Jan 27, 2026
nic-chen
previously approved these changes
Jan 27, 2026
membphis
reviewed
Jan 27, 2026
| for _, key in ipairs(handle.existing_keys) do | ||
| if not handle.current_keys_hash[key] then | ||
| core.log.info("kubernetes discovery module found dirty data in shared dict, key: ", | ||
| key) |
Contributor
Author
There was a problem hiding this comment.
Several indentation issues have been fixed.
| local endpoint_dict = get_endpoint_dict(id) | ||
| if not endpoint_dict then | ||
| core.log.error("failed to get lua_shared_dict:", get_endpoint_dict_name(id), | ||
| ", please check your APISIX version") |
| return | ||
| local function config_ready_check() | ||
| local role = core.table.try_read_attr(local_conf, "deployment", "role") | ||
| local provider = core.table.try_read_attr(local_conf, "deployment", "role_" .. |
Member
There was a problem hiding this comment.
local provider = core.table.try_read_attr(local_conf, "deployment",
"role_" .. role, "config_provider")
| return false, "unknown config provider: " .. tostring(provider) | ||
| end | ||
|
|
||
| local status_shdict = ngx.shared["status-report"] |
Member
There was a problem hiding this comment.
we may get nil, need to check it
| local worker_count = ngx.worker.count() | ||
| if #ids ~= worker_count then | ||
| local error = "worker count: " .. worker_count .. " but status report count: " .. #ids | ||
| core.log.warn(error) |
Member
There was a problem hiding this comment.
should we use error log level?
| local ready = status_shdict:get(id) | ||
| if not ready then | ||
| local error = "worker id: " .. id .. " has not received configuration" | ||
| core.log.warn(error) |
nic-6443
approved these changes
Jan 28, 2026
nic-chen
approved these changes
Jan 28, 2026
membphis
approved these changes
Jan 28, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This pull request adds a Kubernetes service discovery readiness status query to the /status/ready interface. Specifically, the readiness check calls the
check_discovery_readymethod of the service discovery module. Other types of service discovery, such as Consul, can also adapt this method to support the service discovery module.relate discuss:
#12635
Which issue(s) this PR fixes:
Fixes #
Checklist