Repository navigation
NO-JIRA: Document CEL over webhooks policy for AI agents #8478
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
openshift-merge-bot
merged 2 commits into
openshift:main
from
bryan-cox:update-agents-on-webhook
May 11, 2026
Merged
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| --- | ||
| paths: | ||
| - "hypershift-operator/controllers/hostedcluster/hostedcluster_webhook*.go" | ||
| --- | ||
|
|
||
| # Do Not Extend the Webhook | ||
|
|
||
| The webhook in `hostedcluster_webhook.go` is **not a general-purpose extension point**. Do not add new validation or defaulting logic here. | ||
|
|
||
| HyperShift uses CRD CEL validation rules instead of webhooks. The webhook exists only for KubeVirt platform-specific needs (defaulting and JSON patch annotation validation). | ||
|
|
||
| ## Why | ||
|
|
||
| Webhooks add latency and operational complexity that CEL avoids: | ||
|
|
||
| - **Konnectivity overhead.** In hosted-on-hosted topologies (e.g., IBM Cloud, where management clusters are themselves hosted clusters), a webhook request travels: apiserver → konnectivity server → konnectivity agent → node → webhook service (possibly on a different node). This adds significant per-request latency to every API write. | ||
| - **Availability coupling.** A down or slow webhook blocks all writes to the resource. CEL runs inside the API server with no external dependency. | ||
| - **Operational overhead.** Webhooks require TLS certificate management, webhook configurations, and a running service. | ||
|
|
||
| ## What to Do Instead | ||
|
|
||
| Add new validation as CEL markers on the API types in `api/hypershift/v1beta1/` and cover them with envtests. See `api/AGENTS.md` and `test/envtest/README.md`. | ||
|
|
||
| The exception is CAPI resources, where webhooks are used unconditionally during the v1beta2 migration period. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. it's only the conversion webhook that is required for CAPI
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Good catch — updated to "a conversion webhook is required" in 7339dfe. |
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: this is valid for api/ not only api/hypershift/v1beta1