docs: state that the proxy has no native control-plane client yet - #8
Merged
Merged
Conversation
PROXY-REGISTRATION.md told users to set control_plane_url, node_id and node_key on the proxy. Those settings do not exist: the proxy ships no control-plane client, so a stock binary never registers or heartbeats. Documents what actually connects a proxy today (an external sidecar speaking the node API) and flags the gap in the README status.
Contributor
Author
|
Merging despite red CI: this PR touches only
Both are worth fixing separately — the PromEx poller likely needs to be disabled in the test env or given |
Closed
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
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.
Fixes #7.
@scheibling was right, and the confusion was our fault.
docs/PROXY-REGISTRATION.mdsection 2 told users to setcontrol_plane_url,node_idandnode_key"in the proxy's configuration" — those settings do not exist. I checkedzentinelproxy/zentinelonmain: there is no control-plane client incrates/at all (the only grep hit fornode_keyisvnode_keyin the consistent-hash upstream code). A stock proxy binary will never register, heartbeat, or pull a bundle.What is actually true: the control-plane side of the workflow is implemented and exercised end to end, but the node half is driven by the built-in node simulator, not by the proxy. Connecting real proxies today needs an external sidecar speaking the node API.
This PR makes that explicit rather than leaving people to discover it:
bundles/latest, verify checksum, reload, reportactive_bundle_id— with a workingcurlheartbeat example.## Statussection now notes that "works end-to-end" means on the control-plane side, since that phrasing is where the misunderstanding starts.No functional changes. Native proxy-side support is still worth tracking separately.