fix: listener on IPv6 first cluster #4573

zirain · 2024-10-30T07:35:26Z

fix: #4565
xref: #4572
Separate from : #4550

EG controller will detect the cluster is IPv6 or IPv4 first base on pod IP.
controller will change the default listener socket address base on that, use :: instead of 0.0.0.0 when IPv6 first.

codecov · 2024-10-30T09:03:09Z

Codecov Report

Attention: Patch coverage is 80.95238% with 16 lines in your changes missing coverage. Please review.

Project coverage is 65.54%. Comparing base (5698e88) to head (1c4d283).

Files with missing lines	Patch %	Lines
internal/utils/net/ip.go	73.68%	4 Missing and 1 partial ⚠️
internal/xds/translator/listener.go	85.18%	3 Missing and 1 partial ⚠️
internal/gatewayapi/listener.go	57.14%	2 Missing and 1 partial ⚠️
internal/cmd/envoy/shutdown_manager.go	0.00%	2 Missing ⚠️
internal/gatewayapi/runner/runner.go	0.00%	1 Missing ⚠️
internal/infrastructure/host/proxy_infra.go	0.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #4573      +/-   ##
==========================================
+ Coverage   65.50%   65.54%   +0.04%     
==========================================
  Files         211      212       +1     
  Lines       31945    31988      +43     
==========================================
+ Hits        20925    20967      +42     
- Misses       9774     9777       +3     
+ Partials     1246     1244       -2

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

internal/infrastructure/kubernetes/ratelimit/resource.go

charts/gateway-helm/templates/envoy-gateway-deployment.yaml

zirain · 2024-10-31T13:20:10Z

internal/cmd/envoy/shutdown_manager.go

 	if resp, err := http.Post(fmt.Sprintf("http://%s:%d/%s",
-		bootstrap.EnvoyAdminAddress, bootstrap.EnvoyAdminPort, path), "application/json", nil); err != nil {
+		bootstrap.AdminAddress(egv1a1.IPv4), bootstrap.EnvoyAdminPort, path), "application/json", nil); err != nil {


this may not right, what about change it to localhost? cc @arkodg @zhaohuabing

+1 to localhost, good idea

+1 localhost make things easier

zhaohuabing · 2024-11-01T06:20:50Z

internal/utils/net/ip.go

+}
+
+func PreferIPFamily(ipv6First bool, envoyProxy *egv1a1.EnvoyProxy) egv1a1.IPFamily {
+	if ipv6First {


To align with the IPFamily API docs, EG should default to IPv4.

// IPFamily specifies the IP family for the EnvoyProxy fleet. // This setting only affects the Gateway listener port and does not impact // other aspects of the Envoy proxy configuration. // If not specified, the system will operate as follows: // - It defaults to IPv4 only. // - IPv6 and dual-stack environments are not supported in this default configuration. // Note: To enable IPv6 or dual-stack functionality, explicit configuration is required. // +kubebuilder:validation:Enum=IPv4;IPv6;DualStack // +optional IPFamily *IPFamily `json:"ipFamily,omitempty"`

Or do we want to change to:

Default to the IP family of the POD IP of the Envoy Proxy/Envoy Gateway?

This would have EG attempt to infer user's intented IP Family for the listening port of the Envoy proxy, which might not always be accurate.

Should we always default to IPv4 and require users to explicitly specify IPv6 if desired? It will make the IPFamily choice more explicit.

Should we always default to IPv4 and require users to explicitly specify IPv6 if desired? It will make the IPFamily choice more explicit.

this will make it's hard to use on IPv6 first cluster.

Yes, this approach requires one more IPFamily setting for users who want to use IPv6.

But if we make it implicit, "Default to the IP family of the POD IP of the Envoy Proxy/Envoy Gateway" may be challenging to clearly explain in the EG doc.

yes, we should do that.

arkodg · 2024-11-01T22:29:19Z

internal/xds/translator/listener.go

@@ -146,36 +147,6 @@ func originalIPDetectionExtensions(clientIPDetection *ir.ClientIPDetectionSettin
 	return extensionConfig
 }

-func setAddressByIPFamily(socketAddress *corev3.SocketAddress, ipFamily *ir.IPFamily, port uint32) []*listenerv3.AdditionalAddress {


why does this function need to change ?

Before this function change socketAddress and return additionalAddress in the same time.

arkodg · 2024-11-01T22:30:43Z

internal/xds/bootstrap/bootstrap.go


 	defaultSdsTrustedCAPath   = "/sds/xds-trusted-ca.json"
 	defaultSdsCertificatePath = "/sds/xds-certificate.json"
 )

+func AdminAddress(family egv1a1.IPFamily) string {
+	if family == egv1a1.IPv6 {


will localhost here work ?

return error malformed IP address: localhost

arkodg · 2024-11-01T22:32:19Z

internal/xds/bootstrap/bootstrap.go

+	return envoyAdminAddress
+}
+
+func readinessAddress(family egv1a1.IPFamily) string {


imo just the changes in this file should be enough to support pure IPv6 case as well as dual stack case, wdyt

need changes around dynamic istener for IPv6 first/pure cluster.

Signed-off-by: zirain <[email protected]>

zirain requested a review from a team as a code owner October 30, 2024 07:35

zirain force-pushed the ipv6-listener branch from 3271db8 to 082e472 Compare October 30, 2024 08:56

arkodg reviewed Oct 30, 2024

View reviewed changes

internal/infrastructure/kubernetes/ratelimit/resource.go Outdated Show resolved Hide resolved

arkodg reviewed Oct 30, 2024

View reviewed changes

charts/gateway-helm/templates/envoy-gateway-deployment.yaml Show resolved Hide resolved

zirain mentioned this pull request Oct 31, 2024

IPv6 known issues #4572

Closed

7 tasks

zirain force-pushed the ipv6-listener branch 3 times, most recently from 00e8a5c to c266511 Compare October 31, 2024 11:55

zirain commented Oct 31, 2024

View reviewed changes

zirain added the area/IPv6 IPv6 related issues label Oct 31, 2024

zhaohuabing reviewed Nov 1, 2024

View reviewed changes

arkodg reviewed Nov 1, 2024

View reviewed changes

zirain force-pushed the ipv6-listener branch from 5c4e99b to d931570 Compare November 5, 2024 02:45

fix: listener on IPv6 first cluster

c0ef9f2

Signed-off-by: zirain <[email protected]>

zirain force-pushed the ipv6-listener branch from d931570 to c0ef9f2 Compare November 6, 2024 00:08

update api

1c4d283

Signed-off-by: zirain <[email protected]>

zirain closed this Nov 6, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: listener on IPv6 first cluster #4573

fix: listener on IPv6 first cluster #4573

zirain commented Oct 30, 2024 •

edited

Loading

codecov bot commented Oct 30, 2024 •

edited

Loading

zirain Oct 31, 2024 •

edited

Loading

arkodg Oct 31, 2024

zhaohuabing Nov 1, 2024

zhaohuabing Nov 1, 2024 •

edited

Loading

zirain Nov 1, 2024

zhaohuabing Nov 1, 2024

zirain Nov 1, 2024

arkodg Nov 1, 2024

zirain Nov 2, 2024

arkodg Nov 1, 2024

zirain Nov 2, 2024 •

edited

Loading

arkodg Nov 1, 2024

zirain Nov 5, 2024

fix: listener on IPv6 first cluster #4573

fix: listener on IPv6 first cluster #4573

Conversation

zirain commented Oct 30, 2024 • edited Loading

codecov bot commented Oct 30, 2024 • edited Loading

Codecov Report

zirain Oct 31, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

zhaohuabing Nov 1, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

zirain Nov 2, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

zirain commented Oct 30, 2024 •

edited

Loading

codecov bot commented Oct 30, 2024 •

edited

Loading

zirain Oct 31, 2024 •

edited

Loading

zhaohuabing Nov 1, 2024 •

edited

Loading

zirain Nov 2, 2024 •

edited

Loading