KEP-5073: Declarative Validation: Explain subresources #5244
+72
−14
Conversation
This file contains 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
k8s-ci-robot
added
cncf-cla: yes
k8s-ci-robot
added
the
sig/api-machinery
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: jpbetz The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
k8s-ci-robot
added
approved
jpbetz
force-pushed
the
dv-subresources
branch
2 times, most recently
from
89be28f to
b2348a4
Compare
yongruilin
reviewed
Apr 16, 2025
|
|
||
| ``` | ||
| * They operate on the same underlying storage object as the primary resource (i.e., same `kind`, same object in etcd). | ||
| * Updates via these subresources are typically scoped to specific fields within the object. Changes to field values not in scope are tyipcally reset, or "wiped", before validation. |
There was a problem hiding this comment.
Suggested change
| * Updates via these subresources are typically scoped to specific fields within the object. Changes to field values not in scope are tyipcally reset, or "wiped", before validation. | |
| * Updates via these subresources are typically scoped to specific fields within the object. Changes to field values not in scope are typically reset, or "wiped", before validation. |
| **Support required:** | ||
|
|
||
| * Declarative validation will need to provide a easy way for a storage layer to map the internal type of a subresource to the | ||
| requested versioned type of that resource. For primary resoruce validation, the information is present in the requestInfo of |
There was a problem hiding this comment.
Suggested change
| requested versioned type of that resource. For primary resoruce validation, the information is present in the requestInfo of | |
| requested versioned type of that resource. For primary resource validation, the information is present in the requestInfo of |
| 1. **Field Wiping (Pre-Validation):** Declarative Validation *does not* scope which fields a subresource operation can write. Instead, this responsibility lies with the resource's strategy implementation. The strategy modifies the incoming object *before* validation, "wiping" or resetting any fields the specific subresource operation is not allowed to change. Once wiped, the ratcheting mechanism (below) will skip validation of these fields, since wiping ensures that they are unchanged. | ||
| 2. **Full Resource Validation:** The *entire*, modified resource object is validated against the primary resource's versioned type. That is, *same* set of declarative validation rules applied to the primary resource and to status-type subresources. | ||
| 3. **Conditional Validation:** Validation rules can use a special `subresource` parameter (e.g., `subresource == '/status'`) to apply conditional logic. This allows rules to behave differently depending on whether the update comes via the primary resource or a specific subresource. | ||
| 4. **Ratcheting:** Declarative Validation uses ratcheting, meaning it skips validation checks on fields that have not changed from the existing stored object. Combined with field wiping, this scopes validation to only the subset of fields that the subresource operation is intended and permitted to modify. |
There was a problem hiding this comment.
Should we state it as "ignore the validation error if the field unchanged"? Because we haven't decided whether to skip validating when unchanged or validate then ignore the error if fields unchanged.
"The errors from the unchanged fields would be ignored" seems more accurate?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This addresses how we intend to handle subresources with Declarative Validation.
A separate PR will update the ratcheting section to address the need to skip unchanged fields when validating.