controller-gen crd generation does not work across modules layouts

[phantomjinx]

The operator-sdk documentation lays out an operator go project with api in the root directory. It also creates a Makefile with the rule make manifests defined as

$(CONTROLLER_GEN) $(CRD_OPTIONS) rbac:roleName=manager-role webhook paths="./..." output:crd:artifacts:config=config/crd/bases

so relying on controller-gen for generation of the operator CRDs.

While migrating an operator project to using this CRD generation, there exists an issue with apis that have been modularized, ie. api directory with their own mod.go file.

I've created a repository demonstrating the problem using the memcached-operator example.

• An api is generated with a version "v1" and given the kind "memcached";
• A 2nd api is generated with a version "v1alpha1" and given the kind "memcachedext";
• The 2nd api then uses a type from the v1 api hence placing a parent-child dependency on these apis.

For this to compile correctly, the v1 package had to be imported into the v1alpha1 api. This happened to require the api be modularized. Maybe, this is unnecessary for solving the import problem but is required anyway for making available the api as a module in its own right.

Issues:

• make manifests fails to generate any CRDs due to the controller-gen command;
• If the go.mod is removed then things do get generated and this seems to be a possible workaround. However, a further problem emerges due to v1alpha1 depending on v1 with the v1 CRD containing a duplicated schema, ie. 2 versions of schema v1.

[phantomjinx]

Update on duplicated schema
This appears to be intermittent and maybe dependent on there be a copy of the api directory, eg. in the camel-k project the api is located in pkg/apis so a workaround is to copy it to /api first. Consequently, every other execution of controller-gen seems to generate duplicate schema in the CRDs.
Cannot currently mirror this reliably in the example project other than to copy /api down to /pkg/apis and then execute controller-gen with paths=./.... In the camel-k project, duplication does occur even when setting paths=./api/....

[fejta-bot]

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-contributor-experience at kubernetes/community.
/lifecycle stale

[fejta-bot]

Stale issues rot after 30d of inactivity.
Mark the issue as fresh with /remove-lifecycle rotten.
Rotten issues close after an additional 30d of inactivity.

If this issue is safe to close now please do so with /close.

Send feedback to sig-contributor-experience at kubernetes/community.
/lifecycle rotten

[fejta-bot]

Rotten issues close after 30d of inactivity.
Reopen the issue with /reopen.
Mark the issue as fresh with /remove-lifecycle rotten.

Send feedback to sig-contributor-experience at kubernetes/community.
/close

[k8s-ci-robot]

@fejta-bot: Closing this issue.

In response to this:

Rotten issues close after 30d of inactivity.
Reopen the issue with /reopen.
Mark the issue as fresh with /remove-lifecycle rotten.

Send feedback to sig-contributor-experience at kubernetes/community.
/close

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.

[akutz]

I am currently bit by this as well. Has anyone encountered a solution in the wild?

[akutz]

I found a work-around, but it has its own issues.

[akutz]

I filed a PR to fix this issue -- #663.

[alvaroaleman]

/assign akutz

[akutz]

This has been fixed with #663.