resource azurerm_dns_zone: Add option to re-use host_name with dns_zone with soa_record creation
#22312
Conversation
fredericfran-gds
changed the title
dns_zone with soa_record creationdns_zone with soa_record creation
github-actions
bot
added
waiting-response
documentation
size/S
and removed
waiting-response
size/XS
labels
This comment was marked as off-topic.
This comment was marked as off-topic.
When a DNS zone is created in Azure, there is a default SOA record which is created. In this provider, a dns_zone with soa_record is done by: 1. creating the dns_zone 2. overwriting the soa_record of the zone with the data supplied in the soa_record config block The `soa_record` block makes it mandatory to add the host_name argument when it is specified. This is NOT desired in most cases since the host_name is the MNAME SOA field which is the name of the primary nameserver and is set by Azure. This commit attempts to fix this issue by: 1. allowing the `host_name` to be omitted when `soa_record` is specified 2. the host_name value will be derived from the original SOA record when the zone is created. This issue is partly a bug in Azure API since it is is mentioned in the [documentation](https://learn.microsoft.com/en-us/azure/dns/dns-zones-records#soa-records) that it should not be possible to update the 'host' property of the SOA record.
1. get soaRecord only rather than whole zone read 2. return Set(id) to original position 3. update documentation 4. update tests
jackofallops
force-pushed
the
fredericfran-gds/re-use_nameserver-soa
branch
from
6f89fe6
to
dcc654d
Compare
There was a problem hiding this comment.
Hi @fredericfran-gds
I hope you don't mind, but while reviewing I noticed a few other things that needed some work / changes so I've made those and I'm running the tests now. As soon as that's done I'll get another member of the team to quickly check my changes too and we should be able to get this in.
Thanks!
Hi, no problem at all. Thanks for fixing, we wanted to be conservative and still allow someone to modify the host/host_name because strangely the API allows that when the documentation says no. Could be an issue with Azure API. |
I've taken the approach of maintaining the value if specified for now, but we'll deprecate and remove the ability to set it in the next major version, since it would be a breaking change from a user configuration point of view. The tests are all passing, so someone else on the team should be able to quickly re-review and this will hopefully ship in the next release. 
|
When a DNS zone is created in Azure, there is a default SOA record which is created.
In this provider, a dns_zone with soa_record is done by:
The
soa_recordblock makes it mandatory to add the host_name argument when it is specified. This is NOT desired in most cases since the host_name is the MNAME SOA field which is the name of the primary nameserver and is set by Azure.This commit attempts to fix this issue by:
host_nameto be omitted whensoa_recordis specifiedThis issue is partly a bug in Azure API since it is is mentioned in the documentation that it should not be possible to update the 'host' property of the SOA record.