Skip to content

docs(contributor): GetDomainFilter contract and ZoneCache blueprint for provider contributors#6249

Open
ivankatliarchuk wants to merge 9 commits intokubernetes-sigs:masterfrom
gofogo:docs-contributing-GetDomainFilter
Open

docs(contributor): GetDomainFilter contract and ZoneCache blueprint for provider contributors#6249
ivankatliarchuk wants to merge 9 commits intokubernetes-sigs:masterfrom
gofogo:docs-contributing-GetDomainFilter

Conversation

@ivankatliarchuk
Copy link
Member

What does it do ?

  • Adds a GetDomainFilter section covering the controller integration, the static anti-pattern with a concrete example, the correct dynamic pattern with worked scenarios, zone name formatting pitfalls, and test requirements. Adds a Provider Blueprints section covering ZoneCache usage pattern and the single --zones-cache-duration flag.

  • Clarify ZoneCache godoc to cover non-obvious expiry and disabling behaviour

Motivation

  • Most provider implementations repeatedly made the same two mistakes: echoing config.DomainFilter back from GetDomainFilter() instead of querying live zones, and reimplementing zone caching from scratch instead of using the shared blueprint. Neither pattern was documented anywhere.

More

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

…or provider contributors

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 Mar 3, 2026
@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 mloiseleur for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found 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 provider Issues or PRs related to a provider cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Mar 3, 2026
@coveralls
Copy link

coveralls commented Mar 3, 2026

Pull Request Test Coverage Report for Build 22779821196

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 79.165%

Totals Coverage Status
Change from base Build 22540459008: 0.0%
Covered Lines: 16057
Relevant Lines: 20283

💛 - Coveralls

…or provider contributors

Signed-off-by: ivan katliarchuk <ivan.katliarchuk@gmail.com>
…or provider contributors

Signed-off-by: ivan katliarchuk <ivan.katliarchuk@gmail.com>
…or provider contributors

Signed-off-by: ivan katliarchuk <ivan.katliarchuk@gmail.com>
…or provider contributors

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

clwluvw commented Mar 3, 2026

@ivankatliarchuk - How should we handle the situation where we have authoritative zones for the provider, such as a.com and b.com, but the user provides a domain filter for c.com? If GetDomainFilter() returns an empty list, should we assume that c.com can be reconciled?

…or provider contributors

Signed-off-by: ivan katliarchuk <ivan.katliarchuk@gmail.com>
@ivankatliarchuk ivankatliarchuk force-pushed the docs-contributing-GetDomainFilter branch from 597d702 to f9e11fc Compare March 3, 2026 23:11
@ivankatliarchuk
Copy link
Member Author

@ivankatliarchuk - How should we handle the situation where we have authoritative zones for the provider, such as a.com and b.com, but the user provides a domain filter for c.com? If GetDomainFilter() returns an empty list, should we assume that c.com can be reconciled?

I answered it here #6234 (comment)

…or provider contributors

Signed-off-by: ivan katliarchuk <ivan.katliarchuk@gmail.com>
@ivankatliarchuk
Copy link
Member Author

Added to docs an example with, a,b and c domains.

…or provider contributors

Signed-off-by: ivan katliarchuk <ivan.katliarchuk@gmail.com>
…or provider contributors

Signed-off-by: ivan katliarchuk <ivan.katliarchuk@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. docs provider Issues or PRs related to a provider size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants