cloudflare_dns: Update SRV record handling for Cloudflare API changes

[saltydk]

SUMMARY

Brings SRV API up to date with the changes from here: https://developers.cloudflare.com/fundamentals/api/reference/deprecations/#2024-05-31

Fixes #8679

ISSUE TYPE

• Bugfix Pull Request

COMPONENT NAME

cloudflare_dns

ADDITIONAL INFORMATION

- name: Create an SRV record _foo._tcp.example.net
  community.general.cloudflare_dns:
    domain: example.net
    service: foo
    proto: tcp
    port: 3500
    priority: 10
    weight: 20
    type: SRV
    value: fooserver.example.net

[ansibullbot]

cc @mgruener
click here for bot help

[felixfontein]

Thanks for your contribution! I've added some first comments below.

[saltydk]

Done, although the lines I edited didn't contain that ending comma.

[russoz]

Hi @saltydk , thanks for the contribution! :-)

I am not familiar with Cloudflare's policies/procedures regarding APIs, so I saw the link to the deprecation notice in their website but it is not clear to me whether the deprecated API remains available for longer (if so then how long for) and, most importantly, whether the users have any choice in accessing one or the other version of the API.

I am trying to ensure that we're not going to have users hitting the old version of the API (while it lasts) and getting errors because the payload is formatted differently now. Conversely, if there is no versioning of the API endpoints and that payload structure change is already in place (it appears to be the case from the deprecation date in May), then the next question is: do those endpoints accept the payload in any of the two structures? Because if they only accept the new structure, then we have to merge this yesterday.

Just trying to make sure we're covering all the angles here. Thanks once again

[saltydk]

The deprecation date was May 31, 2024, this change has been live before my original issue, I have a custom Ansible module in my own project with this fix and have been using it for months now. The version of the API Ansible hits is the v4 which has this change live.

community.general/plugins/modules/cloudflare_dns.py

Line 403 in 2d660a1

cf_api_endpoint = 'https://api.cloudflare.com/client/v4'

[felixfontein]

That sounds like Cloudflare means "removal date" when saying "deprecation date". Deprecation usually means that you shouldn't use it anymore, but you still can. Here it seems you cannot use it anymore.

[saltydk]

That does appear to be what the initial description says:

Cloudflare occasionally makes updates to our APIs that result in behavior changes or deprecations. When this happens, we will communicate when the API will no longer be available and whether there will be a replacement.

[felixfontein]

Sounds good to me. If nobody objects, I'll merge this next week.

[russoz]

lgtm

[patchback]

Backport to stable-8: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-8/1bdf8fc02545acd73faf988088ea0f187f3f909f/pr-8948

Backported as #9000

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

[felixfontein]

@saltydk thanks for your contribution!
@russoz thanks for reviewing!

[patchback]

Backport to stable-9: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-9/1bdf8fc02545acd73faf988088ea0f187f3f909f/pr-8948

Backported as #9001

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.