docs: Add note about XDS service IP and steps for local debugging, README cleanup #11260
Conversation
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
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR updates documentation related to local debugging of kgateway, including clarifying the IP address configuration for the xDS service and enhancing the local testing instructions.
- Updated README to remove an outdated reference to Gloo Gateway.
- Enhanced local-controller.md with an additional note on the xDS service IP and comprehensive steps for running and inspecting local builds.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| test/kubernetes/e2e/README.md | Removed an outdated reference to Gloo Gateway for clarity. |
| devel/debugging/local-controller.md | Added a note on an alternative xDS service IP and detailed local debugging instructions. |
github-actions
bot
added
kind/cleanup
dhaifley
force-pushed
the
docs-local-debugging
branch
from
7030968 to
25ae970
Compare
Contributor
There was a problem hiding this comment.
Pull Request Overview
Adds clarification for local debugging of the XDS service host IP and cleans up a stale reference in the end-to-end test README.
- Clarify alternative IP for
KGW_XDS_SERVICE_HOSTwhen running in kind - Provide step-by-step instructions to run and inspect local builds and snapshots
- Fix the “Gloo Gateway” reference in the e2e README
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| test/kubernetes/e2e/README.md | Updated generic “installation” wording and removed outdated “Gloo Gateway” reference |
| devel/debugging/local-controller.md | Added alternative XDS host IP note and new section with step-by-step local debugging guide |
|
|
||
| > Note: `172.17.0.1` is IP address of the `docker0` bridge interface that allows pods running in `Kind` to access the host network, thereby allowing the Gateway proxy to connect to the xDS service running on the host. | ||
| > Additional note: Replacing `172.17.0.1` with `192.168.65.254`, as the value for `KGW_XDS_SERVICE_HOST` may help, if the gateway proxy pods in a local kind cluster are unable to connect to the xDS service running on the local machine. `192.168.65.254` is the IP address that `host.docker.internal` resolves to on gateway proxy pods when running in a local kind cluster. |
There was a problem hiding this comment.
Add an explicit command example, e.g., export KGW_XDS_SERVICE_HOST=192.168.65.254, so readers know exactly how to set the environment variable.
Suggested change
| > Additional note: Replacing `172.17.0.1` with `192.168.65.254`, as the value for `KGW_XDS_SERVICE_HOST` may help, if the gateway proxy pods in a local kind cluster are unable to connect to the xDS service running on the local machine. `192.168.65.254` is the IP address that `host.docker.internal` resolves to on gateway proxy pods when running in a local kind cluster. | |
| > Additional note: Replacing `172.17.0.1` with `192.168.65.254`, as the value for `KGW_XDS_SERVICE_HOST` may help, if the gateway proxy pods in a local kind cluster are unable to connect to the xDS service running on the local machine. For example, you can set it using the following command: | |
| > | |
| > ```bash | |
| > export KGW_XDS_SERVICE_HOST=192.168.65.254 | |
| > ``` | |
| > | |
| > `192.168.65.254` is the IP address that `host.docker.internal` resolves to on gateway proxy pods when running in a local kind cluster. |
Member
There was a problem hiding this comment.
I think this suggestion is reasonable to make it easy to c/p the env var.
…ugging local builds, README cleanup Signed-off-by: David Haifley <[email protected]>
dhaifley
force-pushed
the
docs-local-debugging
branch
from
25ae970 to
4638300
Compare
shashankram
approved these changes
May 21, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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
Change Type
Changelog