docs(proposal): externaldns api graduation to beta #5079

ivankatliarchuk · 2025-02-09T19:11:29Z

Description

Relates, but not resolves #2941

The proposal to merge to master 2025-Mar-09 with the decision

Checklist

Unit tests updated
End user documentation updated

Signed-off-by: ivan katliarchuk <[email protected]>

k8s-ci-robot · 2025-02-09T19:11:34Z

[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 mloiseleur for approval. For more information see the 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

Signed-off-by: ivan katliarchuk <[email protected]>

ivankatliarchuk · 2025-02-09T20:54:08Z

/label tide/merge-method-squash

szuecs · 2025-02-18T17:29:56Z

docs/proposal/dnsendpoint-graduation-to-beta.md

+1. Refactor `endpoint` folder, move away `api/crd` related stuff to `apis/<apiVersion> folder`
+2. Documentation for API to be generated automatically with test coverage, similar to `docs/flags.md`
+3. API(s) and CRD(s) discoverable. [doc.crds.dev](https://doc.crds.dev/github.com/kubernetes-sigs/external-dns). Example [crosplane](https://doc.crds.dev/github.com/crossplane/[email protected])
+4. TBD


I would add: review and change .status object such that people can debug and monitor DNSEndpoint object behavior.

Agree. Will add that one too. There is a status field issue #2092. It's actually recommended to have it

szuecs · 2025-02-18T17:30:33Z

docs/proposal/dnsendpoint-graduation-to-beta.md

+2. Documentation for API to be generated automatically with test coverage, similar to `docs/flags.md`
+3. API(s) and CRD(s) discoverable. [doc.crds.dev](https://doc.crds.dev/github.com/kubernetes-sigs/external-dns). Example [crosplane](https://doc.crds.dev/github.com/crossplane/[email protected])
+4. TBD
+5. TBD


add: introduce a metric for objects and errors if not already available (review if this is available)

Good point. Trying to understand what are the metrics currently available to us.

Raffo

I like the proposal to graduate DNSEndpoint. I would encourage to try to understand the status of the API today, its limits and the required changes before drawing any conclusion on what needs to be changed. I think we need to do this before the beta graduation as ideally the beta to GA transition should be mostly a noop. I am not too up to speed on how this is used, maybe we can open an issue to survey users or trying a github search and see if people are using it in public repositories.

Raffo · 2025-02-19T20:58:12Z

docs/proposal/dnsendpoint-graduation-to-beta.md

+title: "Proposal: API DNSEndpoint graduation to beta"
+version: tbd
+authors: ivankatliarchuk
+creation-date: 2025-feb-9


Nit: let's fix this date too?

Do you prefer dates to be in certain format, no jan|feb|march ? Or what exactly?

I'd go for ISO 8601: YYYY-MM-DD

Updated in separate pull request #5128

ivankatliarchuk · 2025-02-21T11:40:14Z

I like the proposal to graduate DNSEndpoint. I would encourage to try to understand the status of the API today, its limits and the required changes before drawing any conclusion on what needs to be changed. I think we need to do this before the beta graduation as ideally the beta to GA transition should be mostly a noop. I am not too up to speed on how this is used, maybe we can open an issue to survey users or trying a github search and see if people are using it in public repositories.

That make sense. Shell I rename the proposal?

external-dns/docs/proposal/dnsendpoint-graduation-to-beta.md

Lines 21 to 28 in 9bd5f73

    
           ### Goals 
        
           - Define the necessary requirements for `DNSEndpoint` API to reach beta status. 
        
           - Improve API stability, usability, and documentation. 
        
           - Improve test coverage, automate documentation creation, and validation mechanisms. 
        
           - Ensure backward compatibility and migration strategies from alpha to beta. 
        
           - Collect and incorporate feedback from existing users to refine the API. 
        
           - Address any identified issues or limitations in the current API design.

### Goals

- Define the necessary requirements for `DNSEndpoint` API to reach beta status.
- Improve API stability, usability, and documentation.
- Improve test coverage, automate documentation creation, and validation mechanisms.
- Ensure backward compatibility and migration strategies from alpha to beta.
- Collect and incorporate feedback from existing users to refine the API.
- Address any identified issues or limitations in the current API design.

### Non-Goals

- This proposal does not cover the graduation of ExternalDNS itself to a stable release.
- Making `DNSEndpoint` a stable (GA) API at this stage.
- It does not include implementation details for specific DNS providers.
- It does not introduce new functionality beyond stabilizing the DNSEndpoint API.
- Redesigning the API from scratch.
- Introducing breaking changes that would require significant refactoring for existing users.

Goals are mainly review, and implement pre-requisits before we decide on actuall migration. Expectation is, when all the goals that we define completed, I have not planned the future to be honest.

Raffo · 2025-02-25T11:18:25Z

@ivankatliarchuk that's good, maybe we can add a bit more Information on how do we expect to gather feedback so that we can make this more actionable?

Raffo · 2025-02-25T11:18:30Z

@ivankatliarchuk that's good, maybe we can add a bit more Information on how do we expect to gather feedback so that we can make this more actionable?

Signed-off-by: ivan katliarchuk <[email protected]>

* master: (80 commits) chore(deps): bump the dev-dependencies group across 1 directory with 7 updates Update README.md with proper link to dev guide Add OpenStack Designate webook provider to readme chore(deps): bump the dev-dependencies group with 3 updates chore(deps): bump the dev-dependencies group with 20 updates chore(deps): bump azure/setup-helm in the dev-dependencies group style: formatting fix: remove broken test fix test name chore: upgrade ExternalDNS to go 1.24 chore-makefile-coverage cover source.go getProviderSpecificAnnotations() with unit tests nitpick: rename cloudflare custom hostname test function review suggestions based improvements review suggestions fix(source): debug log on gateway target detection improve error message phrasing Update docs/sources/service.md chore(formatting): fix infected files with correct formatting (kubernetes-sigs#5099) docs: Fix managed-record-type argument ...

Signed-off-by: ivan katliarchuk <[email protected]>

ivankatliarchuk · 2025-02-26T08:26:22Z

@ivankatliarchuk that's good, maybe we can add a bit more Information on how do we expect to gather feedback so that we can make this more actionable?

Added to proposal

1. Capture feedback from the community on missing functionality for DNSEndpoint CRD
   - In a form of Github issue, pin the issue to the project
   - Link all CRD related issues to it

ivankatliarchuk · 2025-02-26T08:44:12Z

/open

ivankatliarchuk · 2025-02-26T08:45:46Z

/reopen

k8s-ci-robot · 2025-02-26T08:45:51Z

@ivankatliarchuk: Reopened this PR.

In response to this:

/reopen

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.

Signed-off-by: ivan katliarchuk <[email protected]>

docs(proposal): externaldns api graduation to beta

e0f9239

Signed-off-by: ivan katliarchuk <[email protected]>

k8s-ci-robot requested review from mloiseleur and szuecs February 9, 2025 19:11

k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Feb 9, 2025

docs(proposal): externaldns api graduation to beta

9bd5f73

Signed-off-by: ivan katliarchuk <[email protected]>

k8s-ci-robot added the tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges. label Feb 9, 2025

This was referenced Feb 16, 2025

"--crd-source-kind" flag doesn't work as intended #2308

Open

DNSEndpoint definition ignored when annotation-filter is set. #3634

Open

Use DNSEndpoint for all records #4859

Open

CRD Source Status field is lacking #2092

Open

k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Feb 17, 2025

szuecs reviewed Feb 18, 2025

View reviewed changes

Raffo reviewed Feb 20, 2025

View reviewed changes

ivankatliarchuk requested a review from Raffo February 21, 2025 17:04

ivankatliarchuk mentioned this pull request Feb 23, 2025

chore(docs): generate docs/monitoring/metrics.md file #5117

Merged

2 tasks

ivankatliarchuk mentioned this pull request Feb 26, 2025

docs(proposal): standartise date format #5128

Merged

2 tasks

docs(proposal): externaldns api graduation to beta

52a556d

Signed-off-by: ivan katliarchuk <[email protected]>

k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Feb 26, 2025

ivankatliarchuk added 3 commits February 26, 2025 08:24

docs(proposal): externaldns api graduation to beta

4a6530f

Signed-off-by: ivan katliarchuk <[email protected]>

docs(proposal): externaldns api graduation to beta

ea5cb4f

Signed-off-by: ivan katliarchuk <[email protected]>

k8s-ci-robot closed this in #5128 Feb 26, 2025

k8s-ci-robot reopened this Feb 26, 2025

docs(proposal): externaldns api graduation to beta

74d7f93

Signed-off-by: ivan katliarchuk <[email protected]>

ivankatliarchuk requested a review from szuecs February 26, 2025 09:08

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs(proposal): externaldns api graduation to beta #5079

docs(proposal): externaldns api graduation to beta #5079

ivankatliarchuk commented Feb 9, 2025 •

edited

Loading

k8s-ci-robot commented Feb 9, 2025

ivankatliarchuk commented Feb 9, 2025

szuecs Feb 18, 2025

ivankatliarchuk Feb 21, 2025

ivankatliarchuk Feb 26, 2025

szuecs Feb 18, 2025 •

edited

Loading

ivankatliarchuk Feb 21, 2025

ivankatliarchuk Feb 26, 2025

Raffo left a comment

Raffo Feb 19, 2025

ivankatliarchuk Feb 21, 2025 •

edited

Loading

Raffo Feb 25, 2025

ivankatliarchuk Feb 26, 2025

ivankatliarchuk commented Feb 21, 2025 •

edited

Loading

Raffo commented Feb 25, 2025

Raffo commented Feb 25, 2025

ivankatliarchuk commented Feb 26, 2025

ivankatliarchuk commented Feb 26, 2025

ivankatliarchuk commented Feb 26, 2025

k8s-ci-robot commented Feb 26, 2025

docs(proposal): externaldns api graduation to beta #5079

Are you sure you want to change the base?

docs(proposal): externaldns api graduation to beta #5079

Conversation

ivankatliarchuk commented Feb 9, 2025 • edited Loading

k8s-ci-robot commented Feb 9, 2025

ivankatliarchuk commented Feb 9, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

szuecs Feb 18, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Raffo left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ivankatliarchuk Feb 21, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ivankatliarchuk commented Feb 21, 2025 • edited Loading

Raffo commented Feb 25, 2025

Raffo commented Feb 25, 2025

ivankatliarchuk commented Feb 26, 2025

ivankatliarchuk commented Feb 26, 2025

ivankatliarchuk commented Feb 26, 2025

k8s-ci-robot commented Feb 26, 2025

ivankatliarchuk commented Feb 9, 2025 •

edited

Loading

szuecs Feb 18, 2025 •

edited

Loading

ivankatliarchuk Feb 21, 2025 •

edited

Loading

ivankatliarchuk commented Feb 21, 2025 •

edited

Loading