feat(registry): new CRD option

[mloiseleur]

Description

This is a follow up of #4598, updated with DNSRecord name and rebased on current master code.

This PR is not yet ready, it needs:

1. extensive testing first. FTM, it can only be used in-cluster.
2. usage documentation

The use of an other Kubeconfig will be for an other PR. Same for chart integration, with required new RBAC.

Fixes #4575

Checklist

• Unit tests updated
• End user documentation updated

[k8s-ci-robot]

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

[ivankatliarchuk]

Any chance we keep all API versions in folders apis/v1alpha?

Example https://github.com/gofogo/k8s-sigs-external-dns-fork/pull/15/files. This PR is in my repo still, it is working, but I have too many PR currently open ;-)

And API GW https://github.com/kubernetes-sigs/gateway-api/tree/main/apis.

The convention is for Custom Resources to keep them under structure apis/v1 apis/v1alpha and etc. This will pay off with versioning in future

[mloiseleur]

Any chance we keep all API versions in folders apis/v1alpha?

I was thinking of doing something like that. That make sense to me 👍 .

[k8s-ci-robot]

[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

[stevehipwell]

The CRDs for the Helm chart should be in separate files and be formatted as described in #5479. The following command would be my suggestion to handle multiple CRDs being generated.

${CONTROLLER_GEN} object crd:crdVersions=v1 paths="./apis/..." output:crd:stdout | yamlfmt - | yq eval '.metadata.annotations |= with_entries(select(.key | test("kubernetes\.io")))' --split-exp '"./charts/external-dns/crds/" + .metadata.name + ".yaml"'

[stevehipwell]

This should be fixed with a rebase.

[k8s-ci-robot]

PR needs rebase.

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.

[ivankatliarchuk]

It probably makes sense to slice this PR into smaller parts. There's no major issue if code is added but not immediately functional. For instance, we could safely introduce code from apid/v1alpha1 without yet generating any YAML files. This approach might significantly speed up the implementation of this extremely cool feature!

[ivankatliarchuk]

could we have something like

registry.NewCRDRegistry(p, WithKubeConfig(), WithApiServerUrl(), With...)

Easier to support and extend, alternative registry.NewCRDRegistry(p, cfg), and manage requried fields within the registry. Not a great, as there is coupling but still

[ivankatliarchuk]

Something like

type RegistryOptions struct {
    Provider            provider.Provider
    KubeConfig          string
    APIServerURL        string
    CRDSourceAPIVersion string
    Namespace           string
    TXTOwnerID          string
    RequestTimeout      time.Duration
    TXTCacheInterval    time.Duration
    // Add new fields here as needed
}

func NewRegistry(opts RegistryOptions) (Registry, error) {
    // use opts.Provider, opts.KubeConfig, etc.
}

[ivankatliarchuk]

opton example

type RegistryOption func(*Registry)

func WithKubeConfig(cfg string) RegistryOption { ... }

func NewRegistry(provider provider.Provider, opts ...RegistryOption) (Registry, error) {
    reg := &Registry{Provider: provider}
    for _, opt := range opts {
        opt(reg)
    }
    // ...
}

[ivankatliarchuk]

I could add this in another PR, so you just rebase or implement as part of this change and I make changes in other registries