✨ feat(schema): Add marker to skip fields

[MisterMX]

This adds a new field marker +kubebuilder:skip that allows explicitly ignoring properties during schema generation but keeping them in the Go struct for JSON marshalling at the same time.

[linux-foundation-easycla]

The committers listed above are authorized under a signed CLA.

• ✅ login: MisterMX (58b950e)

[k8s-ci-robot]

Welcome @MisterMX!

It looks like this is your first PR to kubernetes-sigs/controller-tools 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/controller-tools has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

[k8s-ci-robot]

Hi @MisterMX. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

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.

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: MisterMX
Once this PR has been reviewed and has the lgtm label, please assign alvaroaleman for approval. For more information see the Kubernetes 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

[JoelSpeed]

Hey @MisterMX, can you explain more about the use case here? I'm curious in which scenario would you want to have a field in the type but not generated within the schema?

[MisterMX]

We are using a wrapper around cmd/controller-gen to generate XRDs for https://github.com/crossplane/crossplane which are basically CRDs with additional flavoured properties. We ran into a problem where we want these additional properties to appear in the struct (so they can be unmarshalled) but not in the schema (because the definitions are added by Crossplane).

The easiest way for us to solve this issue is by having kubebuilder ignore the respective properties and not include them in the schema.

[JoelSpeed]

Can you provide a concrete example to where this is used? When you say the definitions are added by crossplane, does that mean that the fields are populated by crossplane on admission? I don't really understand where you're going here. Are the values ever returned and represented to the end user?

[k8s-triage-robot]

The Kubernetes project currently lacks enough contributors to adequately respond to all PRs.

This bot triages PRs according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

• Mark this PR as fresh with /remove-lifecycle stale
• Close this PR with /close
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale