Create SafeDNS provider #2359

rjhenry · 2021-10-08T12:34:53Z

Description
Create a provider for UKFast's SafeDNS.

Checklist

Unit tests updated
End user documentation updated

k8s-ci-robot · 2021-10-08T12:34:59Z

Thanks for your pull request. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please follow instructions at https://git.k8s.io/community/CLA.md#the-contributor-license-agreement to sign the CLA.

It may take a couple minutes for the CLA signature to be fully registered; after that, please reply here with a new comment and we'll verify. Thanks.

If you've already signed a CLA, it's possible we don't have your GitHub username or you're using a different email address. Check your existing CLA data and verify that your email is set on your git commits.
If you signed the CLA as a corporation, please sign in with your organization's credentials at https://identity.linuxfoundation.org/projects/cncf to be authorized.
If you have done the above and are still having issues with the CLA being reported as unsigned, please log a ticket with the Linux Foundation Helpdesk: https://support.linuxfoundation.org/
Should you encounter any issues with the Linux Foundation Helpdesk, send a message to the backup e-mail support address at: login-issues@jira.linuxfoundation.org

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. I understand the commands that are listed here.

k8s-ci-robot · 2021-10-08T12:35:01Z

Welcome @rjhenry!

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 · 2021-10-08T13:39:43Z

@rjhenry: What did the ocean say to the beach? Thanks for all the sediment.

In response to this:

/joke
/lint
/check-cla

(Multiple commands to visually get a response)

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.

rjhenry · 2021-10-08T13:40:40Z

/check-cla
/joke

k8s-ci-robot · 2021-10-08T13:40:41Z

@rjhenry: What did one snowman say to the other snow man? Do you smell carrot?

In response to this:

/check-cla
/joke

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.

rjhenry · 2021-10-08T13:42:19Z

/check-cla

rjhenry · 2021-10-08T13:44:22Z

/assign raffo

rjhenry · 2021-10-08T13:47:02Z

/assign reviewers

k8s-ci-robot · 2021-10-08T13:47:04Z

@rjhenry: GitHub didn't allow me to assign the following users: reviewers.

Note that only kubernetes-sigs members, repo collaborators and people who have commented on this issue/PR can be assigned. Additionally, issues/PRs can only have 10 assignees at the same time.
For more information please see the contributor guide

In response to this:

/assign reviewers

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.

rjhenry · 2021-10-08T13:47:32Z

/assign njuettner raffo seanmalloy

rjhenry · 2021-10-08T13:48:26Z

Apologies for the mess of comments on the PR - getting used to the format! Should be in the correct state for Phase 1 - human review.

rjhenry · 2021-10-08T13:51:42Z

docs/tutorials/UKFast_SafeDNS.md

+
+This tutorial describes how to setup ExternalDNS for usage within a Kubernetes cluster using SafeDNS
+
+Make sure to use **>=FIXME** version of ExternalDNS for this tutorial.


I'll fix this once I've got a a point of "this PR is reviewed to a technical level", so it can be relatively confident as to which version should be referred to.

The same goes for the two container image tags in examples below.

@rjhenry can ypu replace the fixme with 0.11.0? It will be unreleased when we merge this, but it is the next tag for release. Once you change that we're good to merge this one.

rjhenry · 2021-11-03T10:37:09Z

@Raffo @seanmalloy @njuettner Is there any idea on when this PR may be able to be looked at? I'm keen to get this in place so I can switch back to the upstream images for ExternalDNS.

Raffo · 2021-11-03T11:21:33Z

@rjhenry we're incredibly resource constrained this month, so that might take a bit unfortunately.

rjhenry · 2021-12-07T14:21:43Z

@Raffo @seanmalloy @njuettner Now that another month has passed, is there any more likelyhood of being able to review this PR, or are you still incredibly resource-constrained?

rjhenry · 2021-12-07T15:26:19Z

(Note: Rebased from v0.10.0 to v0.10.1, and improved lint quality)

Raffo · 2021-12-17T13:26:50Z

@rjhenry yes, we’ll take a look in a bit.

Raffo

@rjhenry I added a few comments, changes look good overall. I’d be happy to approve this PR once the comments are addressed. Can you please also make sure to add yourself as a maintainer of this code in the README section? We ask for people contributing new provider to provide as well some level of support for the code they will commit.

docs/tutorials/UKFast_SafeDNS.md

provider/safedns/safedns.go

Raffo · 2021-12-17T13:52:20Z

provider/safedns/safedns.go

+		// TODO: Find a more effient way of doing this.
+		// Currently iterates over each zoneRecord in ZoneRecords for each Endpoint in UpdateNew; the same will go for
+		// Delete. As it's double-iteration, that's O(n^2), which isn't great.


Should we be concerned about this? Is it something we are okay to merge like it is and then reconsider in the future?

Personally, I haven't noticed any issues running this code in production for an account with many hundred of zones, each with many hundreds of records. On that basis alone, I'd say that it's okay to merge now and reconsider in future.

Ok sounds good. I would prefer if we leave the TODO then if we do not need any change for now, so that we can search TODOs for real things that are left to do in the codebase.

Raffo · 2021-12-17T13:52:37Z

provider/safedns/safedns.go

+		}
+	}
+	for _, endpoint := range changes.Delete {
+		// TODO: Find a more effient way of doing this.


Same as above.

Replied above.

rjhenry · 2021-12-17T14:24:56Z

Can you please also make sure to add yourself as a maintainer of this code in the README section?

I have added my organisation as a maintainer, and not myself as an individual. The organisation has a use for this, but myself as an individual does not, so it makes more sense - in my mind - for the organisation to be deemed the maintainer of this plugin.
If you'd prefer an individual, I can change this for now, though note that I'd likely avoid being a maintainer of code I don't use if I were to leave @assureddt.

Raffo

@rjhenry if you drop the TODOs, I’m ok to approve this PR.

rjhenry · 2021-12-20T18:51:18Z

I've dropped the TODOs, but kept the comment about the complexity; it's likely to be a good place to look if any performance issues are reported. I've also rebased to be based on v0.10.2 rather than v0.10.1.

Many thanks for working with me on this @Raffo!

Raffo · 2022-01-05T08:55:06Z

@rjhenry I have a comment to solve in https://github.com/kubernetes-sigs/external-dns/pull/2359/files#r778642557 then we can merge this PR.

EDIT: there is an issue with the linter, please fix that as well (see CI).

Keeping the comments in some degree is valuable, as it clarifies the time complexity of the operations done; in the event of a performance issue, this would likely be somewhere to look. However, remove the `TODO` string directly, as it is not an urgent look-at-me-now.

rjhenry · 2022-01-05T09:23:27Z

@Raffo I've removed the FIXME (and it's corresponding one in the image name, in the documentation) and fixed the lint issue; is there anything else you need from me here?

Raffo

/lgtm

k8s-ci-robot · 2022-01-05T20:13:36Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Raffo, rjhenry

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:

~~OWNERS~~ [Raffo]

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

k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Oct 8, 2021

k8s-ci-robot requested review from Raffo and seanmalloy October 8, 2021 12:35

k8s-ci-robot added the size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. label Oct 8, 2021

k8s-ci-robot added 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 Oct 8, 2021

k8s-ci-robot assigned Raffo Oct 8, 2021

k8s-ci-robot assigned njuettner and seanmalloy Oct 8, 2021

rjhenry commented Oct 8, 2021

View reviewed changes

Raffo reviewed Dec 17, 2021

View reviewed changes

Raffo closed this Dec 20, 2021

Raffo reopened this Dec 20, 2021

Raffo reviewed Dec 20, 2021

View reviewed changes

Rick Henry and others added 8 commits January 5, 2022 09:22

Create package for SafeDNS

d3ef1cd

First-pass implementation of SafeDNS provider

a106313

Support editing records

7cac705

Comment on types explaining what they do

7addd03

Document SafeDNS provider

733f6a8

Implement tests for SafeDNS provider

023eb23

Reformat code to meet lint standards

6fc68a8

Raffo approved these changes Jan 5, 2022

View reviewed changes

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jan 5, 2022

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jan 5, 2022

k8s-ci-robot merged commit c8ef365 into kubernetes-sigs:master Jan 5, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Create SafeDNS provider #2359

Create SafeDNS provider #2359

rjhenry commented Oct 8, 2021

k8s-ci-robot commented Oct 8, 2021

k8s-ci-robot commented Oct 8, 2021

k8s-ci-robot commented Oct 8, 2021

rjhenry commented Oct 8, 2021

k8s-ci-robot commented Oct 8, 2021

rjhenry commented Oct 8, 2021

rjhenry commented Oct 8, 2021

rjhenry commented Oct 8, 2021

k8s-ci-robot commented Oct 8, 2021

rjhenry commented Oct 8, 2021

rjhenry commented Oct 8, 2021

rjhenry Oct 8, 2021

Raffo Jan 5, 2022

rjhenry commented Nov 3, 2021

Raffo commented Nov 3, 2021

rjhenry commented Dec 7, 2021

rjhenry commented Dec 7, 2021

Raffo commented Dec 17, 2021

Raffo left a comment

Raffo Dec 17, 2021

rjhenry Dec 17, 2021

Raffo Dec 20, 2021

Raffo Dec 17, 2021

rjhenry Dec 17, 2021

rjhenry commented Dec 17, 2021

Raffo left a comment

rjhenry commented Dec 20, 2021

Raffo commented Jan 5, 2022 •

edited

rjhenry commented Jan 5, 2022

Raffo left a comment

k8s-ci-robot commented Jan 5, 2022


		This tutorial describes how to setup ExternalDNS for usage within a Kubernetes cluster using SafeDNS

		Make sure to use >=FIXME version of ExternalDNS for this tutorial.

Create SafeDNS provider #2359

Create SafeDNS provider #2359

Conversation

rjhenry commented Oct 8, 2021

k8s-ci-robot commented Oct 8, 2021

k8s-ci-robot commented Oct 8, 2021

k8s-ci-robot commented Oct 8, 2021

rjhenry commented Oct 8, 2021

k8s-ci-robot commented Oct 8, 2021

rjhenry commented Oct 8, 2021

rjhenry commented Oct 8, 2021

rjhenry commented Oct 8, 2021

k8s-ci-robot commented Oct 8, 2021

rjhenry commented Oct 8, 2021

rjhenry commented Oct 8, 2021

rjhenry Oct 8, 2021

Choose a reason for hiding this comment

Raffo Jan 5, 2022

Choose a reason for hiding this comment

rjhenry commented Nov 3, 2021

Raffo commented Nov 3, 2021

rjhenry commented Dec 7, 2021

rjhenry commented Dec 7, 2021

Raffo commented Dec 17, 2021

Raffo left a comment

Choose a reason for hiding this comment

Raffo Dec 17, 2021

Choose a reason for hiding this comment

rjhenry Dec 17, 2021

Choose a reason for hiding this comment

Raffo Dec 20, 2021

Choose a reason for hiding this comment

Raffo Dec 17, 2021

Choose a reason for hiding this comment

rjhenry Dec 17, 2021

Choose a reason for hiding this comment

rjhenry commented Dec 17, 2021

Raffo left a comment

Choose a reason for hiding this comment

rjhenry commented Dec 20, 2021

Raffo commented Jan 5, 2022 • edited

rjhenry commented Jan 5, 2022

Raffo left a comment

Choose a reason for hiding this comment

k8s-ci-robot commented Jan 5, 2022

Raffo commented Jan 5, 2022 •

edited