feat: add ipv4/ipv6 dual stack support #4375

juwon8891 · 2024-09-30T16:10:53Z

What type of PR is this?

feat: add ipv4/ipv6 dual stack support

What this PR does / why we need it:
This PR adds IPv4/IPv6 dual stack support to Envoy Gateway. It implements test cases for routing to IPv6-only, dual-stack, and IPv4-only services using HTTPRoute resources. This enhancement is crucial for supporting modern network environments and ensuring compatibility with both IPv4 and IPv6 infrastructures.

Key changes include:

New test file backend_dualstack.go for testing IPv6 and dual-stack backends
New test file httproute_dualstack.go for testing HTTPRoute support with various IP versions
New manifest files for defining resources used in dual-stack tests
Implementation of getDnsLookupFamily function to control DNS lookup behavior

Which issue(s) this PR fixes:

Fixes #184

Additional Notes:

Tests are skipped in IPv4-only environments (IP_FAMILY=ipv4)
All tests run in IPv6 or dual-stack environments (IP_FAMILY=ipv6 or IP_FAMILY=dual)

api/v1alpha1/backend_types.go

api/v1alpha1/shared_types.go

test/cel-validation/envoyproxy_test.go

test/e2e/testdata/backend-dualstack.yaml

arkodg · 2024-09-30T21:48:31Z

hey @juwon8891 we probably also need to add some logic in

gateway/internal/gatewayapi/route.go

Line 1328 in 4b8c2f5

func (t *Translator) processServiceDestinationSetting(

which selects specific endpoints based on the ipFamilyPolicy field

api/v1alpha1/backend_types.go

site/content/en/v1.1/api/extension_types.md

arkodg · 2024-10-03T00:05:50Z

test/e2e/tests/httproute_dualstack.go

+		gwNN := types.NamespacedName{Name: "same-namespace", Namespace: ns}
+
+		t.Run("HTTPRoute to IPv6 only service", func(t *testing.T) {
+			routeNN := types.NamespacedName{Name: "ipv6-only-route", Namespace: ns}


can we also check for the IP type in the X-Forwarded-For response header ?

codecov · 2024-10-07T13:41:34Z

Codecov Report

Attention: Patch coverage is 61.11111% with 7 lines in your changes missing coverage. Please review.

Project coverage is 65.80%. Comparing base (7188dad) to head (faa584b).

Files with missing lines	Patch %	Lines
internal/gatewayapi/helpers.go	36.36%	7 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #4375      +/-   ##
==========================================
+ Coverage   65.78%   65.80%   +0.02%     
==========================================
  Files         210      210              
  Lines       31516    31557      +41     
==========================================
+ Hits        20732    20766      +34     
- Misses       9588     9594       +6     
- Partials     1196     1197       +1

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

arkodg · 2024-10-07T23:48:24Z

hey @juwon8891 lint is failing


internal/xds/translator/testdata/in/xds-ir/tcp-listener-ipfamily.yaml
  Error: 7:5 [indentation] wrong indentation: expected 6 but found 4
  Error: 11:9 [indentation] wrong indentation: expected 10 but found 8
  Error: 12:11 [indentation] wrong indentation: expected 12 but found 10
  Error: 13:32 [new-line-at-end-of-file] no new line character at the end of file

api/v1alpha1/envoyproxy_types.go

internal/ir/xds.go

api/v1alpha1/envoyproxy_types.go

internal/xds/translator/cluster.go

api/v1alpha1/envoyproxy_types.go

internal/ir/xds.go

internal/xds/translator/listener.go

arkodg · 2024-10-09T05:16:53Z

hey @juwon8891 looks like some gateway api tests got wiped out, can you add them back ?

test/e2e/tests/backend_dualstack.go

test/e2e/tests/httproute_dualstack.go

api/v1alpha1/envoyproxy_types.go

zhaohuabing · 2024-10-14T23:53:35Z

@juwon8891 Do you have time to address the comments this week? We want to ensure dual stack support is ready to be included in the coming v1.2.

juwon8891 · 2024-10-15T00:27:02Z

Yes, I'm working on it. I'll answer as soon as possible

internal/xds/translator/cluster.go

zirain · 2024-10-17T00:13:47Z

test/e2e/tests/httproute_dualstack.go

+		Namespace: ns,
+	}
+
+	http.MakeRequestAndExpectEventuallyConsistentResponse(t, suite.RoundTripper, suite.TimeoutConfig, gwAddr, expectedResponse)


gateway/test/e2e/tests/utils.go

Line 535 in 4b8c2f5

func QueryLogCountFromLoki(t *testing.T, c client.Client, keyValues map[string]string, match string) (int, error) {

can be used to verify pod ip/port

I'm still working on this test part. I'll post it separately as another PR.

internal/gatewayapi/backendtlspolicy.go

internal/xds/translator/listener.go

arkodg · 2024-10-22T01:08:46Z

hey @juwon8891, added some minor comments, but overall LGTM !

zirain · 2024-10-22T08:23:40Z

@juwon8891 please run make gen-check to pass the gen-check CI.

zirain · 2024-10-22T09:40:42Z

internal/ir/xds.go

@@ -224,8 +224,20 @@ type CoreListenerDetails struct {
 	ExtensionRefs []*UnstructuredRef `json:"extensionRefs,omitempty" yaml:"extensionRefs,omitempty"`
 	// Metadata is used to enrich envoy resource metadata with user and provider-specific information
 	Metadata *ResourceMetadata `json:"metadata,omitempty" yaml:"metadata,omitempty"`
+	// IPFamily specifies the IP address family for the gateway.
+	// It can be IPv4, IPv6, or Dual.
+	IPFamily IPFamily `json:"ipFamily,omitempty" yaml:"ipFamily,omitempty"`


can you make it a pointer? so that this PR won't be that huge.

I'll post it separately as another PR.

arkodg · 2024-10-22T16:12:27Z

@juwon8891 DCO is failing, can you sign your commits

Signed-off-by: Juwon Hwang (Kevin) <[email protected]>

arkodg

LGTM thanks !

guydc

LGTM!

guydc · 2024-10-24T21:48:51Z

/retest

juwon8891 requested a review from a team as a code owner September 30, 2024 16:10

juwon8891 force-pushed the dualstack branch from 020d3e9 to 14062cf Compare September 30, 2024 18:16

arkodg reviewed Sep 30, 2024

View reviewed changes

api/v1alpha1/backend_types.go Outdated Show resolved Hide resolved

arkodg reviewed Sep 30, 2024

View reviewed changes

api/v1alpha1/shared_types.go Outdated Show resolved Hide resolved

arkodg reviewed Sep 30, 2024

View reviewed changes

test/cel-validation/envoyproxy_test.go Outdated Show resolved Hide resolved

arkodg reviewed Sep 30, 2024

View reviewed changes

test/e2e/testdata/backend-dualstack.yaml Show resolved Hide resolved

zirain reviewed Oct 1, 2024

View reviewed changes

api/v1alpha1/backend_types.go Outdated Show resolved Hide resolved

zirain reviewed Oct 1, 2024

View reviewed changes

site/content/en/v1.1/api/extension_types.md Outdated Show resolved Hide resolved

arkodg reviewed Oct 3, 2024

View reviewed changes

juwon8891 force-pushed the dualstack branch from 14062cf to 68b9eb2 Compare October 7, 2024 13:29

juwon8891 force-pushed the dualstack branch 2 times, most recently from 263b8bf to b97d58a Compare October 8, 2024 22:21

zirain reviewed Oct 9, 2024

View reviewed changes

api/v1alpha1/envoyproxy_types.go Outdated Show resolved Hide resolved

zirain reviewed Oct 9, 2024

View reviewed changes

api/v1alpha1/envoyproxy_types.go Outdated Show resolved Hide resolved

zhaohuabing reviewed Oct 9, 2024

View reviewed changes

api/v1alpha1/envoyproxy_types.go Show resolved Hide resolved

zhaohuabing reviewed Oct 9, 2024

View reviewed changes

internal/ir/xds.go Outdated Show resolved Hide resolved

zhaohuabing reviewed Oct 9, 2024

View reviewed changes

api/v1alpha1/envoyproxy_types.go Show resolved Hide resolved

This comment was marked as resolved.

Sign in to view

zhaohuabing reviewed Oct 9, 2024

View reviewed changes

internal/xds/translator/cluster.go Outdated Show resolved Hide resolved

arkodg reviewed Oct 9, 2024

View reviewed changes

api/v1alpha1/envoyproxy_types.go Outdated Show resolved Hide resolved

arkodg reviewed Oct 9, 2024

View reviewed changes

api/v1alpha1/envoyproxy_types.go Outdated Show resolved Hide resolved

arkodg reviewed Oct 9, 2024

View reviewed changes

internal/ir/xds.go Outdated Show resolved Hide resolved

arkodg reviewed Oct 9, 2024

View reviewed changes

internal/xds/translator/listener.go Outdated Show resolved Hide resolved

zirain reviewed Oct 9, 2024

View reviewed changes

test/e2e/tests/backend_dualstack.go Outdated Show resolved Hide resolved

zirain reviewed Oct 9, 2024

View reviewed changes

test/e2e/tests/backend_dualstack.go Outdated Show resolved Hide resolved

zirain reviewed Oct 9, 2024

View reviewed changes

test/e2e/tests/httproute_dualstack.go Outdated Show resolved Hide resolved

zirain reviewed Oct 9, 2024

View reviewed changes

test/e2e/tests/httproute_dualstack.go Outdated Show resolved Hide resolved

zirain reviewed Oct 9, 2024

View reviewed changes

api/v1alpha1/envoyproxy_types.go Outdated Show resolved Hide resolved

zhaohuabing reviewed Oct 16, 2024

View reviewed changes

internal/xds/translator/cluster.go Show resolved Hide resolved

zirain reviewed Oct 17, 2024

View reviewed changes

arkodg reviewed Oct 22, 2024

View reviewed changes

internal/gatewayapi/backendtlspolicy.go Outdated Show resolved Hide resolved

arkodg reviewed Oct 22, 2024

View reviewed changes

internal/xds/translator/listener.go Outdated Show resolved Hide resolved

zirain reviewed Oct 22, 2024

View reviewed changes

juwon8891 force-pushed the dualstack branch from 15b2967 to 0b36cb8 Compare October 22, 2024 09:50

juwon8891 force-pushed the dualstack branch from 0b36cb8 to faa584b Compare October 23, 2024 02:04

juwon8891 added 4 commits October 24, 2024 20:46

feat: dualstack support

6732a91

Signed-off-by: Juwon Hwang (Kevin) <[email protected]>

chore: rebase main

06719ef

Signed-off-by: Juwon Hwang (Kevin) <[email protected]>

chore: fix lint

d52f0ad

Signed-off-by: Juwon Hwang (Kevin) <[email protected]>

feat: dual stack support

dc7edb1

Signed-off-by: Juwon Hwang (Kevin) <[email protected]>

juwon8891 force-pushed the dualstack branch from 54afd85 to dc7edb1 Compare October 24, 2024 11:46

feat: dual stack support

bb01a9c

Signed-off-by: Juwon Hwang (Kevin) <[email protected]>

arkodg approved these changes Oct 24, 2024

View reviewed changes

arkodg added this to the v1.2.0-rc1 milestone Oct 24, 2024

guydc approved these changes Oct 24, 2024

View reviewed changes

arkodg merged commit d7849d7 into envoyproxy:main Oct 24, 2024
25 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add ipv4/ipv6 dual stack support #4375

feat: add ipv4/ipv6 dual stack support #4375

juwon8891 commented Sep 30, 2024

arkodg commented Sep 30, 2024

arkodg Oct 3, 2024

codecov bot commented Oct 7, 2024 •

edited

Loading

arkodg commented Oct 7, 2024

This comment was marked as resolved.

arkodg commented Oct 9, 2024

zhaohuabing commented Oct 14, 2024 •

edited

Loading

juwon8891 commented Oct 15, 2024

zirain Oct 17, 2024

juwon8891 Oct 22, 2024

arkodg commented Oct 22, 2024

zirain commented Oct 22, 2024

zirain Oct 22, 2024

juwon8891 Oct 22, 2024

arkodg commented Oct 22, 2024

arkodg left a comment

guydc left a comment

guydc commented Oct 24, 2024

feat: add ipv4/ipv6 dual stack support #4375

feat: add ipv4/ipv6 dual stack support #4375

Conversation

juwon8891 commented Sep 30, 2024

arkodg commented Sep 30, 2024

arkodg Oct 3, 2024

Choose a reason for hiding this comment

codecov bot commented Oct 7, 2024 • edited Loading

Codecov Report

arkodg commented Oct 7, 2024

This comment was marked as resolved.

arkodg commented Oct 9, 2024

zhaohuabing commented Oct 14, 2024 • edited Loading

juwon8891 commented Oct 15, 2024

zirain Oct 17, 2024

Choose a reason for hiding this comment

juwon8891 Oct 22, 2024

Choose a reason for hiding this comment

arkodg commented Oct 22, 2024

zirain commented Oct 22, 2024

zirain Oct 22, 2024

Choose a reason for hiding this comment

juwon8891 Oct 22, 2024

Choose a reason for hiding this comment

arkodg commented Oct 22, 2024

arkodg left a comment

Choose a reason for hiding this comment

guydc left a comment

Choose a reason for hiding this comment

guydc commented Oct 24, 2024

codecov bot commented Oct 7, 2024 •

edited

Loading

zhaohuabing commented Oct 14, 2024 •

edited

Loading