Skip to content

docs(sources): surface provider-specific annotations support in documentation#6231

Merged
k8s-ci-robot merged 15 commits intokubernetes-sigs:masterfrom
gofogo:feat-sources-support-provider-specific
Mar 19, 2026
Merged

docs(sources): surface provider-specific annotations support in documentation#6231
k8s-ci-robot merged 15 commits intokubernetes-sigs:masterfrom
gofogo:feat-sources-support-provider-specific

Conversation

@ivankatliarchuk
Copy link
Copy Markdown
Member

@ivankatliarchuk ivankatliarchuk commented Feb 27, 2026

What does it do ?

  • Added // +externaldns:source:provider-specific=true|false annotation to every source struct in source/, based on whether the source calls annotations.ProviderSpecificAnnotations
  • Extended the doc generator (internal/gen/docs/sources/main.go) with a new annotationProviderSpecific constant
  • Added tests to capture where provider specific annotations supported/not-supporte for ALL sources, that currently missing it

Follow-up

  • add support for provider specific annotations for sources that currently do not support it
  • TTL config in auto-docs

Motivation

Sources differ in whether they support provider-specific properties (e.g. AWS routing policies, Cloudflare proxying, SCW/webhook extensions). This distinction was implicit and invisible — there was no machine-readable way to know which sources honour provider-specific annotations without reading the source code. Surfacing this as a structured annotation makes it queryable by tooling and visible in the generated documentation, helping users understand which sources can carry provider-specific configuration to their DNS provider.

More

  • Yes, this PR title follows Conventional Commits
  • Yes, I added unit tests
  • Yes, I updated end user documentation accordingly

…urce documentation

Signed-off-by: ivan katliarchuk <ivan.katliarchuk@gmail.com>
…urce documentation

Signed-off-by: ivan katliarchuk <ivan.katliarchuk@gmail.com>
@k8s-ci-robot k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. docs labels Feb 27, 2026
@k8s-ci-robot k8s-ci-robot added internal Issues or PRs related to internal code cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. source labels Feb 27, 2026
@ivankatliarchuk ivankatliarchuk marked this pull request as draft February 27, 2026 12:36
@k8s-ci-robot k8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Feb 27, 2026
…urce documentation

Signed-off-by: ivan katliarchuk <ivan.katliarchuk@gmail.com>
@k8s-ci-robot k8s-ci-robot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Feb 27, 2026
@ivankatliarchuk ivankatliarchuk marked this pull request as ready for review February 27, 2026 13:06
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Feb 27, 2026
@k8s-ci-robot k8s-ci-robot requested a review from vflaux February 27, 2026 13:06
@ivankatliarchuk ivankatliarchuk changed the title docs(sources): surface provider-specific annotations support it in source documentation docs(sources): surface provider-specific annotations support in documentation Feb 27, 2026
@k8s-ci-robot k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Mar 12, 2026
…urce documentation

Signed-off-by: ivan katliarchuk <ivan.katliarchuk@gmail.com>
@k8s-ci-robot k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Mar 13, 2026
…urce documentation

Signed-off-by: ivan katliarchuk <ivan.katliarchuk@gmail.com>
@coveralls
Copy link
Copy Markdown

coveralls commented Mar 13, 2026

Pull Request Test Coverage Report for Build 23285862349

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • 316 unchanged lines in 22 files lost coverage.
  • Overall coverage increased (+0.01%) to 78.159%

Files with Coverage Reduction New Missed Lines %
fake.go 1 96.23%
empty.go 1 75.0%
connector.go 2 83.33%
pod.go 5 95.61%
node.go 6 90.4%
f5_virtualserver.go 8 79.79%
contour_httpproxy.go 8 84.33%
istio_gateway.go 8 88.55%
f5_transportserver.go 8 78.65%
openshift_route.go 9 83.59%
Totals Coverage Status
Change from base Build 23251413358: 0.01%
Covered Lines: 16465
Relevant Lines: 21066

💛 - Coveralls

@ivankatliarchuk
Copy link
Copy Markdown
Member Author

/test pull-external-dns-unit-test

@k8s-ci-robot k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Mar 16, 2026
@k8s-ci-robot k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Mar 16, 2026
…urce documentation

Signed-off-by: ivan katliarchuk <ivan.katliarchuk@gmail.com>
@k8s-ci-robot k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Mar 17, 2026
@k8s-ci-robot k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Mar 18, 2026
…entation

Signed-off-by: ivan katliarchuk <ivan.katliarchuk@gmail.com>
…entation

Signed-off-by: ivan katliarchuk <ivan.katliarchuk@gmail.com>
…entation

Signed-off-by: ivan katliarchuk <ivan.katliarchuk@gmail.com>
@mloiseleur
Copy link
Copy Markdown
Collaborator

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 19, 2026
@ivankatliarchuk
Copy link
Copy Markdown
Member Author

/approve

@k8s-ci-robot
Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: ivankatliarchuk

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

The pull request process is described here

Details 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

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Mar 19, 2026
@k8s-ci-robot k8s-ci-robot merged commit 083b6e9 into kubernetes-sigs:master Mar 19, 2026
18 checks passed
@ivankatliarchuk ivankatliarchuk deleted the feat-sources-support-provider-specific branch March 19, 2026 13:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. docs internal Issues or PRs related to internal code lgtm "Looks good to me", indicates that a PR is ready to be merged. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. source

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants