feat: deprecate `--gateway-discovery-dns-strategy` - make discovery always work #7033

programmer04 · 2025-01-24T11:50:51Z

What this PR does / why we need it:

Streamline usage of KIC by deprecating --gateway-discovery-dns-strategy. Do not rely on DNS that is in a cluster, but use IP addresses directly to connect to Pods with Kong Gateway and leverage TLSServerName for certificate verification. With such a setup, it works out of the box in any environment. The problematic one was Standard GKE, which uses kube-dns, see the respective issue kubernetes/dns#633 the proposed solution works on such an environment. The flag is left and marked as deprecated to not break existing deployments, but the passed option is meaningless.

Which issue this PR fixes:

Part of Kong/gateway-operator#179 actual fix for KGO will be when it starts using KIC v3.5.x

Special notes for your reviewer:

Testing

The image build from this branch is available here: europe-docker.pkg.dev/k8s-team-playground/skaffold/kic:v3.4.0-91-g38279e778 (ARM64 and AMD64 in a public registry.

In internal/manager/config.go:345 sentence this setting is deprecated... starts lowercase on purpose, because it will be concatenated with Flag --gateway-discovery-dns-strategy has been deprecated, automatically.

Some e2e tests fail, but it's something different than touched in this PR.

PR Readiness Checklist:

Complete these before marking the PR as ready to review:

the CHANGELOG.md release notes have been updated to reflect any significant (and particularly user-facing) changes introduced by this PR

codecov · 2025-01-24T12:41:03Z

Codecov Report

Attention: Patch coverage is 95.31250% with 3 lines in your changes missing coverage. Please review.

Project coverage is 76.7%. Comparing base (d4d18a4) to head (1ceee05).
Report is 50 commits behind head on main.

Files with missing lines	Patch %	Lines
internal/adminapi/kong.go	70.0%	2 Missing and 1 partial ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##            main   #7033     +/-   ##
=======================================
- Coverage   76.9%   76.7%   -0.2%     
=======================================
  Files        214     213      -1     
  Lines      25169   25004    -165     
=======================================
- Hits       19356   19181    -175     
- Misses      4794    4817     +23     
+ Partials    1019    1006     -13

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

team-k8s-bot · 2025-01-28T13:39:02Z

E2E (targeted) tests with KIND-based clusters were started at https://github.com/Kong/kubernetes-ingress-controller/actions/runs/13011710622

internal/adminapi/endpoints.go

czeslavo

Looks legit to me. 👍 Nice improvement.

internal/adminapi/endpoints.go

… always work

internal/manager/config.go

internal/adminapi/kong.go

Co-authored-by: Patryk Małek <patryk.malek@konghq.com>

* chore(deps): bump github.com/docker/docker (#7054) Bumps [github.com/docker/docker](https://github.com/docker/docker) from 27.4.1+incompatible to 27.5.1+incompatible. - [Release notes](https://github.com/docker/docker/releases) - [Commits](moby/moby@v27.4.1...v27.5.1) --- updated-dependencies: - dependency-name: github.com/docker/docker dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * chore(deps): bump google.golang.org/api from 0.217.0 to 0.218.0 (#7025) Bumps [google.golang.org/api](https://github.com/googleapis/google-api-go-client) from 0.217.0 to 0.218.0. - [Release notes](https://github.com/googleapis/google-api-go-client/releases) - [Changelog](https://github.com/googleapis/google-api-go-client/blob/main/CHANGES.md) - [Commits](googleapis/google-api-go-client@v0.217.0...v0.218.0) --- updated-dependencies: - dependency-name: google.golang.org/api dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * chore(deps): bump github.com/Kong/sdk-konnect-go from 0.1.24 to 0.1.28 (#7056) Bumps [github.com/Kong/sdk-konnect-go](https://github.com/Kong/sdk-konnect-go) from 0.1.24 to 0.1.28. - [Release notes](https://github.com/Kong/sdk-konnect-go/releases) - [Changelog](https://github.com/Kong/sdk-konnect-go/blob/main/RELEASE.md) - [Commits](Kong/sdk-konnect-go@v0.1.24...v0.1.28) --- updated-dependencies: - dependency-name: github.com/Kong/sdk-konnect-go dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * chore(deps): bump github.com/evanphx/json-patch/v5 from 5.9.0 to 5.9.11 (#7057) Bumps [github.com/evanphx/json-patch/v5](https://github.com/evanphx/json-patch) from 5.9.0 to 5.9.11. - [Release notes](https://github.com/evanphx/json-patch/releases) - [Commits](evanphx/json-patch@v5.9.0...v5.9.11) --- updated-dependencies: - dependency-name: github.com/evanphx/json-patch/v5 dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * chore(deps): bump google.golang.org/grpc from 1.69.4 to 1.70.0 (#7047) Bumps [google.golang.org/grpc](https://github.com/grpc/grpc-go) from 1.69.4 to 1.70.0. - [Release notes](https://github.com/grpc/grpc-go/releases) - [Commits](grpc/grpc-go@v1.69.4...v1.70.0) --- updated-dependencies: - dependency-name: google.golang.org/grpc dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * chore(deps): bump sigs.k8s.io/controller-runtime from 0.20.0 to 0.20.1 (#7061) Bumps [sigs.k8s.io/controller-runtime](https://github.com/kubernetes-sigs/controller-runtime) from 0.20.0 to 0.20.1. - [Release notes](https://github.com/kubernetes-sigs/controller-runtime/releases) - [Changelog](https://github.com/kubernetes-sigs/controller-runtime/blob/main/RELEASE.md) - [Commits](kubernetes-sigs/controller-runtime@v0.20.0...v0.20.1) --- updated-dependencies: - dependency-name: sigs.k8s.io/controller-runtime dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * chore(deps): bump github.com/samber/lo from 1.47.0 to 1.49.1 (#7062) Bumps [github.com/samber/lo](https://github.com/samber/lo) from 1.47.0 to 1.49.1. - [Release notes](https://github.com/samber/lo/releases) - [Commits](samber/lo@v1.47.0...v1.49.1) --- updated-dependencies: - dependency-name: github.com/samber/lo dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * chore(deps): bump github.com/goccy/go-json from 0.10.4 to 0.10.5 (#7063) Bumps [github.com/goccy/go-json](https://github.com/goccy/go-json) from 0.10.4 to 0.10.5. - [Release notes](https://github.com/goccy/go-json/releases) - [Changelog](https://github.com/goccy/go-json/blob/master/CHANGELOG.md) - [Commits](goccy/go-json@v0.10.4...v0.10.5) --- updated-dependencies: - dependency-name: github.com/goccy/go-json dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * feat: deprecate `--gateway-discovery-dns-strategy` - make discovery always work (#7033) --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Jakub Warczarek <jakub.warczarek@konghq.com>

programmer04 added the area/maintenance Cleanup, refactoring, and other maintenance improvements that don't change functionality. label Jan 24, 2025

programmer04 added this to the KIC v3.5.x milestone Jan 24, 2025

programmer04 self-assigned this Jan 24, 2025

pull-request-size bot added the size/S label Jan 24, 2025

pull-request-size bot added size/XXL and removed size/S labels Jan 24, 2025

programmer04 force-pushed the resolve-to branch from dc42a2a to a961d6c Compare January 24, 2025 15:02

programmer04 changed the title ~~feat: deprecate --gateway-discovery-dns-strategy make resolution always work~~ feat: deprecate --gateway-discovery-dns-strategy - make resolution always work Jan 24, 2025

programmer04 added the ci/run-e2e Trigger e2e test run from PR label Jan 24, 2025

team-k8s-bot removed the ci/run-e2e Trigger e2e test run from PR label Jan 24, 2025

programmer04 mentioned this pull request Jan 27, 2025

API to write platform specific behaviour Kong/gateway-operator#283

Closed

2 tasks

Kong deleted a comment from team-k8s-bot Jan 27, 2025

programmer04 force-pushed the resolve-to branch from a961d6c to 4c88518 Compare January 27, 2025 13:16

programmer04 added the ci/run-e2e Trigger e2e test run from PR label Jan 27, 2025

team-k8s-bot removed the ci/run-e2e Trigger e2e test run from PR label Jan 27, 2025

programmer04 force-pushed the resolve-to branch from 4c88518 to e1ce566 Compare January 27, 2025 14:40

pull-request-size bot added size/XL and removed size/XXL labels Jan 27, 2025

programmer04 force-pushed the resolve-to branch 3 times, most recently from 385ef00 to 612ec54 Compare January 28, 2025 13:23

Kong deleted a comment from team-k8s-bot Jan 28, 2025

programmer04 force-pushed the resolve-to branch from 612ec54 to 38279e7 Compare January 28, 2025 13:33

programmer04 added the ci/run-e2e Trigger e2e test run from PR label Jan 28, 2025

team-k8s-bot removed the ci/run-e2e Trigger e2e test run from PR label Jan 28, 2025

programmer04 changed the title ~~feat: deprecate --gateway-discovery-dns-strategy - make resolution always work~~ feat: deprecate --gateway-discovery-dns-strategy - make discovery always work Jan 28, 2025

programmer04 marked this pull request as ready for review January 28, 2025 15:31

programmer04 requested a review from a team as a code owner January 28, 2025 15:31

programmer04 enabled auto-merge (squash) January 28, 2025 15:31

pmalek reviewed Jan 28, 2025

View reviewed changes

internal/adminapi/endpoints.go Outdated Show resolved Hide resolved

programmer04 force-pushed the resolve-to branch 2 times, most recently from e5286d0 to bbb18a6 Compare January 29, 2025 08:53

programmer04 requested a review from pmalek January 29, 2025 08:57

programmer04 force-pushed the resolve-to branch from bbb18a6 to 253b855 Compare January 29, 2025 09:12

czeslavo reviewed Jan 29, 2025

View reviewed changes

internal/adminapi/endpoints.go Outdated Show resolved Hide resolved

programmer04 force-pushed the resolve-to branch from 253b855 to 1a6f7cc Compare January 29, 2025 15:12

programmer04 requested a review from czeslavo January 29, 2025 15:17

programmer04 added 2 commits January 29, 2025 16:17

feat: deprecate --gateway-discovery-dns-strategy make resolution to…

0e5f333

… always work

remove option validation

46dcae3

programmer04 force-pushed the resolve-to branch from 1a6f7cc to 46dcae3 Compare January 29, 2025 15:17

pmalek previously approved these changes Jan 29, 2025

View reviewed changes

internal/manager/config.go Outdated Show resolved Hide resolved

internal/adminapi/kong.go Show resolved Hide resolved

programmer04 and others added 2 commits January 29, 2025 18:24

Merge branch 'main' into resolve-to

7beaf7c

Update internal/manager/config.go

1ceee05

Co-authored-by: Patryk Małek <patryk.malek@konghq.com>

programmer04 dismissed pmalek’s stale review via 1ceee05 January 29, 2025 18:02

programmer04 requested a review from pmalek January 29, 2025 18:15

This was referenced Jan 29, 2025

Robust validation of ClientOpts for Kong admin API client #7064

Open

Adjust certificate generation for ControlPlane communication with DataPlane Kong/gateway-operator#1109

Open

pmalek approved these changes Jan 29, 2025

View reviewed changes

programmer04 merged commit eb3059b into main Jan 29, 2025
43 checks passed

programmer04 deleted the resolve-to branch January 29, 2025 21:19

programmer04 mentioned this pull request Jan 29, 2025

GKE: Using pod dns names (service scoped) doesn't work on GKE thus preventing ControlPlane -> DP's Admin API traffic Kong/gateway-operator#179

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: deprecate `--gateway-discovery-dns-strategy` - make discovery always work #7033

feat: deprecate `--gateway-discovery-dns-strategy` - make discovery always work #7033

programmer04 commented Jan 24, 2025 •

edited

Loading

codecov bot commented Jan 24, 2025 •

edited

Loading

team-k8s-bot commented Jan 28, 2025

czeslavo left a comment

feat: deprecate --gateway-discovery-dns-strategy - make discovery always work #7033

feat: deprecate --gateway-discovery-dns-strategy - make discovery always work #7033

Conversation

programmer04 commented Jan 24, 2025 • edited Loading

codecov bot commented Jan 24, 2025 • edited Loading

Codecov Report

team-k8s-bot commented Jan 28, 2025

czeslavo left a comment

Choose a reason for hiding this comment

feat: deprecate `--gateway-discovery-dns-strategy` - make discovery always work #7033

feat: deprecate `--gateway-discovery-dns-strategy` - make discovery always work #7033

programmer04 commented Jan 24, 2025 •

edited

Loading

codecov bot commented Jan 24, 2025 •

edited

Loading