fix: Add godaddy pagination size flag #4336

Enelar · 2024-03-25T20:01:59Z

Description

External dns doesn't respect godaddy pagination, making some domain zones undetected. This problem affects all accounts with more than 100 domains (default page size). This simple fix sets page size to max allowed value, which is practically disables pagination for everyone.

Checklist

Unit tests updated
End user documentation updated

k8s-ci-robot · 2024-03-25T20:02:03Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign raffo for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

linux-foundation-easycla · 2024-03-25T20:02:05Z

The committers listed above are authorized under a signed CLA.

✅ login: Enelar / name: Kirill Berezin (e9684eb)

k8s-ci-robot · 2024-03-25T20:02:07Z

Welcome @Enelar!

It looks like this is your first PR to kubernetes-sigs/external-dns 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/external-dns has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

k8s-ci-robot · 2024-03-25T20:02:08Z

Hi @Enelar. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

Enelar · 2024-03-27T13:44:08Z

@mloiseleur Could you please help me prepare this PR for merge? I've looked at the guide but I'm not sure if I've missed anything.

hzux · 2024-03-29T15:20:53Z

I think it would be better to create a int flag like "--godaddy-api-limit" as the value of the domainsURL's parameter "limit", otherwise it will still undetected with more than 1000 domains.

mloiseleur · 2024-04-05T08:17:41Z

@Enelar Comment @hzux is a good first step.
Please also be aware that we have started the discussion to move providers out of tree.

Enelar · 2024-04-06T22:43:39Z

@hzux @mloiseleur thanks for your replies. I've prepared the change.
I will watch closely on the discussion mentioned.

mloiseleur · 2024-04-08T11:16:47Z

Since it's only needed for records, instead of modifying the wrapper, wdyt about using this parameter in godaddy.go:229 ?

	if err := p.client.Get(fmt.Sprintf("/v1/domains/%s/records", zone), &recordsIds); err != nil {

Same parameters for others providers are named like:

AWSBatchChangeSize
RFC2136BatchChangeSize
DigitalOceanAPIPageSize
GoogleBatchChangeSize

So, wdyt about renaming the parameters with a name like GoDaddyAPIPageSize ?

It's lacking some tests on goddady provider. It looks like it may build URLs like: /v1/domains/example.net/records&limit=100, and I'm unsure if it works. Usually, parameters in query needs to starts with ?.

szuecs · 2024-04-08T14:32:47Z

pkg/apis/externaldns/types.go

@@ -111,6 +111,7 @@ type Config struct {
 	BluecatSkipTLSVerify               bool
 	CloudflareProxied                  bool
 	CloudflareDNSRecordsPerPage        int
+	GoDaddyDNSRecordsPerPage		   int


szuecs · 2024-04-08T14:33:58Z

provider/godaddy/client.go

@@ -140,7 +144,8 @@ func NewClient(useOTE bool, apiKey, apiSecret string) (*Client, error) {

 // Get is a wrapper for the GET method
 func (c *Client) Get(url string, resType interface{}) error {
-	return c.CallAPI("GET", url, nil, resType, true)
+	urlWithLimit := fmt.Sprintf("%s&limit=%d", url, c.DNSRecordsPerPage)


Please use url.Parse from go stdlib to prepare the URL and manipulate the query

k8s-triage-robot · 2024-07-07T15:16:43Z

The Kubernetes project currently lacks enough contributors to adequately respond to all PRs.

This bot triages PRs according to the following rules:

After 90d of inactivity, lifecycle/stale is applied
After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

Mark this PR as fresh with /remove-lifecycle stale
Close this PR with /close
Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

k8s-triage-robot · 2024-08-06T15:38:44Z

The Kubernetes project currently lacks enough active contributors to adequately respond to all PRs.

This bot triages PRs according to the following rules:

After 90d of inactivity, lifecycle/stale is applied
After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

Mark this PR as fresh with /remove-lifecycle rotten
Close this PR with /close
Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle rotten

k8s-triage-robot · 2024-09-05T16:03:31Z

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages PRs according to the following rules:

After 90d of inactivity, lifecycle/stale is applied
After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

Reopen this PR with /reopen
Mark this PR as fresh with /remove-lifecycle rotten
Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/close

k8s-ci-robot · 2024-09-05T16:03:37Z

@k8s-triage-robot: Closed this PR.

In response to this:

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages PRs according to the following rules:

After 90d of inactivity, lifecycle/stale is applied

After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied

After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

Reopen this PR with /reopen

Mark this PR as fresh with /remove-lifecycle rotten

Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/close

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

k8s-ci-robot requested review from johngmyers and mloiseleur March 25, 2024 20:02

k8s-ci-robot added cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Mar 25, 2024

k8s-ci-robot added size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Mar 25, 2024

Enelar changed the title ~~Avoid godaddy api pagination~~ fix: Avoid godaddy api pagination Mar 27, 2024

feat: Add GoDaddy fetch limit to zone request

e9684eb

Enelar force-pushed the avoid-godaddy-pagination branch from 24d679b to e9684eb Compare April 6, 2024 22:41

k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Apr 6, 2024

Enelar changed the title ~~fix: Avoid godaddy api pagination~~ fix: Add godaddy pagination size flag Apr 6, 2024

szuecs reviewed Apr 8, 2024

View reviewed changes

k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jul 7, 2024

k8s-ci-robot added lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Aug 6, 2024

k8s-ci-robot closed this Sep 5, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: Add godaddy pagination size flag #4336

fix: Add godaddy pagination size flag #4336

Enelar commented Mar 25, 2024 •

edited

Loading

k8s-ci-robot commented Mar 25, 2024

linux-foundation-easycla bot commented Mar 25, 2024 •

edited

Loading

k8s-ci-robot commented Mar 25, 2024

k8s-ci-robot commented Mar 25, 2024

Enelar commented Mar 27, 2024

hzux commented Mar 29, 2024

mloiseleur commented Apr 5, 2024

Enelar commented Apr 6, 2024

mloiseleur commented Apr 8, 2024 •

edited

Loading

szuecs Apr 8, 2024

szuecs Apr 8, 2024

k8s-triage-robot commented Jul 7, 2024

k8s-triage-robot commented Aug 6, 2024

k8s-triage-robot commented Sep 5, 2024

k8s-ci-robot commented Sep 5, 2024

fix: Add godaddy pagination size flag #4336

fix: Add godaddy pagination size flag #4336

Conversation

Enelar commented Mar 25, 2024 • edited Loading

k8s-ci-robot commented Mar 25, 2024

linux-foundation-easycla bot commented Mar 25, 2024 • edited Loading

k8s-ci-robot commented Mar 25, 2024

k8s-ci-robot commented Mar 25, 2024

Enelar commented Mar 27, 2024

hzux commented Mar 29, 2024

mloiseleur commented Apr 5, 2024

Enelar commented Apr 6, 2024

mloiseleur commented Apr 8, 2024 • edited Loading

szuecs Apr 8, 2024

Choose a reason for hiding this comment

szuecs Apr 8, 2024

Choose a reason for hiding this comment

k8s-triage-robot commented Jul 7, 2024

k8s-triage-robot commented Aug 6, 2024

k8s-triage-robot commented Sep 5, 2024

k8s-ci-robot commented Sep 5, 2024

Enelar commented Mar 25, 2024 •

edited

Loading

linux-foundation-easycla bot commented Mar 25, 2024 •

edited

Loading

mloiseleur commented Apr 8, 2024 •

edited

Loading