Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: Add godaddy pagination size flag #4336

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix: Add godaddy pagination size flag #4336

wants to merge 1 commit into from

Conversation

Enelar
Copy link

@Enelar Enelar commented Mar 25, 2024 •
edited

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
Copy link
Contributor

[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:

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 Linux Foundation: EasyCLA
Copy link

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

CLA Signed

The committers listed above are authorized under a signed CLA.

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

@k8s-ci-robot
Copy link
Contributor

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 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
Copy link
Contributor

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.

@k8s-ci-robot 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 Enelar changed the title Avoid godaddy api pagination fix: Avoid godaddy api pagination Mar 27, 2024
@Enelar
Copy link
Author

Enelar commented Mar 27, 2024

@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
Copy link

hzux commented Mar 29, 2024

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
Copy link
Contributor

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

@k8s-ci-robot 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 Enelar changed the title fix: Avoid godaddy api pagination fix: Add godaddy pagination size flag Apr 6, 2024
@Enelar
Copy link
Author

Enelar commented Apr 6, 2024

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

@mloiseleur
Copy link
Contributor

mloiseleur commented Apr 8, 2024 •
edited

  1. 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 {
  1. Same parameters for others providers are named like:
  • AWSBatchChangeSize
  • RFC2136BatchChangeSize
  • DigitalOceanAPIPageSize
  • GoogleBatchChangeSize

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

  1. 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
szuecs reviewed Apr 8, 2024
View reviewed changes
pkg/apis/externaldns/types.go
@@ -111,6 +111,7 @@ type Config struct {
BluecatSkipTLSVerify bool
CloudflareProxied bool
CloudflareDNSRecordsPerPage int
GoDaddyDNSRecordsPerPage int
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

^

szuecs
szuecs reviewed Apr 8, 2024
View reviewed changes
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)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@szuecs szuecs szuecs left review comments

@johngmyers johngmyers Awaiting requested review from johngmyers

@mloiseleur mloiseleur Awaiting requested review from mloiseleur

Assignees
No one assigned
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@Enelar @k8s-ci-robot @hzux @mloiseleur @szuecs