docs: clarify that variables are not allowed in imageReferences field #1472
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
Signed-off-by: kushal9897 <[email protected]>
|
Thanks for opening your first Pull Request here! Please check out our Contributing guidelines and confirm that you Signed off. |
realshuting
reviewed
Feb 10, 2025
Signed-off-by: kushal9897 <[email protected]>
realshuting
requested changes
Feb 12, 2025
| ``` | ||
| This will result in a validation error because variables are **not allowed** in `imageReferences`. | ||
|
|
||
| #### ** Correct Usage (Using Static Values – Allowed)** |
Comment on lines
+78
to
+79
| - `preconditions.all` | ||
| - `preconditions.any` |
There was a problem hiding this comment.
Needs to double-check preconditions.
There was a problem hiding this comment.
preconditions supports variables, have you not been able to verify it?
Comment on lines
81
to
105
| #### ** Incorrect Usage (Using Variables – Not Allowed)** | ||
| ```yaml | ||
| rules: | ||
| - name: restrict-deployment-kinds | ||
| match: | ||
| resources: | ||
| kinds: | ||
| - "{{ request.object.kind }}" | ||
| ``` | ||
| **Why is this incorrect?** | ||
| - `match.resources.kinds` must contain **static** resource kinds (e.g., `Pod`, `Deployment`). | ||
| - Dynamic interpolation using `{{ request.object.kind }}` is **not supported**. | ||
|
|
||
| #### ** Correct Usage (Using Static Values – Allowed)** | ||
| ```yaml | ||
| rules: | ||
| - name: restrict-deployment-kinds | ||
| match: | ||
| resources: | ||
| kinds: | ||
| - Deployment | ||
| - StatefulSet | ||
| ``` | ||
| **Why is this correct?** | ||
| - Only predefined, static resource kinds (`Deployment`, `StatefulSet`) are used. |
There was a problem hiding this comment.
Suggested change
| #### ** Incorrect Usage (Using Variables – Not Allowed)** | |
| ```yaml | |
| rules: | |
| - name: restrict-deployment-kinds | |
| match: | |
| resources: | |
| kinds: | |
| - "{{ request.object.kind }}" | |
| ``` | |
| **Why is this incorrect?** | |
| - `match.resources.kinds` must contain **static** resource kinds (e.g., `Pod`, `Deployment`). | |
| - Dynamic interpolation using `{{ request.object.kind }}` is **not supported**. | |
| #### ** Correct Usage (Using Static Values – Allowed)** | |
| ```yaml | |
| rules: | |
| - name: restrict-deployment-kinds | |
| match: | |
| resources: | |
| kinds: | |
| - Deployment | |
| - StatefulSet | |
| ``` | |
| **Why is this correct?** | |
| - Only predefined, static resource kinds (`Deployment`, `StatefulSet`) are used. |
| #### **Incorrect Usage** | ||
| ```yaml | ||
| verifyImages: | ||
| - imageReferences: ["{{ parse_yaml(allowedregistryprefixes.data.allowedregistryprefixes) }}"] |
…ield Signed-off-by: kushal9897 <[email protected]>
realshuting
requested changes
Feb 18, 2025
Comment on lines
+78
to
+79
| - `preconditions.all` | ||
| - `preconditions.any` |
There was a problem hiding this comment.
preconditions supports variables, have you not been able to verify it?
|
I checked all the preconditions. I will share the logs or attach them with the document. |
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.
Related issue
#1462
Proposed Changes
This PR updates the Verify Images documentation to explicitly state that
variables (
{{ }}syntax) are not allowed in theimageReferencesfield.Checklist