docs: add custom image extractor example for ImageValidatingPolicy#1993
docs: add custom image extractor example for ImageValidatingPolicy#1993Pittu-Sharma wants to merge 8 commits into
Conversation
Signed-off-by: pittu sharma <pittusharma47@gmail.com>
|
Hi @JimBugwadia, I have completed the documentation for issue #1915. I've added a functional example for the custom image extractor (spec.images) and also took the opportunity to expand the existing YAML snippets in the file into logically complete policies to improve the documentation's utility. I have verified the changes locally using npm run dev and ensured the build and link checks pass. Please let me know if any further refinements are needed. Thanks! |
Moved the 'Mutate Existing Resources' content from mutate.md into a dedicated page (mutate-existing.md) to improve discoverability and allow for deeper coverage of the topic. The new page expands on the original content with additional sections covering how triggers work, target selection methods, the permissions requirement for the background controller, policy update behavior, and a troubleshooting section with UpdateRequest examples. A brief summary and link to the new page has been added to mutate.md to preserve navigation continuity. The new page is also added to the sidebar in astro.config.mjs under the ClusterPolicy section. Closes kyverno#1296 Signed-off-by: Pittu Sharma <pittusharma47@gmail.com>
…isting Signed-off-by: Pittu Sharma <pittusharma47@gmail.com>
|
Hey @Pittu-Sharma , I noticed this PR includes several changes outside the documentation scope:
Could we split the programmatic/config/dependency changes into a separate PR and keep this one focused on the .mdx documentation updates? |
|
could we add a small sample custom resource object near the example to show what |
Signed-off-by: pittu sharma <pittusharma47@gmail.com>
6c968f9 to
c3ebd28
Compare
|
Hi @Suhani95, Thank you for the review and the suggestions! I've updated the PR to address both of your points:
Please let me know if anything else needs adjusting! |
Related issue
Fixes #1915
Proposed Changes
This PR addresses the documentation gap identified in issue #1915 by adding a comprehensive and functional example of an
ImageValidatingPolicythat utilizes the custom image extractor field (spec.images).Key changes:
ImageValidatingPolicydocumentation.example.io/v1/myresources) and perform subsequent signature verification.# ...patches) to improve documentation quality and ensure examples are copy-paste ready.Checklist
git commit -s).