Skip to content

[breaking] deprecate dnsZone and edgeDnsZone chart values #1876

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

abaguas
Copy link
Collaborator

@abaguas abaguas commented Apr 2, 2025

PR #1845 introduced the possibility to configure multiple DNS zones. The intention was to be backwards compatible. However it forces uses to change the following helm values, as explained in #1858:

  • k8gb.dnsZoneNegTTL -> k8gb.dnsZones[0].dnsZoneNegTTL
  • k8gb.edgeDnsZone -> k8gb.dnsZones[0].parentZone
  • k8gb.dnsZone -> k8gb.dnsZones[0].zone

The naming of zones was also reviewed, since edgeZone was not very clear.

During the community meeting of 02.04.2025 it was agreed to maintain the breaking change and clean up the deprecated values configuration.

Upgrade testing obviously fails since this is a breaking change. The old configuration is no longer valid

Fixes #1858

PR k8gb-io#1845 introduced the possibility to configure multiple DNS zones. The intention was to be backwards compatible. However it forces uses to change the following helm values, as explained in k8gb-io#1858:
* k8gb.dnsZoneNegTTL -> k8gb.dnsZones[0].dnsZoneNegTTL
* k8gb.edgeDnsZone -> k8gb.dnsZones[0].zone
* k8gb.dnsZone -> k8gb.dnsZones[0].domain

During the community meeting of 02.04.2025 it was agreed to maintain the breaking change and clean up the deprecated values configuration.

Fixes k8gb-io#1858

Signed-off-by: Andre Aguas <[email protected]>
Copy link

netlify bot commented Apr 2, 2025

Deploy Preview for k8gb-preview ready!

Name Link
🔨 Latest commit c9d7fc3
🔍 Latest deploy log https://app.netlify.com/sites/k8gb-preview/deploys/67f43766fc4683000839dd15
😎 Deploy Preview https://deploy-preview-1876--k8gb-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@abaguas
Copy link
Collaborator Author

abaguas commented Apr 2, 2025

@kuritka can we rediscuss the new naming of the options?

  • edgeDnsZone -> zone (example.com)
  • dnsZone -> domain (cloud.example.com)

What is for you the different between zone and domain?
If I consider domain as an fqdn then "cloud.example.com" is not an fqdn. The fqdn will be "app.cloud.example.com".
If I consider domain as a portion of an fqdn then it is the same as zone.

Can you explain your reasoning for the change? What was confusing with the previous naming?

@kuritka
Copy link
Collaborator

kuritka commented Apr 2, 2025

Hey, totally valid question – both naming schemes actually make sense.

I renamed edgeDnsZone -> zone and dnsZone -> domain mainly to make the hierarchy clearer and more intuitive for users configuring it:

zone is the top-level (e.g. example.com)

domain is a sub-part of it (e.g. cloud.example.com)

You're right that technically both are zones, and using edgeDnsZone / dnsZone is more DNS-accurate.
But the old naming was a bit hard to read without knowing the internal distinction between "edge" and "non-edge".

Happy to revisit if we find better names that keep both clarity and accuracy – e.g. rootZone / subZone could be a compromise. Why do you feel such a need to change it?

@abaguas
Copy link
Collaborator Author

abaguas commented Apr 3, 2025

I agree edge zone is not very clear.

Why do you feel such a need to change it?

I feel calling domain to one of the zones will also lead to confusion. So, since we changed it we can get it 100% accurate before the upcoming release.

Root zone is the zone controlled by the root servers. But I like the idea of hierarchy it brings. What do you think about "zone"/"k8gbZone"/"delegatedZone" and "parentZone"?

@kuritka
Copy link
Collaborator

kuritka commented Apr 7, 2025

Root zone is the zone controlled by the root servers. But I like the idea of hierarchy it brings. What do you think about "zone"/"k8gbZone"/"delegatedZone" and "parentZone"?

apart k8gbZone (which, anyone can interpret differently) im fine with all of them. thx! 👍

abaguas added a commit to abaguas/k8gb that referenced this pull request Apr 7, 2025
Based on the discussion started in: k8gb-io#1876 (comment)

Signed-off-by: Andre Aguas <[email protected]>
abaguas added a commit to abaguas/k8gb that referenced this pull request Apr 7, 2025
Based on the discussion started in: k8gb-io#1876 (comment)

Signed-off-by: Andre Aguas <[email protected]>
@abaguas abaguas force-pushed the dnszones/breakingchange branch from 90d58d5 to c8dc2a7 Compare April 7, 2025 16:28
Based on the discussion started in: k8gb-io#1876 (comment)

Signed-off-by: Andre Aguas <[email protected]>
@abaguas abaguas force-pushed the dnszones/breakingchange branch from c8dc2a7 to c9d7fc3 Compare April 7, 2025 20:36
@abaguas abaguas marked this pull request as ready for review April 7, 2025 22:28
Copy link
Member

@ytsarev ytsarev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall LGTM. Added couple of comments
We will have to work on next release notes explicitly mentioning that change

- zone: "example.com" # -- main zone which would contain gslb zone to delegate (same meaning as to edgeDNSZone)
domain: "cloud.example.com" # -- domain controlled by gslb (same meaning as to dnsZone)
- parentZone: "example.com" # -- parent zone which would contain gslb zone to delegate (same meaning as to edgeDNSZone)
zone: "cloud.example.com" # -- zone controlled by gslb (same meaning as to dnsZone)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe loadBalancedZone to be explicit?

"required": [
"clusterGeoTag",
"extGslbClustersGeoTags",
"edgeDNSServers",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need to change this terminology too to be consistent

Copy link
Collaborator

@kuritka kuritka left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thx @abaguas

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.

dnsZones block unintentionally introduced a breaking change
3 participants