Skip to content

docs: add 2.1.0 breaking-change note for listener port matching#2784

Open
AlinsRan wants to merge 1 commit into
apache:masterfrom
AlinsRan:fix/listener-port-match-default-off
Open

docs: add 2.1.0 breaking-change note for listener port matching#2784
AlinsRan wants to merge 1 commit into
apache:masterfrom
AlinsRan:fix/listener-port-match-default-off

Conversation

@AlinsRan

@AlinsRan AlinsRan commented Jun 10, 2026

Copy link
Copy Markdown
Contributor

What this PR does

Adds a Breaking Changes note to the 2.1.0 CHANGELOG documenting the server_port / listener-port-match behavior. CHANGELOG only — no code or default change.

Why

Port-based routing for Gateway API routes (#2703, shipped in 2.1.0) injects a server_port route var derived from the Gateway listener port (e.g. 80/443). But the APISIX server_port variable reflects the port the data plane actually listens on (e.g. 9080/9443, when a Service maps 80/443 → 9080/9443). When those differ, the injected var never matches and routes return 404 after upgrading.

The note explains what changed, why it can break, and the listener_port_match_mode: off mitigation. See #2782.

Refs #2782

@AlinsRan AlinsRan force-pushed the fix/listener-port-match-default-off branch 3 times, most recently from ff2e73b to c300ecb Compare June 10, 2026 03:19
@AlinsRan AlinsRan changed the title fix: change default listener_port_match_mode from auto to off docs: document server_port listener-port-match breaking change in 2.1.0 Jun 10, 2026
Port-based routing (apache#2703) injects a server_port var from the Gateway
listener port, but APISIX server_port reflects the data-plane listening
port (e.g. 9080/9443). When they differ, routes 404. Document this in
the 2.1.0 CHANGELOG with the listener_port_match_mode: off mitigation.
@AlinsRan AlinsRan force-pushed the fix/listener-port-match-default-off branch from c300ecb to 7bbe58e Compare June 10, 2026 03:44
@AlinsRan AlinsRan changed the title docs: document server_port listener-port-match breaking change in 2.1.0 docs: add 2.1.0 breaking-change note for listener port matching Jun 10, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant