Skip to content

docs: finalize Kyverno 1.18 GA documentation and consolidate mutateExisting#2023

Open
Pittu-Sharma wants to merge 5 commits into
kyverno:mainfrom
Pittu-Sharma:main
Open

docs: finalize Kyverno 1.18 GA documentation and consolidate mutateExisting#2023
Pittu-Sharma wants to merge 5 commits into
kyverno:mainfrom
Pittu-Sharma:main

Conversation

@Pittu-Sharma
Copy link
Copy Markdown
Contributor

Related issue

Resolves #1834
Closes #1296

Proposed Changes

This PR finalizes the Kyverno policy documentation for the 1.18 GA release by normalizing API versions, cleaning up technical "noise," and consolidating modern mutation features.

Key changes include:

  • API Normalization: Updated MutatingPolicy, ValidatingPolicy, and ImageValidatingPolicy to the stable v1 API version across all documentation and examples.
  • Mutate Existing Consolidation: Moved the "Mutate Existing Resources" section into the dedicated MutatingPolicy page (CEL-based) to provide a unified view of modern mutation capabilities and improved discoverability.
  • CLI 1.18 Support: Added documentation for the new Kyverno CLI 1.18 support, which allows for local testing of mutateExisting rules within MutatingPolicy resources.
  • GitOps Integration: Integrated specific "GitOps Considerations" (for Flux and Argo CD) directly into the mutation documentation to reduce the need for cross-referencing legacy ClusterPolicy pages.
  • Logically Complete Content: Conducted a deep audit to remove all placeholder comments (e.g., # ...) and fragments, ensuring every example is a valid, self-contained Kubernetes object.

Checklist

  • I have read the contributing guidelines.
  • I have inspected the website preview for accuracy.
  • I have signed off my issue.

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label May 16, 2026
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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

config documentation Improvements or additions to documentation webhook

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update MutatingPolicy [Enhancement] Better all around docs for mutate existing

2 participants