cloudflare - customizable pagination when listing DNS records #3364
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
k8s-ci-robot
added
the
do-not-merge/work-in-progress
k8s-ci-robot
added
cncf-cla: yes
k8s-ci-robot
removed
the
do-not-merge/work-in-progress
arturhoo
force-pushed
the
cloudflare-paginated-list-requests
branch
from
588c66f
to
f1a966d
Compare
added 4 commits
February 17, 2023 13:21
Signed-off-by: Artur Rodrigues <artur.rodrigues@lacework.net>
Signed-off-by: Artur Rodrigues <artur.rodrigues@lacework.net>
Signed-off-by: Artur Rodrigues <artur.rodrigues@lacework.net>
Signed-off-by: Artur Rodrigues <artur.rodrigues@lacework.net>
arturhoo
force-pushed
the
cloudflare-paginated-list-requests
branch
from
f1a966d
to
d8bf246
Compare
szuecs
requested changes
Mar 2, 2023
|
/ok-to-test |
k8s-ci-robot
added
the
ok-to-test
|
/approve |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: arturhoo, szuecs The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
k8s-ci-robot
added
the
approved
|
/lgtm |
k8s-ci-robot
added
the
lgtm
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
When listing DNS records in a given zone, by default, the
cloudflare-golibrary fetches the results from Cloudflare's APIs in batches of size 50 - traversing the pages is done automatically when callingcloudflare.ListDNSRecordsParamswith no pagination options.However, users that have a large number of records in a zone, and with several deployments of
external-dnsfetching the records for the same zone, risk reaching Cloudflare's API limits.Since version 0.58.0, the
cloudflare-golibrary has aPerPageattribute oncloudflare.ListDNSRecordsParamswhich can help reduce the number of API calls made to Cloudflare and prevent rate limit events: https://api.cloudflare.com/#dns-records-for-a-zone-list-dns-recordsThis allows
external-dnsto fetch records in batch sizes of up to 5,000 (from the default 100), potentially reducing the number of API requests by a factor of 50.In this PR, we allow users to tune the
PerPageparameter. Since auto-pagination is not available when a customPerPagevalue is passed tocloudflare.ListDNSRecordsParams(and the library is unlikely to do so in the future), we perform it ourselves.An old, unused config option around pagination of zones,
CloudflareZonesPerPage, is also removed - I believe it was supposed to be removed on #2298.Checklist