Rename poorly-named DNS variables

[dseeley-sky]

The naming of the variables that describe the DNS zone to which we're adding records (dns_tld_external), the name of the domain part of the FQDN (cluster_vars.dns_zone_external), and the name of the domain part of the cloud-internal FQDN (cluster_vars.dns_zone_internal) is very poor, and leads to misunderstandings.

dns_tld_external  --> cluster_vars.dns_nameserver_zone
dns_zone_internal --> cluster_vars.dns_cloud_internal_domain
dns_zone_external --> cluster_vars.dns_fqdn_domain

[dseeley-sky]

Alternative suggestions welcome...

[sky-amoncadot]

LGTM

[leslieonline27]

Not entirely sure I like the way the internal and external diverge naming wise, and they are not technically fqdns? (There is no hostname). Could I suggest the below:

dns_tld_external  --> cluster_vars.dns_nameserver_zone
dns_zone_internal --> cluster_vars.dns_internal_domain_name
dns_zone_external --> cluster_vars.dns_external_domain_name

I think the dns_tld_external rename makes perfect sense (tld might not be entirely clear to some and it's technically incorrect as a description, considering how we've been using it)

[sky-amoncadot]

Not entirely sure I like the way the internal and external diverge naming wise

dns_tld_external  --> cluster_vars.dns_nameserver_zone
dns_zone_internal --> cluster_vars.dns_internal_domain_name
dns_zone_external --> cluster_vars.dns_external_domain_name

Agree with your comment on diverging, however cluster_vars.dns_external_domain_name has external within the naming convention, which suggests to me this should only be used for external dns zones? Currently this variable is used for both internal & external user-defined zones.

they are not technically fqdns? (There is no hostname).

True! In addition to my above suggestion, perhaps cluster_vars.dns_user_domain_name?

dns_tld_external  --> cluster_vars.dns_nameserver_zone
dns_zone_internal --> cluster_vars.dns_internal_domain_name # Default GCP or AWS internal zone 
dns_zone_external --> cluster_vars.dns_user_domain_name # user defined domain and used for internal/external zones

This way there is no divergence across vars and the naming convention for dns vars will always be dns_*.

[leslieonline27]

Currently this variable is used for both internal & external user-defined zones.

Of course, missed that - yep suggestion looks good to me, and I think user is actually a pretty good descriptor

[dseeley-sky]

If dns_user_domain_name (which I agree is a good name) is for both internal and external, the dns_internal_domain_name might be a bit confusing?

I can live without the _name suffix for brevity, but not that fussed either way (if people prefer it)? How about:

dns_tld_external  --> cluster_vars.dns_nameserver_zone
dns_zone_internal --> cluster_vars.dns_cloud_internal_domain
dns_zone_external --> cluster_vars.dns_user_domain

[leslieonline27]

If dns_user_domain_name (which I agree is a good name) is for both internal and external, the dns_internal_domain_name might be a bit confusing?

I can live without the _name suffix for brevity, but not that fussed either way (if people prefer it)? How about:

dns_tld_external  --> cluster_vars.dns_nameserver_zone
dns_zone_internal --> cluster_vars.dns_cloud_internal_domain
dns_zone_external --> cluster_vars.dns_user_domain

This LGTM - I'm also ok with _name being dropped for brevity