Skip to content

Define union features - #4452

Merged
k8s-ci-robot merged 2 commits into
kubernetes-sigs:mainfrom
rikatz:feature-union-devguide
Apr 6, 2026
Merged

k8s-ci-robot merged 2 commits into
kubernetes-sigs:mainfrom
rikatz:feature-union-devguide

Conversation

@rikatz

@rikatz rikatz commented Jan 23, 2026

Copy link
Copy Markdown
Member

What type of PR is this?
/kind documentation
/kind feature

What this PR does / why we need it:
Defines the concept of Union feature and how it applies to features like BackendTLSPolicy

Which issue(s) this PR fixes:
Fixes #

Does this PR introduce a user-facing change?:

NONE

@k8s-ci-robot k8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. kind/documentation Categorizes issue or PR as related to documentation. kind/feature Categorizes issue or PR as related to a new feature. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Jan 23, 2026
@k8s-ci-robot

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: rikatz

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 approved Indicates a PR has been approved by an approver from all required OWNERS files. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Jan 23, 2026
Comment thread site-src/guides/implementers.md Outdated
Comment on lines +122 to +123
TODO: Maybe mention that ReferenceGrant is the same case.
TODO: Define how this applies with conformance profiles.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the other unanswered question here is: as an implementor or user, how do you know? Right now, I think the only way is to run the conformance tests and see something fail.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

right, I wanted to initially write the conformance tests for these cases as well. But in case we miss some conformance, this would never be "clear".

I was wondering if a feature or a profile that signals a union feature would be enough to be a commitment from the implementation of doing it, and for users to knowing the desired behavior

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if it's worth trying to do some sort of description of the combinations. 🤔 All of the options here seem less than ideal – the conformance tests may be the best option we have, but I'd be happier having something (maybe pulled out of the conformance tests?) talking about the combinations needed... 🤔

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was wondering if this should be a new flag on conformance that an implementation would opt-out (or some meta-feature)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It might be nice if we could surface these unions up through docs similar to how we populate the Experimental tag like https://gateway-api.sigs.k8s.io/reference/spec/#httpexternalauthfilter

So you could see resources that BackendTLSPolicy is expected to interop with in its docs for example.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hum, yeah, maybe as a followup I agree, but I wouldn't block this effort right now just on it.

Maybe open an issue for it Mike, and we can work on it. Doing these stuff on API Reference Doc is "slightly" boring so we will need to generate a new tag for something like //+unionFeature: BackendTLSPolicy and make the crd-ref-docs binary understand and parse it. not impossible, but not straightforward

Comment thread site-src/guides/implementers.md Resolved
Comment thread site-src/guides/implementers.md Resolved
@kflynn

kflynn commented Jan 26, 2026

Copy link
Copy Markdown
Contributor

@rikatz, in the interests of the next release – maybe update this doc with the combinations you're currently concerned about? Then we can land the doc update and decouple the conformance tests.

@robscott

Copy link
Copy Markdown
Member

/cc

@k8s-ci-robot
k8s-ci-robot requested a review from robscott January 27, 2026 16:40
@rikatz

rikatz commented Jan 27, 2026

Copy link
Copy Markdown
Member Author

/cc @mikemorris @guicassolato

@youngnick

Copy link
Copy Markdown
Contributor

I think that there's probably some optimization we can do about how we talk about features in general, but I also think that something like this is important right now, so this should go ahead, and we can clean up the larger picture later.

So,

/lgtm
/hold for further review.

@k8s-ci-robot k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jan 29, 2026
@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jan 29, 2026
@rikatz
rikatz force-pushed the feature-union-devguide branch from 9905111 to 2ccfdbf Compare April 6, 2026 17:59
@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed lgtm "Looks good to me", indicates that a PR is ready to be merged. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Apr 6, 2026
@robscott

robscott commented Apr 6, 2026

Copy link
Copy Markdown
Member

Thanks @rikatz!

/lgtm
/hold cancel

@k8s-ci-robot k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Apr 6, 2026
@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Apr 6, 2026
@k8s-ci-robot
k8s-ci-robot merged commit ace5815 into kubernetes-sigs:main Apr 6, 2026
20 checks passed
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. kind/documentation Categorizes issue or PR as related to documentation. kind/feature Categorizes issue or PR as related to a new feature. lgtm "Looks good to me", indicates that a PR is ready to be merged. release-note-none Denotes a PR that doesn't merit a release note. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants