initial-design file #4

ideahitme · 2017-02-13T15:07:01Z

*** DO NOT MERGE ***
This is to start design documentation. The following contains the basic outline of what external-dns is and some goals/design decisions we should consider

iterion · 2017-02-13T15:29:21Z

docs/initial-design.md

+
+External DNS should be compatible with annotations used by three above mentioned projects. The idea is that resources created and tagged with annotations for other projects should continue to be valid and now managed by External DNS. 
+
+TODO:*Add complete list here*


route53-kubernetes functions pretty simply and only works with properly annotated services. The README has more info: https://github.com/wearemolecule/route53-kubernetes

If I were to put it into the example table as given for Mate it would look like this:
Tag: domainName
Description: Hostname to be registered
Default: None (no DNS record would be created)
Example: foo.example.org

But, we would also need to include that it currently only functions on services (no support for ingress) and that a label dns: route53 must also be set on the service for which the user intends to create a DNS record.

All that being said, I could see how we may not want to support the above rules. It might be easier to support running route53-kubernetes and this project simultaneously until a user can correctly port everything.

@iterion I see your point and it feels right in route53-kubernetes case. in mate's case we do not tag resources which can/cannot be managed by mate. Hence running mate + external-dns at the same time might be problematic.

Yeah, agree that backwards compatibility for mate makes sense. If we can safely run both route53-kubernetes and external-dns I think it would be a good idea not to support its annotations. It's just less surface area that we'd ultimately probably just deprecate later. I'll add a small section documenting this.

iterion · 2017-02-13T15:38:55Z

docs/initial-design.md

+
+User runs `kubectl create -f ingress.yaml`, this will create an ingress as normal.
+Typically the user would then have to manually create a DNS record pointing the ingress endpoint
+If the external-dns controller is running on the cluster, it could automatically configure the DNS records instead, by observing the host attribute in the ingress object.


Here we say we create records by observing the host attribute. I assume that means the host field specified here: https://kubernetes.io/docs/api-reference/v1.5/#ingressrule-v1beta1. But, later we specify an annotation to do the same (external-dns.kubernetes.io/hostname). Are both required?

In my point of view only ingress host is required. In this doc it is mentioned this annotation is only required for other types of resources (which is only loadbalancer service at the moment). But this is certainly open for discussion

Ah, I see, to check my understanding. If you're using ingress resources ingress host is required. But, if you are using services then you must specify both of the annotations?

Yes, the host is specified when ingress is created. For services both annotations are required per my understanding

To make this clear perhaps we should add a section under design, maybe something like:

### Configuration DNS records will be automatically created in multiple situations: 1. Setting `spec.rules.host` on an ingress object. 2. Specifying two annotations (`external-dns.kubernetes.io/controller` and `external-dns.kubernetes.io/hostname`) on a `type=LoadBalancer` service object.

@iterion yup, seems good to me. You can push to this branch, this PR is for us to agree on same design basis :) we can fix it any time later. anyways as time goes we will probably need to create separate file(s) for configuration/how to run/use-cases/annotations etc

Thanks, pushed.

hjacobs · 2017-02-13T17:38:40Z

docs/initial-design.md

+
+|   Annotations |   |
+|---|---|
+|Tag   |external-dns.kubernetes.io/controller   |


Can we make this the default (configurable)? I want users to have the least amount of annotations possible. There is no need for people to specify this annotation if only one controller is running in the cluster (which will be the case for 99% of the cases).

hjacobs · 2017-02-13T17:55:48Z

docs/initial-design.md

+
+DNS records will be automatically created in multiple situations:
+1. Setting `spec.rules.host` on an ingress object.
+2. Specifying two annotations (`external-dns.kubernetes.io/controller` and `external-dns.kubernetes.io/hostname`) on a `type=LoadBalancer` service object.


Same here: why are two annotations needed? I would assume external-dns.kubernetes.io/controller to be optional in 99% of the use cases.

Not necessary, I just grabbed it annotations section. It seems like external-dns.kubernetes.io/controller is optional since it has a default value. I'll correct this.

k8s-ci-robot · 2017-02-13T18:08:44Z

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://github.com/kubernetes/kubernetes/wiki/CLA-FAQ to sign the CLA.

Once you've signed, please reply here (e.g. "I signed it!") 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.

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.

hjacobs · 2017-02-13T18:09:55Z

docs/initial-design.md

@@ -74,6 +74,10 @@ TODO:*Add complete list here*
 |Default   | Empty(falls back to template based approach) |
 |Example|foo.example.org|

+**route53-kubernetes*


typo: missing star at the end of line

Fix formatting

iterion · 2017-02-13T18:27:12Z

I signed it!

Raffo · 2017-02-14T16:55:40Z

docs/initial-design.md

+
+## Goals
+
+1. Support AWS Route53 and Google Cloud DNS providers


Is Azure out of scope?

Sorry, it's listed below, pls ignore.

ideahitme · 2017-02-15T09:36:38Z

let's merge this for now and iterate on it later on. any objections ?

linki · 2017-02-15T15:16:25Z

👍

initial-design file

exoscale: fix boilerplate header

CIRE-152: Aws streamline

Incorporated review comments

Add .ci-operator.yaml with base_root_image

* chore: fix k8s-ci-robot license check on github * fix: More linter fixes * fix: linter issues * Merge from github external-dns into release (#4) * Allow multiple services to share same dns record * NS record support * Fix NS related provider test * update comment to explain edge case better * Add short tutorial on how to create NS record * bumps cloudbuild image Signed-off-by: GitHub <noreply@github.com> * pre-pulls images due to cloudbuilder bug * bump cloudbuild timeout for new release process Signed-off-by: GitHub <noreply@github.com> * aws-r53 adding Africa (Cape Town) ELB endpoints and hosted zone id's * cloudflare: readme update for RBAC config service account needs access to `watch` nodes. GKE and AWS R53, the two stable providers, have this permission * Update to Go 1.15 & update Azure dependencies * fix: linter issues (#3) * adds arm32v7 arch for images Signed-off-by: Raffaele Di Fazio <difazio.raffaele@gmail.com> * Add namespace for httpbin-gateway Signed-off-by: 杨阳 10014842 <yangyang1@zte.com.cn> * adds GOARM for arm32v7 images Signed-off-by: GitHub <noreply@github.com> * adds faq for multiarch images Signed-off-by: GitHub <noreply@github.com> * Fix OVH tutorial to match new permissions External DNS now require permissions on endpoints resource. Adding it in the OVH tutorial manifest following this comment (kubernetes-sigs#961 (comment)) for making it continue to work out of the box. Co-authored-by: Pavel Tumik <pavel.tumik@gmail.com> Co-authored-by: Yury Tsarev <yury.tsarev@absa.africa> Co-authored-by: Kubernetes Prow Robot <k8s-ci-robot@users.noreply.github.com> Co-authored-by: Raffaele Di Fazio <difazio.raffaele@gmail.com> Co-authored-by: Mic <mzingarelli@gmail.com> Co-authored-by: R. Aidan Campbell <raidancampbell@users.noreply.github.com> Co-authored-by: Jonas-Taha El Sesiy <github@elsesiy.com> Co-authored-by: 杨阳 10014842 <yangyang1@zte.com.cn> Co-authored-by: Victor Coutellier <victor.coutellier@gmail.com> * adding e2e test stage * fixing the yaml error * parameterize target branch * bump version * doc: Update Readme to add F5 DNS Load Balancer Cloud service Co-authored-by: Pavel Tumik <pavel.tumik@gmail.com> Co-authored-by: Yury Tsarev <yury.tsarev@absa.africa> Co-authored-by: Kubernetes Prow Robot <k8s-ci-robot@users.noreply.github.com> Co-authored-by: Raffaele Di Fazio <difazio.raffaele@gmail.com> Co-authored-by: Mic <mzingarelli@gmail.com> Co-authored-by: R. Aidan Campbell <raidancampbell@users.noreply.github.com> Co-authored-by: Jonas-Taha El Sesiy <github@elsesiy.com> Co-authored-by: 杨阳 10014842 <yangyang1@zte.com.cn> Co-authored-by: Victor Coutellier <victor.coutellier@gmail.com> Co-authored-by: Rajeev Panda <r.panda@f5.com>

initial-design file

dc16c78

ideahitme added the kind/support Categorizes issue or PR as a support question. label Feb 13, 2017

k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Feb 13, 2017

iterion reviewed Feb 13, 2017

View reviewed changes

fix broken table

b2306cc

iterion reviewed Feb 13, 2017

View reviewed changes

hjacobs added the do-not-merge DEPRECATED. Indicates that a PR should not merge. Label can only be manually applied/removed. label Feb 13, 2017

hjacobs reviewed Feb 13, 2017

View reviewed changes

Add Design/Configuration section

4a4b8c7

hjacobs reviewed Feb 13, 2017

View reviewed changes

Document compatibility with route53-kubernetes

49fb86d

k8s-ci-robot added cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. and removed cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Feb 13, 2017

hjacobs reviewed Feb 13, 2017

View reviewed changes

Tweak configuration section

30c04fb

Fix formatting

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 Feb 13, 2017

be more elaborate regarding required annotations, compatibility

d9825d7

Raffo reviewed Feb 14, 2017

View reviewed changes

ideahitme mentioned this pull request Feb 14, 2017

Document design: features and annotations #1

Closed

ideahitme merged commit 786055f into master Feb 15, 2017

ideahitme removed the do-not-merge DEPRECATED. Indicates that a PR should not merge. Label can only be manually applied/removed. label Feb 15, 2017

ideahitme deleted the docs/design branch February 24, 2017 16:55

ffledgling referenced this pull request in ffledgling/external-dns Jan 18, 2018

Merge pull request #4 from kubernetes-incubator/docs/design

9b890d1

initial-design file

njuettner pushed a commit that referenced this pull request Jul 13, 2018

Merge pull request #4 from greut/fix-header

826d874

exoscale: fix boilerplate header

fraenkel added a commit to fraenkel/external-dns that referenced this pull request Apr 12, 2019

Merge pull request kubernetes-sigs#4 from confluentinc/aws_streamline

5a1eabc

CIRE-152: Aws streamline

k8s-ci-robot pushed a commit that referenced this pull request Jul 30, 2020

Merge pull request #4 from aliasgharmhowwala/feature/ultradns_provider

49b4142

Incorporated review comments

Elbehery referenced this pull request in Elbehery/external-dns Oct 27, 2021

Merge pull request #4 from alebedev87/ci-operator

4cbbc22

Add .ci-operator.yaml with base_root_image

lou-lan pushed a commit to lou-lan/external-dns that referenced this pull request May 11, 2022

Flip Main Index Repo to official index (kubernetes-sigs#4)

639ba53

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

initial-design file #4

initial-design file #4

ideahitme commented Feb 13, 2017

iterion Feb 13, 2017

ideahitme Feb 13, 2017

iterion Feb 13, 2017

iterion Feb 13, 2017

ideahitme Feb 13, 2017

iterion Feb 13, 2017

ideahitme Feb 13, 2017 •

edited

iterion Feb 13, 2017

ideahitme Feb 13, 2017 •

edited

iterion Feb 13, 2017

hjacobs Feb 13, 2017

hjacobs Feb 13, 2017

iterion Feb 13, 2017

k8s-ci-robot commented Feb 13, 2017

hjacobs Feb 13, 2017

iterion commented Feb 13, 2017

Raffo Feb 14, 2017

Raffo Feb 14, 2017

ideahitme commented Feb 15, 2017

linki commented Feb 15, 2017


		External DNS should be compatible with annotations used by three above mentioned projects. The idea is that resources created and tagged with annotations for other projects should continue to be valid and now managed by External DNS.

		TODO:Add complete list here


		## Goals

		1. Support AWS Route53 and Google Cloud DNS providers

initial-design file #4

initial-design file #4

Conversation

ideahitme commented Feb 13, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ideahitme Feb 13, 2017 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ideahitme Feb 13, 2017 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

k8s-ci-robot commented Feb 13, 2017

Choose a reason for hiding this comment

iterion commented Feb 13, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ideahitme commented Feb 15, 2017

linki commented Feb 15, 2017

ideahitme Feb 13, 2017 •

edited

ideahitme Feb 13, 2017 •

edited